Interface FileCitation

A file citation annotation.

interface FileCitation {
    custom_metadata?: { [key: string]: unknown };
    document_uri?: string;
    end_index?: number;
    file_name?: string;
    media_id?: string;
    page_number?: number;
    source?: string;
    start_index?: number;
    type: "file_citation";
}

Properties

custom_metadata? document_uri? end_index? file_name? media_id? page_number? source? start_index? type

Properties

Optionalcustom_metadata

custom_metadata?: { [key: string]: unknown }

User provided metadata about the retrieved context.

Optionaldocument_uri

document_uri?: string

The URI of the file.

Optionalend_index

end_index?: number

End of the attributed segment, exclusive.

Optionalfile_name

file_name?: string

The name of the file.

Optionalmedia_id

media_id?: string

Media ID in-case of image citations, if applicable.

Optionalpage_number

page_number?: number

Page number of the cited document, if applicable.

Optionalsource

source?: string

Source attributed for a portion of the text.

Optionalstart_index

start_index?: number

Start of segment of the response that is attributed to this source.

Index indicates the start of the segment, measured in bytes.

type

type: "file_citation"

Settings

On This Page

Properties