Class: OpenAI::Models::Responses::ToolChoiceTypes

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ToolChoiceTypes

Defined in:

lib/openai/models/responses/tool_choice_types.rb

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #type ⇒ Symbol, OpenAI::Models::Responses::ToolChoiceTypes::Type

  The type of hosted tool the model should to use.

Instance Method Summary

• #initialize(type: ) ⇒ void constructor

  Some parameter documentations has been truncated, see ToolChoiceTypes for more details.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(type: ) ⇒ void

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ToolChoiceTypes for more details.

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Parameters:

• type (Symbol, OpenAI::Models::Responses::ToolChoiceTypes::Type) (defaults to: ) —

  The type of hosted tool the model should to use. Learn more about

# File 'lib/openai/models/responses/tool_choice_types.rb', line 22

Instance Attribute Details

#type ⇒ Symbol, OpenAI::Models::Responses::ToolChoiceTypes::Type

The type of hosted tool the model should to use. Learn more about built-in tools.

Allowed values are:

• file_search
• web_search_preview
• computer_use_preview
• code_interpreter
• image_generation

Returns:

• (Symbol, OpenAI::Models::Responses::ToolChoiceTypes::Type)

# File 'lib/openai/models/responses/tool_choice_types.rb', line 20

required :type, enum: -> { OpenAI::Responses::ToolChoiceTypes::Type }