Interface ResponseTextAnnotationDeltaEvent

Emitted when a text annotation is added.

interface ResponseTextAnnotationDeltaEvent {
    annotation: OpenAIClient.Responses.ResponseTextAnnotationDeltaEvent.FileCitation | OpenAIClient.Responses.ResponseTextAnnotationDeltaEvent.URLCitation | OpenAIClient.Responses.ResponseTextAnnotationDeltaEvent.FilePath;
    annotation_index: number;
    content_index: number;
    item_id: string;
    output_index: number;
    type: "response.output_text.annotation.added";
}

Index

Properties

annotation annotation_index content_index item_id output_index type

Properties

annotation

annotation: OpenAIClient.Responses.ResponseTextAnnotationDeltaEvent.FileCitation | OpenAIClient.Responses.ResponseTextAnnotationDeltaEvent.URLCitation | OpenAIClient.Responses.ResponseTextAnnotationDeltaEvent.FilePath

A citation to a file.

annotation_index

annotation_index: number

The index of the annotation that was added.

content_index

content_index: number

The index of the content part that the text annotation was added to.

item_id

item_id: string

The ID of the output item that the text annotation was added to.

output_index

output_index: number

The index of the output item that the text annotation was added to.

type

type: "response.output_text.annotation.added"

The type of the event. Always response.output_text.annotation.added.