RealtimeClientEventConversationItemRetrieve interface

Package:

@azure/ai-projects

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.

Extends

RealtimeClientEvent

Properties

event_id	Optional client-generated ID used to identify this event.
item_id	The ID of the item to retrieve.
type	The event type, must be conversation.item.retrieve.

Property Details

event_id

Optional client-generated ID used to identify this event.

event_id?: string

Property Value

string

item_id

The ID of the item to retrieve.

item_id: string

Property Value

string

type

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

type: "conversation.item.retrieve"

Property Value

"conversation.item.retrieve"