Class VectorStoreRetriever<V, Metadata>

Class for performing document retrieval from a VectorStore. Can perform similarity search or maximal marginal relevance search.

Type Parameters

V extends VectorStoreInterface<Metadata> = VectorStoreInterface<Metadata>
Metadata extends Record<string, any> = Record<string, any>

Hierarchy

BaseRetriever<Metadata>
- VectorStoreRetriever

Implements

VectorStoreRetrieverInterface<V, Metadata>

Index

Constructors

Properties

k searchType vectorStore filter? searchKwargs?

Methods

addDocuments isRunnable

Constructors

constructor

new VectorStoreRetriever<V, Metadata>(fields): VectorStoreRetriever<V, Metadata>
Type Parameters
- V extends VectorStoreInterface<Metadata> = VectorStoreInterface<Metadata>
- Metadata extends Record<string, any> = Record<string, any>
Parameters
- fields: VectorStoreRetrieverInput<V>
Returns VectorStoreRetriever<V, Metadata>
Overrides BaseRetriever.constructor
- Defined in langchain-core/src/vectorstores.ts:105

Properties

k

k: number = 4

searchType

searchType: string = "similarity"

vectorStore

vectorStore: V

`Optional` filter

filter?: V["FilterType"]

`Optional` searchKwargs

searchKwargs?: VectorStoreRetrieverMMRSearchKwargs

Methods

addDocuments

addDocuments(documents, options?): Promise<void | string[]>
Parameters
- documents: DocumentInterface<Metadata>[]
- Optional options: AddDocumentOptions
Returns Promise<void | string[]>
Implementation of VectorStoreRetrieverInterface.addDocuments
- Defined in langchain-core/src/vectorstores.ts:144

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, RunnableConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, RunnableConfig>
Inherited from BaseRetriever.isRunnable
- Defined in langchain-core/src/runnables/base.ts:879

Generated using TypeDoc