Interface AugmentWithContextOptions

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

Index

Properties

citationKey? itemTemplate? preface?

Properties

`Optional`citationKey

citationKey?: null | string

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

`Optional`itemTemplate

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

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

`Optional`preface

preface?: null | string

Preceding text to place before the rendered context documents.