ChatCompletionExtraParametersBehavior Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:12.0.0

• java.lang.Object
• • com.azure.core.util.ExpandableStringEnum<T>
  • • com.azure.search.documents.indexes.models.ChatCompletionExtraParametersBehavior

public final class ChatCompletionExtraParametersBehavior
extends ExpandableStringEnum<ChatCompletionExtraParametersBehavior>

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

Field Summary

Modifier and Type	Field and 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

Constructor	Description
ChatCompletionExtraParametersBehavior()	Deprecated Use the fromString(String name) factory method. Creates a new instance of ChatCompletionExtraParametersBehavior value.

Method Summary

Modifier and Type	Method and 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 ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

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.

PASS_THROUGH

public static final ChatCompletionExtraParametersBehavior PASS_THROUGH

Passes any extra parameters directly to the model.

Constructor Details

ChatCompletionExtraParametersBehavior

@Deprecated
public ChatCompletionExtraParametersBehavior()

Deprecated

Use the fromString(String name) 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.