Class ChatCompletionAllowedTools
-
- All Implemented Interfaces:
public final class ChatCompletionAllowedToolsConstrains the tools available to the model to a pre-defined set.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionAllowedTools.BuilderA builder for ChatCompletionAllowedTools.
public final classChatCompletionAllowedTools.ModeConstrains the tools available to the model to a pre-defined set.
autoallows the model to pick from among the allowed tools and generate a message.requiredrequires the model to call one or more of the allowed tools.public final classChatCompletionAllowedTools.ToolA tool definition that the model should be allowed to call.
-
Method Summary
Modifier and Type Method Description final ChatCompletionAllowedTools.Modemode()Constrains the tools available to the model to a pre-defined set. final List<ChatCompletionAllowedTools.Tool>tools()A list of tool definitions that the model should be allowed to call. final JsonField<ChatCompletionAllowedTools.Mode>_mode()Returns the raw JSON value of mode. final JsonField<List<ChatCompletionAllowedTools.Tool>>_tools()Returns the raw JSON value of tools. final Map<String, JsonValue>_additionalProperties()final ChatCompletionAllowedTools.BuildertoBuilder()final ChatCompletionAllowedToolsvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionAllowedTools.Builderbuilder()Returns a mutable builder for constructing an instance of ChatCompletionAllowedTools. -
-
Method Detail
-
mode
final ChatCompletionAllowedTools.Mode mode()
Constrains the tools available to the model to a pre-defined set.
autoallows the model to pick from among the allowed tools and generate a message.requiredrequires the model to call one or more of the allowed tools.
-
tools
final List<ChatCompletionAllowedTools.Tool> tools()
A list of tool definitions that the model should be allowed to call.
For the Chat Completions API, the list of tool definitions might look like:
[ { "type": "function", "function": { "name": "get_weather" } }, { "type": "function", "function": { "name": "get_time" } } ]
-
_mode
final JsonField<ChatCompletionAllowedTools.Mode> _mode()
Returns the raw JSON value of mode.
Unlike mode, this method doesn't throw if the JSON field has an unexpected type.
-
_tools
final JsonField<List<ChatCompletionAllowedTools.Tool>> _tools()
Returns the raw JSON value of tools.
Unlike tools, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionAllowedTools.Builder toBuilder()
-
validate
final ChatCompletionAllowedTools 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 ChatCompletionAllowedTools.Builder builder()
Returns a mutable builder for constructing an instance of ChatCompletionAllowedTools.
The following fields are required:
.mode() .tools()
-
-
-
-