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

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

Overview

See Also:

Defined Under Namespace

Modules: Format

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(name:, description: nil, format_: nil) ⇒ Object

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

Properties of the custom tool.

Parameters:




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

Instance Attribute Details

#description ⇒ String?

Optional description of the custom tool, used to provide more context.

Returns:

  • (String, nil) 


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

optional :description, String

#format_ ⇒ OpenAI::Models::Chat::ChatCompletionCustomTool::Custom::Format::Text, ...

The input format for the custom tool. Default is unconstrained text.

Returns:



47
48
49
50
51
 
# File 'lib/openai/models/chat/chat_completion_custom_tool.rb', line 47

optional :format_,
union: -> {
  OpenAI::Chat::ChatCompletionCustomTool::Custom::Format
},
api_name: :format

#name ⇒ String

The name of the custom tool, used to identify it in tool calls.

Returns:

  • (String) 


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

required :name, String