Interface FileCitationDeltaAnnotation

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the "file_search" tool to search files.

interface FileCitationDeltaAnnotation {
    index: number;
    type: "file_citation";
    end_index?: number;
    file_citation?: OpenAIClient.Beta.Threads.Messages.FileCitationDeltaAnnotation.FileCitation;
    start_index?: number;
    text?: string;
}

Properties

index type end_index? file_citation? start_index? text?

Properties

index

index: number

The index of the annotation in the text content part.

type

type: "file_citation"

Always file_citation.

Optionalend_index

end_index?: number

Optionalfile_citation

file_citation?: OpenAIClient.Beta.Threads.Messages.FileCitationDeltaAnnotation.FileCitation

Optionalstart_index

start_index?: number

Optionaltext

text?: string

The text in the message content that needs to be replaced.

Settings

Member Visibility

On This Page

Properties