ServerEventConversationItemTruncated interface

Package:

@azure/ai-voicelive

Returned when an earlier assistant audio message item is truncated by the client with a conversation.item.truncate event. This event is used to synchronize the server's understanding of the audio with the client's playback. This action will truncate the audio and remove the server-side text transcript to ensure there is no text in the context that hasn't been heard by the user.

Extends

ServerEvent

Properties

audioEndInMs	The duration up to which the audio was truncated, in milliseconds.
contentIndex	The index of the content part that was truncated.
itemId	The ID of the assistant message item that was truncated.
type	The event type, must be conversation.item.truncated.

Inherited Properties

eventId

Property Details

audioEndInMs

The duration up to which the audio was truncated, in milliseconds.

audioEndInMs: number

Property Value

number

contentIndex

The index of the content part that was truncated.

contentIndex: number

Property Value

number

itemId

The ID of the assistant message item that was truncated.

itemId: string

Property Value

string

type

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

type: "conversation.item.truncated"

Property Value

"conversation.item.truncated"

Inherited Property Details

eventId

eventId?: string

Property Value

string

Inherited From ServerEvent.eventId