Interface VectorStoreRetrieverMemoryParams

Interface for the parameters required to initialize a VectorStoreRetrieverMemory instance.

interface VectorStoreRetrieverMemoryParams {
    vectorStoreRetriever: VectorStoreRetrieverInterface<VectorStoreInterface>;
    inputKey?: string;
    memoryKey?: string;
    metadata?: Metadata | MetadataFunction;
    outputKey?: string;
    returnDocs?: boolean;
}

Implemented by

Properties

vectorStoreRetriever inputKey? memoryKey? metadata? outputKey? returnDocs?

Properties

vectorStoreRetriever

vectorStoreRetriever: VectorStoreRetrieverInterface<VectorStoreInterface>

Optional inputKey

inputKey?: string

Optional memoryKey

memoryKey?: string

Optional metadata

metadata?: Metadata | MetadataFunction

Metadata to be added to the document when saving context.

Optional outputKey

outputKey?: string

Optional returnDocs

returnDocs?: boolean

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc