Class: OpenAI::Models::Chat::ChatCompletionCustomTool

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/chat/chat_completion_custom_tool.rb

Defined Under Namespace

Classes: Custom

Instance Attribute Summary collapse

Instance Method Summary collapse

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, meta_info, 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(custom:, type: :custom) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Chat::ChatCompletionCustomTool for more details.

A custom tool that processes input using a specified format.

Parameters:




# File 'lib/openai/models/chat/chat_completion_custom_tool.rb', line 19

Instance Attribute Details

#custom ⇒ OpenAI::Models::Chat::ChatCompletionCustomTool::Custom

Properties of the custom tool.

Returns:



11
 
# File 'lib/openai/models/chat/chat_completion_custom_tool.rb', line 11

required :custom, -> { OpenAI::Chat::ChatCompletionCustomTool::Custom }

#type ⇒ Symbol, :custom

The type of the custom tool. Always ‘custom`.

Returns:

  • (Symbol, :custom) 


17
 
# File 'lib/openai/models/chat/chat_completion_custom_tool.rb', line 17

required :type, const: :custom