Class: OpenAI::Models::Chat::ChatCompletionNamedToolChoice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Chat::ChatCompletionNamedToolChoice

Defined in:

lib/openai/models/chat/chat_completion_named_tool_choice.rb

Defined Under Namespace

Classes: Function

Instance Attribute Summary

• #function ⇒ OpenAI::Models::Chat::ChatCompletionNamedToolChoice::Function
• #type ⇒ Symbol, :function

  The type of the tool.

Instance Method Summary

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

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

Parameters:

• function (OpenAI::Models::Chat::ChatCompletionNamedToolChoice::Function) (defaults to: )
• type (Symbol, :function) (defaults to: :function) —

  The type of the tool. Currently, only ‘function` is supported.

# File 'lib/openai/models/chat/chat_completion_named_tool_choice.rb', line 18

Instance Attribute Details

#function ⇒ OpenAI::Models::Chat::ChatCompletionNamedToolChoice::Function

Returns:

• (OpenAI::Models::Chat::ChatCompletionNamedToolChoice::Function)

# File 'lib/openai/models/chat/chat_completion_named_tool_choice.rb', line 10

required :function, -> { OpenAI::Chat::ChatCompletionNamedToolChoice::Function }

#type ⇒ Symbol, :function

The type of the tool. Currently, only ‘function` is supported.

Returns:

• (Symbol, :function)

# File 'lib/openai/models/chat/chat_completion_named_tool_choice.rb', line 16

required :type, const: :function