Skip to main content

Class: VectorIndexRetriever

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

Implements

Constructors

constructor

new VectorIndexRetriever(«destructured»): VectorIndexRetriever

Parameters

NameType
«destructured»VectorIndexRetrieverOptions

Returns

VectorIndexRetriever

Defined in

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

Properties

imageSimilarityTopK

imageSimilarityTopK: number

Defined in

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


index

index: VectorStoreIndex

Defined in

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


serviceContext

Optional serviceContext: ServiceContext

Implementation of

BaseRetriever.serviceContext

Defined in

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


similarityTopK

similarityTopK: number

Defined in

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

Methods

buildNodeListFromQueryResult

buildNodeListFromQueryResult(result): NodeWithScore<Metadata>[]

Parameters

NameType
resultVectorStoreQueryResult

Returns

NodeWithScore<Metadata>[]

Defined in

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


buildVectorStoreQuery

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

Parameters

NameType
embedModelBaseEmbedding
querystring
similarityTopKnumber
preFilters?MetadataFilters

Returns

Promise<VectorStoreQuery>

Defined in

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


retrieve

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

Parameters

NameType
«destructured»RetrieveParams

Returns

Promise<NodeWithScore<Metadata>[]>

Implementation of

BaseRetriever.retrieve

Defined in

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


sendEvent

sendEvent(query, nodesWithScores): void

Parameters

NameType
querystring
nodesWithScoresNodeWithScore<Metadata>[]

Returns

void

Defined in

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


textRetrieve

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

Parameters

NameType
querystring
preFilters?MetadataFilters

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

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


textToImageRetrieve

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

Parameters

NameType
querystring
preFilters?MetadataFilters

Returns

Promise<NodeWithScore<Metadata>[]>

Defined in

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