Class AssistantToolChoiceOption.Auto
-
- All Implemented Interfaces:
-
com.openai.core.Enum
public final class AssistantToolChoiceOption.Auto implements Enum
none
means the model will not call any tools and instead generates a message.auto
means the model can pick between generating a message or calling one or more tools.required
means the model must call one or more tools before responding to the user.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public enum
AssistantToolChoiceOption.Auto.Known
An enum containing Auto's known values.
public enum
AssistantToolChoiceOption.Auto.Value
An enum containing Auto's known values, as well as an _UNKNOWN member.
An instance of Auto can contain an unknown value in a couple of cases:
It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
It was constructed with an arbitrary value using the of method.
-
Field Summary
Fields Modifier and Type Field Description public final static AssistantToolChoiceOption.Auto
NONE
public final static AssistantToolChoiceOption.Auto
AUTO
public final static AssistantToolChoiceOption.Auto
REQUIRED
-
Method Summary
Modifier and Type Method Description final JsonField<String>
_value()
Returns this class instance's raw value. final AssistantToolChoiceOption.Auto.Value
value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value. final AssistantToolChoiceOption.Auto.Known
known()
Returns an enum member corresponding to this class instance's value. final String
asString()
Returns this class instance's primitive wire representation. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static AssistantToolChoiceOption.Auto
of(String value)
-
-
Method Detail
-
_value
final JsonField<String> _value()
Returns this class instance's raw value.
This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
-
value
final AssistantToolChoiceOption.Auto.Value value()
Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
-
known
final AssistantToolChoiceOption.Auto.Known known()
Returns an enum member corresponding to this class instance's value.
Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
-
asString
final String asString()
Returns this class instance's primitive wire representation.
This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
-
of
final static AssistantToolChoiceOption.Auto of(String value)
-
-
-
-