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.VisitorAn interface that defines how to map each variant of FunctionCall to a value of type T.
public final classChatCompletionCreateParams.FunctionCall.FunctionCallModenonemeans 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.FunctionCallMode>mode()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 BooleanisMode()final BooleanisFunctionCallOption()final ChatCompletionCreateParams.FunctionCall.FunctionCallModeasMode()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()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionCreateParams.FunctionCallofMode(ChatCompletionCreateParams.FunctionCall.FunctionCallMode mode)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
-
mode
final Optional<ChatCompletionCreateParams.FunctionCall.FunctionCallMode> mode()
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.
-
isFunctionCallOption
final Boolean isFunctionCallOption()
-
asMode
final ChatCompletionCreateParams.FunctionCall.FunctionCallMode asMode()
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()
-
ofMode
final static ChatCompletionCreateParams.FunctionCall ofMode(ChatCompletionCreateParams.FunctionCall.FunctionCallMode mode)
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.
-
-
-
-