Class: OpenAI::Models::Responses::ResponseCustomToolCall

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/responses/response_custom_tool_call.rb

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(call_id:, input:, name:, id: nil, type: :custom_tool_call) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Responses::ResponseCustomToolCall for more details.

A call to a custom tool created by the model.

Parameters:

  • call_id (String) —

    An identifier used to map this custom tool call to a tool call output.

  • input (String) —

    The input for the custom tool call generated by the model.

  • name (String) —

    The name of the custom tool being called.

  • id (String) (defaults to: nil) —

    The unique ID of the custom tool call in the OpenAI platform.

  • type (Symbol, :custom_tool_call) (defaults to: :custom_tool_call) —

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




# File 'lib/openai/models/responses/response_custom_tool_call.rb', line 37

Instance Attribute Details

#call_id ⇒ String

An identifier used to map this custom tool call to a tool call output.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/responses/response_custom_tool_call.rb', line 11

required :call_id, String

#id ⇒ String?

The unique ID of the custom tool call in the OpenAI platform.

Returns:

  • (String, nil) 


35
 
# File 'lib/openai/models/responses/response_custom_tool_call.rb', line 35

optional :id, String

#input ⇒ String

The input for the custom tool call generated by the model.

Returns:

  • (String) 


17
 
# File 'lib/openai/models/responses/response_custom_tool_call.rb', line 17

required :input, String

#name ⇒ String

The name of the custom tool being called.

Returns:

  • (String) 


23
 
# File 'lib/openai/models/responses/response_custom_tool_call.rb', line 23

required :name, String

#type ⇒ Symbol, :custom_tool_call

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

Returns:

  • (Symbol, :custom_tool_call) 


29
 
# File 'lib/openai/models/responses/response_custom_tool_call.rb', line 29

required :type, const: :custom_tool_call