Package com.azure.ai.inference.models

Class ChatCompletionsToolChoicePreset

java.lang.Object

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

com.azure.ai.inference.models.ChatCompletionsToolChoicePreset

All Implemented Interfaces:

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

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

Represents a generic policy for how a chat completions tool may be selected.

Field Summary

Fields

Modifier and Type	Field	Description
static final ChatCompletionsToolChoicePreset	AUTO	Specifies that the model may either use any of the tools provided in this chat completions request or instead return a standard chat completions response as if no tools were provided.
static final ChatCompletionsToolChoicePreset	NONE	Specifies that the model should not respond with a tool call and should instead provide a standard chat completions response.
static final ChatCompletionsToolChoicePreset	REQUIRED	Specifies that the model should respond with a call to one or more tools.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static ChatCompletionsToolChoicePreset	fromString(String name)	Creates or finds a ChatCompletionsToolChoicePreset from its string representation.
static Collection<ChatCompletionsToolChoicePreset>	values()	Gets known ChatCompletionsToolChoicePreset 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

AUTO

public static final ChatCompletionsToolChoicePreset AUTO

Specifies that the model may either use any of the tools provided in this chat completions request or instead return a standard chat completions response as if no tools were provided.

NONE

public static final ChatCompletionsToolChoicePreset NONE

Specifies that the model should not respond with a tool call and should instead provide a standard chat completions response. Response content may still be influenced by the provided tool definitions.

REQUIRED

public static final ChatCompletionsToolChoicePreset REQUIRED

Specifies that the model should respond with a call to one or more tools.

Constructor Details

ChatCompletionsToolChoicePreset

@Deprecated
public ChatCompletionsToolChoicePreset()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of ChatCompletionsToolChoicePreset value.

Method Details

fromString

public static ChatCompletionsToolChoicePreset fromString(String name)

Creates or finds a ChatCompletionsToolChoicePreset from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding ChatCompletionsToolChoicePreset.

values

public static Collection<ChatCompletionsToolChoicePreset> values()

Gets known ChatCompletionsToolChoicePreset values.

Returns:

known ChatCompletionsToolChoicePreset values.