Interface MultiVectorRetrieverInput

Arguments for the MultiVectorRetriever class.

interface MultiVectorRetrieverInput {
    byteStore?: BaseStore<string, Uint8Array>;
    callbacks?: Callbacks;
    childK?: number;
    docstore?: BaseStoreInterface<string, Document<Record<string, any>>>;
    idKey?: string;
    metadata?: Record<string, unknown>;
    parentK?: number;
    tags?: string[];
    vectorstore: VectorStoreInterface;
    verbose?: boolean;
}

Hierarchy

  • BaseRetrieverInput
    • MultiVectorRetrieverInput

Properties

byteStore? callbacks? childK? docstore? idKey? metadata? parentK? tags? vectorstore verbose?

Properties

OptionalbyteStore

byteStore?: BaseStore<string, Uint8Array>

Optionalcallbacks

callbacks?: Callbacks

OptionalchildK

childK?: number

Optionaldocstore

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

Deprecated

Prefer byteStore.

OptionalidKey

idKey?: string

Optionalmetadata

metadata?: Record<string, unknown>

OptionalparentK

parentK?: number

Optionaltags

tags?: string[]

vectorstore

vectorstore: VectorStoreInterface

Optionalverbose

verbose?: boolean

Settings

Member Visibility

On This Page

Properties