Class: OpenAI::Models::Realtime::ConversationItemAdded

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/realtime/conversation_item_added.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:, previous_item_id: nil, type: :"conversation.item.added") ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::Realtime::ConversationItemAdded for more details.

Sent by the server when an Item is added to the default Conversation. This can happen in several cases:

  • When the client sends a ‘conversation.item.create` event.

  • When the input audio buffer is committed. In this case the item will be a user message containing the audio from the buffer.

  • When the model is generating a Response. In this case the ‘conversation.item.added` event will be sent when the model starts generating a specific Item, and thus it will not yet have any content (and `status` will be `in_progress`).

The event will include the full content of the Item (except when model is generating a Response) except for audio data, which can be retrieved separately with a ‘conversation.item.retrieve` event if necessary.

Parameters:




# File 'lib/openai/models/realtime/conversation_item_added.rb', line 32

Instance Attribute Details

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


11
 
# File 'lib/openai/models/realtime/conversation_item_added.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/conversation_item_added.rb', line 17

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

#previous_item_id ⇒ String?

The ID of the item that precedes this one, if any. This is used to maintain ordering when items are inserted.

Returns:

  • (String, nil) 


30
 
# File 'lib/openai/models/realtime/conversation_item_added.rb', line 30

optional :previous_item_id, String, nil?: true

#type ⇒ Symbol, :"conversation.item.added"

The event type, must be ‘conversation.item.added`.

Returns:

  • (Symbol, :"conversation.item.added") 


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

required :type, const: :"conversation.item.added"