ClientEventConversationItemTruncate interface

Package:

@azure/ai-voicelive

Send this event to truncate a previous assistant message’s audio. The server will produce audio faster than voicelive, so this event is useful when the user interrupts to truncate audio that has already been sent to the client but not yet played. This will synchronize the server's understanding of the audio with the client's playback. Truncating audio will delete the server-side text transcript to ensure there is not text in the context that hasn't been heard by the user. If successful, the server will respond with a conversation.item.truncated event.

Extends

ClientEvent

Properties

audioEndInMs	Inclusive duration up to which audio is truncated, in milliseconds. If the audio_end_ms is greater than the actual audio duration, the server will respond with an error.
contentIndex	The index of the content part to truncate. Set this to 0.
itemId	The ID of the assistant message item to truncate. Only assistant message items can be truncated.
type	The event type, must be conversation.item.truncate.

Inherited Properties

eventId

Property Details

audioEndInMs

Inclusive duration up to which audio is truncated, in milliseconds. If the audio_end_ms is greater than the actual audio duration, the server will respond with an error.

audioEndInMs: number

Property Value

number

contentIndex

The index of the content part to truncate. Set this to 0.

contentIndex: number

Property Value

number

itemId

The ID of the assistant message item to truncate. Only assistant message items can be truncated.

itemId: string

Property Value

string

type

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

type: "conversation.item.truncate"

Property Value

"conversation.item.truncate"

Inherited Property Details

eventId

eventId?: string

Property Value

string

Inherited From ClientEvent.eventId