Class: OpenAI::Models::Realtime::ResponseOutputItemAddedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/response_output_item_added_event.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(event_id:, item:, output_index:, response_id:, type: :"response.output_item.added") ⇒ Object

Returned when a new Item is created during Response generation.

Parameters:




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

Instance Attribute Details

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


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

required :event_id, String

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

A single item within a Realtime conversation.

Returns:



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

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

#output_index ⇒ Integer

The index of the output item in the Response.

Returns:

  • (Integer) 


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

required :output_index, Integer

#response_id ⇒ String

The ID of the Response to which the item belongs.

Returns:

  • (String) 


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

required :response_id, String

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

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

Returns:

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


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

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