Class: OpenAI::Models::Responses::ResponseOutputItemAddedEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseOutputItemAddedEvent

Defined in:

lib/openai/models/responses/response_output_item_added_event.rb

Instance Attribute Summary

• #item ⇒ OpenAI::Models::Responses::ResponseOutputMessage, ...

  The output item that was added.

• #output_index ⇒ Integer

  The index of the output item that was added.

• #sequence_number ⇒ Integer

  The sequence number of this event.

• #type ⇒ Symbol, :"response.output_item.added"

  The type of the event.

Instance Method Summary

• #initialize(item: , output_index: , sequence_number: , type: :"response.output_item.added") ⇒ Object constructor

  Some parameter documentations has been truncated, see ResponseOutputItemAddedEvent for more details.

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, 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(item: , output_index: , sequence_number: , type: :"response.output_item.added") ⇒ Object

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

Emitted when a new output item is added.

Parameters:

• item (OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest) (defaults to: ) —

  The output item that was added.

• output_index (Integer) (defaults to: ) —

  The index of the output item that was added.

• sequence_number (Integer) (defaults to: ) —

  The sequence number of this event.

• type (Symbol, :"response.output_item.added") (defaults to: :"response.output_item.added") —

  The type of the event. Always ‘response.output_item.added`.

# File 'lib/openai/models/responses/response_output_item_added_event.rb', line 31

Instance Attribute Details

#item ⇒ OpenAI::Models::Responses::ResponseOutputMessage, ...

The output item that was added.

Returns:

• (OpenAI::Models::Responses::ResponseOutputMessage, OpenAI::Models::Responses::ResponseFileSearchToolCall, OpenAI::Models::Responses::ResponseFunctionToolCall, OpenAI::Models::Responses::ResponseFunctionWebSearch, OpenAI::Models::Responses::ResponseComputerToolCall, OpenAI::Models::Responses::ResponseReasoningItem, OpenAI::Models::Responses::ResponseOutputItem::ImageGenerationCall, OpenAI::Models::Responses::ResponseCodeInterpreterToolCall, OpenAI::Models::Responses::ResponseOutputItem::LocalShellCall, OpenAI::Models::Responses::ResponseOutputItem::McpCall, OpenAI::Models::Responses::ResponseOutputItem::McpListTools, OpenAI::Models::Responses::ResponseOutputItem::McpApprovalRequest)

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

required :item, union: -> { OpenAI::Responses::ResponseOutputItem }

#output_index ⇒ Integer

The index of the output item that was added.

Returns:

• (Integer)

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

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number of this event.

Returns:

• (Integer)

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

required :sequence_number, Integer

#type ⇒ Symbol, :"response.output_item.added"

The type of the event. Always ‘response.output_item.added`.

Returns:

• (Symbol, :"response.output_item.added")

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

required :type, const: :"response.output_item.added"