Interface ResponseOutputTextAnnotationAddedEvent

Emitted when an annotation is added to output text content.

interface ResponseOutputTextAnnotationAddedEvent {
    annotation: unknown;
    annotation_index: number;
    content_index: number;
    item_id: string;
    output_index: number;
    sequence_number: number;
    type: "response.output_text_annotation.added";
}

Properties

annotation: unknown

The annotation object being added. (See annotation schema for details.)

annotation_index: number

The index of the annotation within the content part.

content_index: number

The index of the content part within the output item.

item_id: string

The unique identifier of the item to which the annotation is being added.

output_index: number

The index of the output item in the response's output array.

sequence_number: number

The sequence number of this event.

type: "response.output_text_annotation.added"

The type of the event. Always 'response.output_text_annotation.added'.