Class: VectorStoreRetriever

vectorstores/base.VectorStoreRetriever

Base Index class. All indexes should extend this class.

Hierarchy

• BaseRetriever

  ↳ VectorStoreRetriever

Constructors

constructor

• new VectorStoreRetriever(fields)

Parameters

Name	Type
fields	Object
fields.k?	number
fields.vectorStore	VectorStore

Overrides

BaseRetriever.constructor

Defined in

langchain/src/vectorstores/base.ts:10

Properties

k

• k: number = 4

Defined in

langchain/src/vectorstores/base.ts:8

---

vectorStore

• vectorStore: VectorStore

Defined in

langchain/src/vectorstores/base.ts:6

Methods

getRelevantDocuments

▸ getRelevantDocuments(query): Promise<Document<Record<string, any>>[]>

Parameters

Name	Type
query	string

Returns

Promise<Document<Record<string, any>>[]>

Overrides

BaseRetriever.getRelevantDocuments

Defined in

langchain/src/vectorstores/base.ts:16