Class: OpenAI::Models::Realtime::ConversationItemRetrieveEvent

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

Send this event when you want to retrieve the server’s representation of a specific item in the conversation history. This is useful, for example, to inspect user audio after noise cancellation and VAD. The server will respond with a ‘conversation.item.retrieved` event, unless the item does not exist in the conversation history, in which case the server will respond with an error.

Parameters:

  • item_id (String) —

    The ID of the item to retrieve.

  • event_id (String) (defaults to: nil) —

    Optional client-generated ID used to identify this event.

  • type (Symbol, :"conversation.item.retrieve") (defaults to: :"conversation.item.retrieve") —

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




# File 'lib/openai/models/realtime/conversation_item_retrieve_event.rb', line 25

Instance Attribute Details

#event_id ⇒ String?

Optional client-generated ID used to identify this event.

Returns:

  • (String, nil) 


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

optional :event_id, String

#item_id ⇒ String

The ID of the item to retrieve.

Returns:

  • (String) 


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

required :item_id, String

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

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

Returns:

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


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

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