Class: OpenAI::Models::Realtime::ConversationItemCreatedEvent

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

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

Returned when a conversation item is created. There are several scenarios that produce this event:

  • The server is generating a Response, which if successful will produce either one or two Items, which will be of type ‘message` (role `assistant`) or type `function_call`.

  • The input audio buffer has been committed, either by the client or the server (in ‘server_vad` mode). The server will take the content of the input audio buffer and add it to a new user message Item.

  • The client has sent a ‘conversation.item.create` event to add a new Item to the Conversation.

Parameters:




# File 'lib/openai/models/realtime/conversation_item_created_event.rb', line 33

Instance Attribute Details

#event_id ⇒ String

The unique ID of the server event.

Returns:

  • (String) 


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

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

#previous_item_id ⇒ String?

The ID of the preceding item in the Conversation context, allows the client to understand the order of the conversation. Can be ‘null` if the item has no predecessor.

Returns:

  • (String, nil) 


31
 
# File 'lib/openai/models/realtime/conversation_item_created_event.rb', line 31

optional :previous_item_id, String, nil?: true

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

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

Returns:

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


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

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