Interface ConversationItemTruncatedEvent

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.

interface ConversationItemTruncatedEvent {
    audio_end_ms: number;
    content_index: number;
    event_id: string;
    item_id: string;
    type: "conversation.item.truncated";
}

Properties

audio_end_ms content_index event_id item_id type

Properties

audio_end_ms

audio_end_ms: number

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

content_index

content_index: number

The index of the content part that was truncated.

event_id

event_id: string

The unique ID of the server event.

item_id

item_id: string

The ID of the assistant message item that was truncated.

type

type: "conversation.item.truncated"

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

Settings

Member Visibility

On This Page

Properties