Class: OpenAI::Models::Realtime::ResponseOutputItemDoneEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Realtime::ResponseOutputItemDoneEvent

Defined in:

lib/openai/models/realtime/response_output_item_done_event.rb

Instance Attribute Summary

• #event_id ⇒ String

  The unique ID of the server event.

• #item ⇒ OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, ...

  A single item within a Realtime conversation.

• #output_index ⇒ Integer

  The index of the output item in the Response.

• #response_id ⇒ String

  The ID of the Response to which the item belongs.

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

  The event type, must be ‘response.output_item.done`.

Instance Method Summary

• #initialize(event_id:, item:, output_index:, response_id:, type: :"response.output_item.done") ⇒ Object constructor

  Returned when an Item is done streaming.

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

Returned when an Item is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

Parameters:

• event_id (String) —

  The unique ID of the server event.

• item (OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest) —

  A single item within a Realtime conversation.

• output_index (Integer) —

  The index of the output item in the Response.

• response_id (String) —

  The ID of the Response to which the item belongs.

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

  The event type, must be ‘response.output_item.done`.

# File 'lib/openai/models/realtime/response_output_item_done_event.rb', line 37

Instance Attribute Details

#event_id ⇒ String

The unique ID of the server event.

Returns:

• (String)

# File 'lib/openai/models/realtime/response_output_item_done_event.rb', line 11

required :event_id, String

#item ⇒ OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, ...

A single item within a Realtime conversation.

Returns:

• (OpenAI::Models::Realtime::RealtimeConversationItemSystemMessage, OpenAI::Models::Realtime::RealtimeConversationItemUserMessage, OpenAI::Models::Realtime::RealtimeConversationItemAssistantMessage, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCall, OpenAI::Models::Realtime::RealtimeConversationItemFunctionCallOutput, OpenAI::Models::Realtime::RealtimeMcpApprovalResponse, OpenAI::Models::Realtime::RealtimeMcpListTools, OpenAI::Models::Realtime::RealtimeMcpToolCall, OpenAI::Models::Realtime::RealtimeMcpApprovalRequest)

# File 'lib/openai/models/realtime/response_output_item_done_event.rb', line 17

required :item, union: -> { OpenAI::Realtime::ConversationItem }

#output_index ⇒ Integer

The index of the output item in the Response.

Returns:

• (Integer)

# File 'lib/openai/models/realtime/response_output_item_done_event.rb', line 23

required :output_index, Integer

#response_id ⇒ String

The ID of the Response to which the item belongs.

Returns:

• (String)

# File 'lib/openai/models/realtime/response_output_item_done_event.rb', line 29

required :response_id, String

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

The event type, must be ‘response.output_item.done`.

Returns:

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

# File 'lib/openai/models/realtime/response_output_item_done_event.rb', line 35

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