Class: VectorIndexRetriever

Retrievers retrieve the nodes that most closely match our query in similarity.

Implements

• BaseRetriever

Constructors

constructor

• new VectorIndexRetriever(«destructured»): VectorIndexRetriever

Parameters

Name	Type
«destructured»	VectorIndexRetrieverOptions

Returns

VectorIndexRetriever

Defined in

packages/core/src/indices/vectorStore/index.ts:392

Properties

imageSimilarityTopK

• imageSimilarityTopK: number

Defined in

packages/core/src/indices/vectorStore/index.ts:388

---

index

• index: VectorStoreIndex

Defined in

packages/core/src/indices/vectorStore/index.ts:386

---

serviceContext

• Optional serviceContext: ServiceContext

Implementation of

BaseRetriever.serviceContext

Defined in

packages/core/src/indices/vectorStore/index.ts:390

---

similarityTopK

• similarityTopK: number

Defined in

packages/core/src/indices/vectorStore/index.ts:387

Methods

buildNodeListFromQueryResult

▸ buildNodeListFromQueryResult(result): NodeWithScore<Metadata>[]

Parameters

Name	Type
result	VectorStoreQueryResult

Returns

NodeWithScore<Metadata>[]

Defined in

packages/core/src/indices/vectorStore/index.ts:478

---

buildVectorStoreQuery

▸ buildVectorStoreQuery(embedModel, query, similarityTopK, preFilters?): Promise<VectorStoreQuery>

Parameters

Name	Type
embedModel	BaseEmbedding
query	string
similarityTopK	number
preFilters?	MetadataFilters

Returns

Promise<VectorStoreQuery>

Defined in

packages/core/src/indices/vectorStore/index.ts:462

---

retrieve

▸ retrieve(«destructured»): Promise<NodeWithScore<Metadata>[]>

Parameters

Name	Type
«destructured»	RetrieveParams

Returns

Promise<NodeWithScore<Metadata>[]>

Implementation of

BaseRetriever.retrieve

Defined in

packages/core/src/indices/vectorStore/index.ts:403

---

sendEvent

▸ sendEvent(query, nodesWithScores): void

Parameters

Name	Type
query	string
nodesWithScores	NodeWithScore<Metadata>[]

Returns

void

Defined in

packages/core/src/indices/vectorStore/index.ts:452

---

textRetrieve

▸ textRetrieve(query, preFilters?): Promise<NodeWithScore<Metadata>[]>

Parameters

Name	Type
query	string
preFilters?	MetadataFilters

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

packages/core/src/indices/vectorStore/index.ts:418

---

textToImageRetrieve

▸ textToImageRetrieve(query, preFilters?): Promise<NodeWithScore<Metadata>[]>

Parameters

Name	Type
query	string
preFilters?	MetadataFilters

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

packages/core/src/indices/vectorStore/index.ts:433