Package com.azure.search.documents.indexes.models

Class ChatCompletionExtraParametersBehavior

java.lang.Object

com.azure.core.util.ExpandableStringEnum<ChatCompletionExtraParametersBehavior>

com.azure.search.documents.indexes.models.ChatCompletionExtraParametersBehavior

All Implemented Interfaces:

com.azure.core.util.ExpandableEnum<String>

public final class ChatCompletionExtraParametersBehavior
extends com.azure.core.util.ExpandableStringEnum<ChatCompletionExtraParametersBehavior>

Specifies how 'extraParameters' should be handled by Azure AI Foundry. Defaults to 'error'.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatCompletionExtraParametersBehavior	DROP	Drops all extra parameters.
static final ChatCompletionExtraParametersBehavior	ERROR	Raises an error if any extra parameter is present.
static final ChatCompletionExtraParametersBehavior	PASS_THROUGH	Passes any extra parameters directly to the model.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionExtraParametersBehavior()	Deprecated. Use the fromString(String) factory method.

Method Summary

Modifier and Type	Method	Description
static ChatCompletionExtraParametersBehavior	fromString(String name)	Creates or finds a ChatCompletionExtraParametersBehavior from its string representation.
static Collection<ChatCompletionExtraParametersBehavior>	values()	Gets known ChatCompletionExtraParametersBehavior values.

Methods inherited from class com.azure.core.util.ExpandableStringEnum

equals, fromString, getValue, hashCode, toString, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

PASS_THROUGH

public static final ChatCompletionExtraParametersBehavior PASS_THROUGH

Passes any extra parameters directly to the model.

DROP

public static final ChatCompletionExtraParametersBehavior DROP

Drops all extra parameters.

ERROR

public static final ChatCompletionExtraParametersBehavior ERROR

Raises an error if any extra parameter is present.

Constructor Details

ChatCompletionExtraParametersBehavior

@Deprecated
public ChatCompletionExtraParametersBehavior()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ChatCompletionExtraParametersBehavior value.

Method Details

fromString

public static ChatCompletionExtraParametersBehavior fromString(String name)

Creates or finds a ChatCompletionExtraParametersBehavior from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ChatCompletionExtraParametersBehavior.

values

public static Collection<ChatCompletionExtraParametersBehavior> values()

Gets known ChatCompletionExtraParametersBehavior values.

Returns:

known ChatCompletionExtraParametersBehavior values.