Package com.openai.models.responses
Class ToolChoiceFunction
-
- All Implemented Interfaces:
public final class ToolChoiceFunction
Use this option to force the model to call a specific function.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ToolChoiceFunction.Builder
A builder for ToolChoiceFunction.
-
Method Summary
Modifier and Type Method Description final String
name()
The name of the function to call. final JsonValue
_type()
For function calling, the type is always function
.final JsonField<String>
_name()
Returns the raw JSON value of name. final Map<String, JsonValue>
_additionalProperties()
final ToolChoiceFunction.Builder
toBuilder()
final ToolChoiceFunction
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ToolChoiceFunction.Builder
builder()
Returns a mutable builder for constructing an instance of ToolChoiceFunction. -
-
Method Detail
-
_type
final JsonValue _type()
For function calling, the type is always
function
.Expected to always return the following:
JsonValue.from("function")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ToolChoiceFunction.Builder toBuilder()
-
validate
final ToolChoiceFunction validate()
-
builder
final static ToolChoiceFunction.Builder builder()
Returns a mutable builder for constructing an instance of ToolChoiceFunction.
The following fields are required:
.name()
-
-
-
-