Class: OpenAI::Models::Responses::ToolChoiceFunction

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/openai/models/responses/tool_choice_function.rb

Instance Attribute Summary

• #name ⇒ String

  The name of the function to call.

• #type ⇒ Symbol, :function

  For function calling, the type is always ‘function`.

Instance Method Summary

• #initialize(name: , type: :function) ⇒ Object constructor

  Use this option to force the model to call a specific function.

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, 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(name: , type: :function) ⇒ Object

Use this option to force the model to call a specific function.

Parameters:

• name (String) (defaults to: ) —

  The name of the function to call.

• type (Symbol, :function) (defaults to: :function) —

  For function calling, the type is always ‘function`.

# File 'lib/openai/models/responses/tool_choice_function.rb', line 19

Instance Attribute Details

#name ⇒ String

The name of the function to call.

Returns:

• (String)

# File 'lib/openai/models/responses/tool_choice_function.rb', line 11

required :name, String

#type ⇒ Symbol, :function

For function calling, the type is always ‘function`.

Returns:

• (Symbol, :function)

# File 'lib/openai/models/responses/tool_choice_function.rb', line 17

required :type, const: :function