Class: OpenAI::Models::Chat::ChatCompletionMessageCustomToolCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/chat/chat_completion_message_custom_tool_call.rb,
sig/openai/models/chat/chat_completion_message_custom_tool_call.rbs

Defined Under Namespace

Classes: Custom

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(id:, custom:, type: :custom) ⇒ Object

Parameters:

  • id —

    The ID of the tool call.

  • custom —

    The custom tool that the model called.

  • type (defaults to: :custom) —

    The type of the tool. Always custom.




# File 'lib/openai/models/chat/chat_completion_message_custom_tool_call.rb', line 25

Instance Attribute Details

#custom ⇒ OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom

The custom tool that the model called.

Returns:

  • (OpenAI::Chat::ChatCompletionMessageCustomToolCall::Custom) 


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

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

#id ⇒ String

The ID of the tool call.

Returns:

  • (String) 


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

required :id, String

#type ⇒ :custom

The type of the tool. Always custom.

Returns:

  • (:custom) 


23
 
# File 'lib/openai/models/chat/chat_completion_message_custom_tool_call.rb', line 23

required :type, const: :custom

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/openai/models/chat/chat_completion_message_custom_tool_call.rbs', line 35

def to_hash: -> {