class

OpenAI::ToolChoiceAllowed

Inherits JSON::Serializable < Reference < Object

Constrains the tools available to the model to a pre-defined set.

Constructors

new(pull : JSON::PullParser)
Source
new(type_value : ToolChoiceAllowedType = ToolChoiceAllowedType::AllowedTools, mode : ToolChoiceAllowedMode = ToolChoiceAllowedMode::Auto, tools : Array(Hash(String, JSON::Any)) = [] of Hash(String, JSON::Any))
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

mode

Constrains the tools available to the model to a pre-defined set.

auto allows the model to pick from among the allowed tools and generate a message.

required requires the model to call one or more of the allowed tools.

Source
mode=(mode : ToolChoiceAllowedMode)

Constrains the tools available to the model to a pre-defined set.

auto allows the model to pick from among the allowed tools and generate a message.

required requires the model to call one or more of the allowed tools.

Source
tools

A list of tool definitions that the model should be allowed to call.

For the Responses API, the list of tool definitions might look like: '''json [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ] '''

Source
tools=(tools : Array(Hash(String, JSON::Any)))

A list of tool definitions that the model should be allowed to call.

For the Responses API, the list of tool definitions might look like: '''json [ { "type": "function", "name": "get_weather" }, { "type": "mcp", "server_label": "deepwiki" }, { "type": "image_generation" } ] '''

Source
type_value

Allowed tool configuration type. Always allowed_tools.

Source
type_value=(type_value : ToolChoiceAllowedType)

Allowed tool configuration type. Always allowed_tools.

Source