RealtimeServerEventConversationItemTruncated interface

Package:

@azure/ai-projects

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

RealtimeServerEvent

Properties

audio_end_ms	The duration up to which the audio was truncated, in milliseconds.
content_index	The index of the content part that was truncated.
event_id	The unique ID of the server event.
item	The assistant message after truncation, when the service returns the updated item.
item_id	The ID of the assistant message item that was truncated.
type	The event type, must be conversation.item.truncated.

Property Details

audio_end_ms

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

audio_end_ms: number

Property Value

number

content_index

The index of the content part that was truncated.

content_index: number

Property Value

number

event_id

The unique ID of the server event.

event_id: string

Property Value

string

item

The assistant message after truncation, when the service returns the updated item.

item?: RealtimeConversationItemUnion

Property Value

RealtimeConversationItemUnion

item_id

The ID of the assistant message item that was truncated.

item_id: string

Property Value

string

type

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

type: "conversation.item.truncated"

Property Value

"conversation.item.truncated"