Interface VectorStoreRetrieverMemoryParams

Interface for the parameters required to initialize a VectorStoreRetrieverMemory instance.

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

Implemented by

Properties

inputKey? memoryKey? metadata? outputKey? returnDocs? vectorStoreRetriever

Properties

OptionalinputKey

inputKey?: string

OptionalmemoryKey

memoryKey?: string

Optionalmetadata

metadata?: Metadata | MetadataFunction

Metadata to be added to the document when saving context.

OptionaloutputKey

outputKey?: string

OptionalreturnDocs

returnDocs?: boolean

vectorStoreRetriever

vectorStoreRetriever: VectorStoreRetrieverInterface<VectorStoreInterface>

Settings

Member Visibility

On This Page

Properties