Package com.azure.ai.openai.assistants.models

Class AssistantsApiToolChoiceOptionMode

java.lang.Object

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

com.azure.ai.openai.assistants.models.AssistantsApiToolChoiceOptionMode

All Implemented Interfaces:

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

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

Specifies how the tool choice will be used.

Field Summary

Fields

Modifier and Type	Field	Description
static final AssistantsApiToolChoiceOptionMode	AUTO	The model can pick between generating a message or calling a function.
static final AssistantsApiToolChoiceOptionMode	NONE	The model will not call a function and instead generates a message.

Constructor Summary

Constructors

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

Method Summary

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

NONE

public static final AssistantsApiToolChoiceOptionMode NONE

The model will not call a function and instead generates a message.

AUTO

public static final AssistantsApiToolChoiceOptionMode AUTO

The model can pick between generating a message or calling a function.

Constructor Details

AssistantsApiToolChoiceOptionMode

@Deprecated
public AssistantsApiToolChoiceOptionMode()

Deprecated.

Use the fromString(String) factory method.

Creates a new instance of AssistantsApiToolChoiceOptionMode value.

Method Details

fromString

public static AssistantsApiToolChoiceOptionMode fromString(String name)

Creates or finds a AssistantsApiToolChoiceOptionMode from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding AssistantsApiToolChoiceOptionMode.

values

public static Collection<AssistantsApiToolChoiceOptionMode> values()

Gets known AssistantsApiToolChoiceOptionMode values.

Returns:

known AssistantsApiToolChoiceOptionMode values.