Interface●Since v1.0

VectorStoreRetrieverInterface

Interface for a retriever that uses a vector store to store and retrieve document embeddings. This retriever interface allows for adding documents to the underlying vector store and conducting retrieval operations.

VectorStoreRetrieverInterface extends BaseRetrieverInterface to provide document retrieval capabilities based on vector similarity.

interface VectorStoreRetrieverInterface

Bases

BaseRetrieverInterface

Properties

property

lc_serializable: boolean

property

vectorStore: V

The instance of VectorStore used for storing and retrieving document embeddings. This vector store must implement the VectorStoreInterface to be compatible with the retriever’s operations.

property

lc_id: string[]

Methods

method

addDocuments→ Promise<void>

Method to add documents to the memory vector store. It extracts the text from each document, generates embeddings for them, and adds the resulting vectors to the store.

method

batch→ Promise<RunOutput[]>

Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.

method

getName→ string

method

invoke→ Promise<RunOutput>

Method to invoke the document transformation. This method calls the transformDocuments method with the provided input.

method

stream→ Promise<IterableReadableStream<RunOutput>>

Stream output in chunks.

method

transform→ AsyncGenerator<RunOutput>

Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.