Interface CitationChunk

Describes a chunk containing citation information for a message.

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

Hierarchy (View Summary)

Properties

citation id model type

Properties

citation

citation: {
    position: number;
    references: {
        file?: AssistantFileModel;
        highlight?: null | HighlightModel;
        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?: null | HighlightModel;
        pages?: number[];
    }[]

    An array of references associated with the citation.

id

id: string

The unique identifier for the streaming response.

model

model: string

The model used to generate the response.

type

type: "citation"

The type of the chunk indicating a citation.

Settings

Member Visibility

On This Page

Properties