Class AssistantToolChoiceOption
-
- All Implemented Interfaces:
public final class AssistantToolChoiceOption
Controls which (if any) tool is called by the model.
none
means the model will not call any tools and instead generates a message.auto
is the default value and 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. 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 interface
AssistantToolChoiceOption.Visitor
An interface that defines how to map each variant of AssistantToolChoiceOption to a value of type T.
public final class
AssistantToolChoiceOption.Auto
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.
-
Method Summary
Modifier and Type Method Description final Optional<AssistantToolChoiceOption.Auto>
auto()
none
means the model will not call any tools and instead generates a message.final Optional<AssistantToolChoice>
assistantToolChoice()
Specifies a tool the model should use. final Boolean
isAuto()
final Boolean
isAssistantToolChoice()
final AssistantToolChoiceOption.Auto
asAuto()
none
means the model will not call any tools and instead generates a message.final AssistantToolChoice
asAssistantToolChoice()
Specifies a tool the model should use. final Optional<JsonValue>
_json()
final <T extends Any> T
accept(AssistantToolChoiceOption.Visitor<T> visitor)
final AssistantToolChoiceOption
validate()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static AssistantToolChoiceOption
ofAuto(AssistantToolChoiceOption.Auto auto)
none
means the model will not call any tools and instead generates a message.final static AssistantToolChoiceOption
ofAssistantToolChoice(AssistantToolChoice assistantToolChoice)
Specifies a tool the model should use. -
-
Method Detail
-
auto
final Optional<AssistantToolChoiceOption.Auto> auto()
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.
-
assistantToolChoice
final Optional<AssistantToolChoice> assistantToolChoice()
Specifies a tool the model should use. Use to force the model to call a specific tool.
-
isAssistantToolChoice
final Boolean isAssistantToolChoice()
-
asAuto
final AssistantToolChoiceOption.Auto asAuto()
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.
-
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()
-
ofAuto
final static AssistantToolChoiceOption ofAuto(AssistantToolChoiceOption.Auto auto)
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.
-
ofAssistantToolChoice
final static AssistantToolChoiceOption ofAssistantToolChoice(AssistantToolChoice assistantToolChoice)
Specifies a tool the model should use. Use to force the model to call a specific tool.
-
-
-
-