Class BetaToolChoiceTool
-
- All Implemented Interfaces:
public final class BetaToolChoiceToolThe model will use the specified tool with
tool_choice.name.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBetaToolChoiceTool.BuilderA builder for BetaToolChoiceTool.
-
Method Summary
Modifier and Type Method Description final Stringname()The name of the tool to use. final JsonValue_type()Expected to always return the following:
However, this method can be useful for debugging and logging (e.g.JsonValue.from("tool")final Optional<Boolean>disableParallelToolUse()Whether to disable parallel tool use. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<Boolean>_disableParallelToolUse()Returns the raw JSON value of disableParallelToolUse. final Map<String, JsonValue>_additionalProperties()final BetaToolChoiceTool.BuildertoBuilder()final BetaToolChoiceToolvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BetaToolChoiceTool.Builderbuilder()Returns a mutable builder for constructing an instance of BetaToolChoiceTool. -
-
Method Detail
-
_type
final JsonValue _type()
Expected to always return the following:
JsonValue.from("tool")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
disableParallelToolUse
final Optional<Boolean> disableParallelToolUse()
Whether to disable parallel tool use.
Defaults to
false. If set totrue, the model will output exactly one tool use.
-
_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.
-
_disableParallelToolUse
final JsonField<Boolean> _disableParallelToolUse()
Returns the raw JSON value of disableParallelToolUse.
Unlike disableParallelToolUse, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final BetaToolChoiceTool.Builder toBuilder()
-
validate
final BetaToolChoiceTool validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static BetaToolChoiceTool.Builder builder()
Returns a mutable builder for constructing an instance of BetaToolChoiceTool.
The following fields are required:
.name()
-
-
-
-