Interface ChatCompletionToolChoiceOption.Visitor
-
- All Implemented Interfaces:
public interface ChatCompletionToolChoiceOption.Visitor<T extends Object>
An interface that defines how to map each variant of ChatCompletionToolChoiceOption to a value of type T.
-
-
Method Summary
Modifier and Type Method Description abstract T
visitAuto(ChatCompletionToolChoiceOption.Auto auto)
none
means the model will not call any tool and instead generates a message.abstract T
visitAllowedToolChoice(ChatCompletionAllowedToolChoice allowedToolChoice)
Constrains the tools available to the model to a pre-defined set. abstract T
visitNamedToolChoice(ChatCompletionNamedToolChoice namedToolChoice)
Specifies a tool the model should use. abstract T
visitNamedToolChoiceCustom(ChatCompletionNamedToolChoiceCustom namedToolChoiceCustom)
Specifies a tool the model should use. T
unknown(JsonValue json)
Maps an unknown variant of ChatCompletionToolChoiceOption to a value of type T. -
-
Method Detail
-
visitAuto
abstract T visitAuto(ChatCompletionToolChoiceOption.Auto auto)
none
means the model will not call any tool 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.
-
visitAllowedToolChoice
abstract T visitAllowedToolChoice(ChatCompletionAllowedToolChoice allowedToolChoice)
Constrains the tools available to the model to a pre-defined set.
-
visitNamedToolChoice
abstract T visitNamedToolChoice(ChatCompletionNamedToolChoice namedToolChoice)
Specifies a tool the model should use. Use to force the model to call a specific function.
-
visitNamedToolChoiceCustom
abstract T visitNamedToolChoiceCustom(ChatCompletionNamedToolChoiceCustom namedToolChoiceCustom)
Specifies a tool the model should use. Use to force the model to call a specific custom tool.
-
unknown
T unknown(JsonValue json)
Maps an unknown variant of ChatCompletionToolChoiceOption to a value of type T.
An instance of ChatCompletionToolChoiceOption can contain an unknown variant if it was deserialized from data that doesn't match any known variant. For example, if the SDK is on an older version than the API, then the API may respond with new variants that the SDK is unaware of.
-
-
-
-