Class: OpenAI::Models::Beta::AssistantToolChoice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::AssistantToolChoice

Defined in:

lib/openai/models/beta/assistant_tool_choice.rb

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #function ⇒ OpenAI::Models::Beta::AssistantToolChoiceFunction^?
• #type ⇒ Symbol, OpenAI::Models::Beta::AssistantToolChoice::Type

  The type of the tool.

Instance Method Summary

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

  Specifies a tool the model should use.

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

Specifies a tool the model should use. Use to force the model to call a specific tool.

Parameters:

• type (Symbol, OpenAI::Models::Beta::AssistantToolChoice::Type) (defaults to: ) —

  The type of the tool. If type is ‘function`, the function name must be set

• function (OpenAI::Models::Beta::AssistantToolChoiceFunction) (defaults to: nil)

# File 'lib/openai/models/beta/assistant_tool_choice.rb', line 18

Instance Attribute Details

#function ⇒ OpenAI::Models::Beta::AssistantToolChoiceFunction^?

Returns:

• (OpenAI::Models::Beta::AssistantToolChoiceFunction, nil)

# File 'lib/openai/models/beta/assistant_tool_choice.rb', line 16

optional :function, -> { OpenAI::Beta::AssistantToolChoiceFunction }

#type ⇒ Symbol, OpenAI::Models::Beta::AssistantToolChoice::Type

The type of the tool. If type is ‘function`, the function name must be set

Returns:

• (Symbol, OpenAI::Models::Beta::AssistantToolChoice::Type)

# File 'lib/openai/models/beta/assistant_tool_choice.rb', line 11

required :type, enum: -> { OpenAI::Beta::AssistantToolChoice::Type }