ClientEventConversationItemRetrieve interface

Package:

@azure/ai-voicelive

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

ClientEvent

Properties

itemId	The ID of the item to retrieve.
type	The event type, must be conversation.item.retrieve.

Inherited Properties

eventId

Property Details

itemId

The ID of the item to retrieve.

itemId: string

Property Value

string

type

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

type: "conversation.item.retrieve"

Property Value

"conversation.item.retrieve"

Inherited Property Details

eventId

eventId?: string

Property Value

string

Inherited From ClientEvent.eventId