Class: OpenAI::Models::Responses::ResponseCustomToolCallOutputItem

Inherits:
ResponseCustomToolCallOutput show all
Defined in:
lib/openai/models/responses/response_custom_tool_call_output_item.rb

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Attributes inherited from ResponseCustomToolCallOutput

#call_id, #output, #type

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(id:, status:, created_by: nil) ⇒ Object

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

The output of a custom tool call from your code, being sent back to the model.

Parameters:

  • The unique ID of the custom tool call output item.

  • The status of the item. One of in_progress, completed, or

  • (defaults to: nil)

    The identifier of the actor that created the item.




# File 'lib/openai/models/responses/response_custom_tool_call_output_item.rb', line 26

Instance Attribute Details

#created_by ⇒ String?

The identifier of the actor that created the item.

Returns:



24
 
# File 'lib/openai/models/responses/response_custom_tool_call_output_item.rb', line 24

optional :created_by, String

#id ⇒ String

The unique ID of the custom tool call output item.

Returns:



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

required :id, String

#status ⇒ Symbol, OpenAI::Models::Responses::ResponseCustomToolCallOutputItem::Status

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Returns:



18
 
# File 'lib/openai/models/responses/response_custom_tool_call_output_item.rb', line 18

required :status, enum: -> { OpenAI::Responses::ResponseCustomToolCallOutputItem::Status }