Class: OpenAI::Models::Chat::ChatCompletionTool

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/openai/models/chat/chat_completion_tool.rb

Instance Attribute Summary

• #function ⇒ OpenAI::Models::FunctionDefinition
• #type ⇒ Symbol, :function

  The type of the tool.

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from OpenAI::Internal::Type::BaseModel

Instance Attribute Details

#function ⇒ OpenAI::Models::FunctionDefinition

Returns:

• (OpenAI::Models::FunctionDefinition)

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

required :function, -> { OpenAI::FunctionDefinition }

#type ⇒ Symbol, :function

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

Returns:

• (Symbol, :function)

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

required :type, const: :function