Interface AugmentWithContextOptions

Options for the augmentWithContext middleware.

interface AugmentWithContextOptions {
    citationKey?: string | null;
    itemTemplate?: (d: Document, options?: AugmentWithContextOptions) => string;
    preface?: string | null;
}

Properties

citationKey?: string | null

The metadata key to use for citation reference. Pass null to provide no citations.

itemTemplate?: (d: Document, options?: AugmentWithContextOptions) => string

A function to render a document into a text part to be included in the message.

preface?: string | null

Preceding text to place before the rendered context documents.