Interface MultiVectorRetrieverInput

Arguments for the MultiVectorRetriever class.

interface MultiVectorRetrieverInput {
    vectorstore: VectorStoreInterface;
    byteStore?: BaseStore<string, Uint8Array>;
    childK?: number;
    docstore?: BaseStoreInterface<string, Document<Record<string, any>>>;
    idKey?: string;
    parentK?: number;
}

Hierarchy

  • BaseRetrieverInput
    • MultiVectorRetrieverInput

Properties

vectorstore byteStore? childK? docstore? idKey? parentK?

Properties

vectorstore

vectorstore: VectorStoreInterface

Optional byteStore

byteStore?: BaseStore<string, Uint8Array>

Optional childK

childK?: number

Optional docstore

docstore?: BaseStoreInterface<string, Document<Record<string, any>>>

⚠️ Deprecated ⚠️

Prefer byteStore.

This feature is deprecated and will be removed in the future.

It is not recommended for use.

Optional idKey

idKey?: string

Optional parentK

parentK?: number

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc