Interface FileCitationAnnotation

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 FileCitationAnnotation {
    end_index: number;
    file_citation: OpenAIClient.Beta.Threads.Messages.FileCitationAnnotation.FileCitation;
    start_index: number;
    text: string;
    type: "file_citation";
}

Properties

end_index file_citation start_index text type

Properties

end_index

end_index: number

file_citation

file_citation: OpenAIClient.Beta.Threads.Messages.FileCitationAnnotation.FileCitation

start_index

start_index: number

text

text: string

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

type

type: "file_citation"

Always file_citation.

Settings

Member Visibility

On This Page

Properties