Pinecone TypeScript SDK - v8.2.0
    Preparing search index...

    Interface CitationChunk

    Describes a chunk containing citation information for a message.

    interface CitationChunk {
        citation: {
            position: number;
            references: {
                file?: AssistantFileModel;
                highlight?: HighlightModel | null;
                pages?: number[];
            }[];
        };
        id: string;
        model: string;
        type: "citation";
    }

    Hierarchy (View Summary)

    Index
    citation id model type
    citation: {
        position: number;
        references: {
            file?: AssistantFileModel;
            highlight?: HighlightModel | null;
            pages?: number[];
        }[];
    }

    The citation details, including the position and references.

    Type Declaration

    • position: number

      The position of the citation within the message content.

    • references: {
          file?: AssistantFileModel;
          highlight?: HighlightModel | null;
          pages?: number[];
      }[]

      An array of references associated with the citation.

    id: string

    The unique identifier for the streaming response.

    model: string

    The model used to generate the response.

    type: "citation"

    The type of the chunk indicating a citation.

    Settings
    Member Visibility

    On This Page
    Properties