Class: OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent

Defined in:

lib/openai/models/beta/beta_response_output_item_added_event.rb,
sig/openai/models/beta/beta_response_output_item_added_event.rbs

Defined Under Namespace

Classes: Agent

Instance Attribute Summary

• #agent ⇒ OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent::Agent^?

  The agent that owns this multi-agent streaming event.

• #item ⇒ OpenAI::Models::Beta::BetaResponseOutputMessage, ...

  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:, agent: nil, type: :"response.output_item.added") ⇒ Object constructor

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

• #to_hash ⇒ {

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

Some parameter documentations has been truncated, see OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent for more details.

Emitted when a new output item is added.

Parameters:

• item (OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem) —

  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.

• agent (OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent::Agent, nil) (defaults to: nil) —

  The agent that owns this multi-agent streaming 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/beta/beta_response_output_item_added_event.rb', line 37

Instance Attribute Details

#agent ⇒ OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent::Agent^?

The agent that owns this multi-agent streaming event.

Parameters:

• value (OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent, nil)

Returns:

• (OpenAI::Models::Beta::BetaResponseOutputItemAddedEvent::Agent, nil)

# File 'lib/openai/models/beta/beta_response_output_item_added_event.rb', line 35

optional :agent, -> { OpenAI::Beta::BetaResponseOutputItemAddedEvent::Agent }, nil?: true

#item ⇒ OpenAI::Models::Beta::BetaResponseOutputMessage, ...

The output item that was added.

Parameters:

• value (OpenAI::Models::Beta::beta_response_output_item)

Returns:

• (OpenAI::Models::Beta::BetaResponseOutputMessage, OpenAI::Models::Beta::BetaResponseFileSearchToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCall, OpenAI::Models::Beta::BetaResponseFunctionToolCallOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AgentMessage, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCall, OpenAI::Models::Beta::BetaResponseOutputItem::MultiAgentCallOutput, OpenAI::Models::Beta::BetaResponseFunctionWebSearch, OpenAI::Models::Beta::BetaResponseComputerToolCall, OpenAI::Models::Beta::BetaResponseComputerToolCallOutputItem, OpenAI::Models::Beta::BetaResponseReasoningItem, OpenAI::Models::Beta::BetaResponseOutputItem::Program, OpenAI::Models::Beta::BetaResponseOutputItem::ProgramOutput, OpenAI::Models::Beta::BetaResponseToolSearchCall, OpenAI::Models::Beta::BetaResponseToolSearchOutputItem, OpenAI::Models::Beta::BetaResponseOutputItem::AdditionalTools, OpenAI::Models::Beta::BetaResponseCompactionItem, OpenAI::Models::Beta::BetaResponseOutputItem::ImageGenerationCall, OpenAI::Models::Beta::BetaResponseCodeInterpreterToolCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCall, OpenAI::Models::Beta::BetaResponseOutputItem::LocalShellCallOutput, OpenAI::Models::Beta::BetaResponseFunctionShellToolCall, OpenAI::Models::Beta::BetaResponseFunctionShellToolCallOutput, OpenAI::Models::Beta::BetaResponseApplyPatchToolCall, OpenAI::Models::Beta::BetaResponseApplyPatchToolCallOutput, OpenAI::Models::Beta::BetaResponseOutputItem::McpCall, OpenAI::Models::Beta::BetaResponseOutputItem::McpListTools, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalRequest, OpenAI::Models::Beta::BetaResponseOutputItem::McpApprovalResponse, OpenAI::Models::Beta::BetaResponseCustomToolCall, OpenAI::Models::Beta::BetaResponseCustomToolCallOutputItem)

# File 'lib/openai/models/beta/beta_response_output_item_added_event.rb', line 11

required :item, union: -> { OpenAI::Beta::BetaResponseOutputItem }

#output_index ⇒ Integer

The index of the output item that was added.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/openai/models/beta/beta_response_output_item_added_event.rb', line 17

required :output_index, Integer

#sequence_number ⇒ Integer

The sequence number of this event.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/openai/models/beta/beta_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.

Parameters:

• value (:"response.output_item.added")

Returns:

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

# File 'lib/openai/models/beta/beta_response_output_item_added_event.rb', line 29

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/beta/beta_response_output_item_added_event.rbs', line 34

def to_hash: -> {