Type Alias FileCitation

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

A file citation annotation.

Type declaration

  • Optionalcustom_metadata?: { [k: string]: any }

    User provided metadata about the retrieved context.

  • Optionaldocument_uri?: string

    The URI of the file.

  • Optionalend_index?: number

    End of the attributed segment, exclusive.

  • Optionalfile_name?: string

    The name of the file.

  • Optionalmedia_id?: string

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

  • Optionalpage_number?: number

    Page number of the cited document, if applicable.

  • Optionalsource?: string

    Source attributed for a portion of the text.

  • Optionalstart_index?: number

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

    Remarks

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

  • type: "file_citation"

Settings