Class ChatCompletionCreateParams.FunctionCall
-
- All Implemented Interfaces:
@Deprecated(message = "deprecated") public final class ChatCompletionCreateParams.FunctionCall
Deprecated in favor of
tool_choice.Controls which (if any) function is called by the model.
nonemeans the model will not call a function and instead generates a message.automeans the model can pick between generating a message or calling a function.Specifying a particular function via
{"name": "my_function"}forces the model to call that function.noneis the default when no functions are present.autois the default if functions are present.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceChatCompletionCreateParams.FunctionCall.Visitorpublic final classChatCompletionCreateParams.FunctionCall.Deserializerpublic final classChatCompletionCreateParams.FunctionCall.Serializerpublic final classChatCompletionCreateParams.FunctionCall.Behaviornonemeans the model will not call a function and instead generates a message.automeans the model can pick between generating a message or calling a function.
-
Method Summary
Modifier and Type Method Description final Optional<ChatCompletionCreateParams.FunctionCall.Behavior>behavior()nonemeans the model will not call a function and instead generates a message.final Optional<ChatCompletionFunctionCallOption>functionCallOption()Specifying a particular function via {"name": "my_function"}forces the model to call that function.final BooleanisBehavior()final BooleanisFunctionCallOption()final ChatCompletionCreateParams.FunctionCall.BehaviorasBehavior()nonemeans the model will not call a function and instead generates a message.final ChatCompletionFunctionCallOptionasFunctionCallOption()Specifying a particular function via {"name": "my_function"}forces the model to call that function.final Optional<JsonValue>_json()final <T extends Any> Taccept(ChatCompletionCreateParams.FunctionCall.Visitor<T> visitor)final ChatCompletionCreateParams.FunctionCallvalidate()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionCreateParams.FunctionCallofBehavior(ChatCompletionCreateParams.FunctionCall.Behavior behavior)nonemeans the model will not call a function and instead generates a message.final static ChatCompletionCreateParams.FunctionCallofFunctionCallOption(ChatCompletionFunctionCallOption functionCallOption)Specifying a particular function via {"name": "my_function"}forces the model to call that function.-
-
Method Detail
-
behavior
final Optional<ChatCompletionCreateParams.FunctionCall.Behavior> behavior()
nonemeans the model will not call a function and instead generates a message.automeans the model can pick between generating a message or calling a function.
-
functionCallOption
final Optional<ChatCompletionFunctionCallOption> functionCallOption()
Specifying a particular function via
{"name": "my_function"}forces the model to call that function.
-
isBehavior
final Boolean isBehavior()
-
isFunctionCallOption
final Boolean isFunctionCallOption()
-
asBehavior
final ChatCompletionCreateParams.FunctionCall.Behavior asBehavior()
nonemeans the model will not call a function and instead generates a message.automeans the model can pick between generating a message or calling a function.
-
asFunctionCallOption
final ChatCompletionFunctionCallOption asFunctionCallOption()
Specifying a particular function via
{"name": "my_function"}forces the model to call that function.
-
accept
final <T extends Any> T accept(ChatCompletionCreateParams.FunctionCall.Visitor<T> visitor)
-
validate
final ChatCompletionCreateParams.FunctionCall validate()
-
ofBehavior
final static ChatCompletionCreateParams.FunctionCall ofBehavior(ChatCompletionCreateParams.FunctionCall.Behavior behavior)
nonemeans the model will not call a function and instead generates a message.automeans the model can pick between generating a message or calling a function.
-
ofFunctionCallOption
final static ChatCompletionCreateParams.FunctionCall ofFunctionCallOption(ChatCompletionFunctionCallOption functionCallOption)
Specifying a particular function via
{"name": "my_function"}forces the model to call that function.
-
-
-
-