class

OpenAI::RealtimeClientEventConversationItemRetrieve

Inherits JSON::Serializable < Reference < 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.

Constructors

new(pull : JSON::PullParser)
Source
new(event_id : String | Nil = nil, type_value : Hash(String, JSON::Any) = Hash(String, JSON::Any).new, item_id : String = "")
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

event_id

Optional client-generated ID used to identify this event.

Source
event_id=(event_id : String | Nil)

Optional client-generated ID used to identify this event.

Source
item_id

The ID of the item to retrieve.

Source
item_id=(item_id : String)

The ID of the item to retrieve.

Source
type_value

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

Source
type_value=(type_value : Hash(String, JSON::Any))

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

Source