Interface ResponseTextDoneEvent

Returned when the text value of a "text" content part is done streaming. Also emitted when a Response is interrupted, incomplete, or cancelled.

interface ResponseTextDoneEvent {
    content_index: number;
    event_id: string;
    item_id: string;
    output_index: number;
    response_id: string;
    text: string;
    type: "response.text.done";
}

Properties

content_index event_id item_id output_index response_id text type

Properties

content_index

content_index: number

The index of the content part in the item's content array.

event_id

event_id: string

The unique ID of the server event.

item_id

item_id: string

The ID of the item.

output_index

output_index: number

The index of the output item in the response.

response_id

response_id: string

The ID of the response.

text

text: string

The final text content.

type

type: "response.text.done"

The event type, must be response.text.done.

Settings

Member Visibility

On This Page

Properties