RealtimeServerEventConversationItemRetrieved interface

Package:

@azure/ai-projects

Returned when a conversation item is retrieved with conversation.item.retrieve. This is provided as a way to fetch the server's representation of an item, for example to get access to the post-processed audio data after noise cancellation and VAD. It includes the full content of the Item, including audio data.

Extends

RealtimeServerEvent

Properties

event_id	The unique ID of the server event.
item	The service's representation of the requested conversation item, including available audio data.
type	The event type, must be conversation.item.retrieved.

Property Details

event_id

The unique ID of the server event.

event_id: string

Property Value

string

item

The service's representation of the requested conversation item, including available audio data.

item: RealtimeConversationItemUnion

Property Value

RealtimeConversationItemUnion

type

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

type: "conversation.item.retrieved"

Property Value

"conversation.item.retrieved"