Class AssistantToolChoiceOption
-
- All Implemented Interfaces:
public final class AssistantToolChoiceOptionControls which (if any) tool is called by the model.
nonemeans the model will not call any tools and instead generates a message.autois the default value and means the model can pick between generating a message or calling one or more tools.requiredmeans the model must call one or more tools before responding to the user. Specifying a particular tool like{"type": "file_search"}or{"type": "function", "function": {"name": "my_function"}}forces the model to call that tool.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceAssistantToolChoiceOption.Visitorpublic final classAssistantToolChoiceOption.Deserializerpublic final classAssistantToolChoiceOption.Serializerpublic final classAssistantToolChoiceOption.Behaviornonemeans the model will not call any tools and instead generates a message.automeans the model can pick between generating a message or calling one or more tools.requiredmeans the model must call one or more tools before responding to the user.
-
Method Summary
Modifier and Type Method Description final Optional<AssistantToolChoiceOption.Behavior>behavior()nonemeans the model will not call any tools and instead generates a message.final Optional<AssistantToolChoice>assistantToolChoice()Specifies a tool the model should use. final BooleanisBehavior()final BooleanisAssistantToolChoice()final AssistantToolChoiceOption.BehaviorasBehavior()nonemeans the model will not call any tools and instead generates a message.final AssistantToolChoiceasAssistantToolChoice()Specifies a tool the model should use. final Optional<JsonValue>_json()final <T extends Any> Taccept(AssistantToolChoiceOption.Visitor<T> visitor)final AssistantToolChoiceOptionvalidate()Booleanequals(Object other)IntegerhashCode()StringtoString()final static AssistantToolChoiceOptionofBehavior(AssistantToolChoiceOption.Behavior behavior)nonemeans the model will not call any tools and instead generates a message.final static AssistantToolChoiceOptionofAssistantToolChoice(AssistantToolChoice assistantToolChoice)Specifies a tool the model should use. -
-
Method Detail
-
behavior
final Optional<AssistantToolChoiceOption.Behavior> behavior()
nonemeans the model will not call any tools and instead generates a message.automeans the model can pick between generating a message or calling one or more tools.requiredmeans the model must call one or more tools before responding to the user.
-
assistantToolChoice
final Optional<AssistantToolChoice> assistantToolChoice()
Specifies a tool the model should use. Use to force the model to call a specific tool.
-
isBehavior
final Boolean isBehavior()
-
isAssistantToolChoice
final Boolean isAssistantToolChoice()
-
asBehavior
final AssistantToolChoiceOption.Behavior asBehavior()
nonemeans the model will not call any tools and instead generates a message.automeans the model can pick between generating a message or calling one or more tools.requiredmeans the model must call one or more tools before responding to the user.
-
asAssistantToolChoice
final AssistantToolChoice asAssistantToolChoice()
Specifies a tool the model should use. Use to force the model to call a specific tool.
-
accept
final <T extends Any> T accept(AssistantToolChoiceOption.Visitor<T> visitor)
-
validate
final AssistantToolChoiceOption validate()
-
ofBehavior
final static AssistantToolChoiceOption ofBehavior(AssistantToolChoiceOption.Behavior behavior)
nonemeans the model will not call any tools and instead generates a message.automeans the model can pick between generating a message or calling one or more tools.requiredmeans the model must call one or more tools before responding to the user.
-
ofAssistantToolChoice
final static AssistantToolChoiceOption ofAssistantToolChoice(AssistantToolChoice assistantToolChoice)
Specifies a tool the model should use. Use to force the model to call a specific tool.
-
-
-
-