VectorIndexRetriever

Defined in: llamaindex/src/indices/vectorStore/index.ts:418

Extends

• BaseRetriever

Constructors

new VectorIndexRetriever()

new VectorIndexRetriever(options): VectorIndexRetriever

Defined in: llamaindex/src/indices/vectorStore/index.ts:425

Parameters

options

VectorIndexRetrieverOptions

Returns

VectorIndexRetriever

Overrides

BaseRetriever.constructor

Properties

index

index: VectorStoreIndex

Defined in: llamaindex/src/indices/vectorStore/index.ts:419

---

topK

topK: TopKMap

Defined in: llamaindex/src/indices/vectorStore/index.ts:420

---

filters?

optional filters: MetadataFilters

Defined in: llamaindex/src/indices/vectorStore/index.ts:422

---

queryMode?

optional queryMode: VectorStoreQueryMode

Defined in: llamaindex/src/indices/vectorStore/index.ts:423

Accessors

similarityTopK

Set Signature

set similarityTopK(similarityTopK): void

Defined in: llamaindex/src/indices/vectorStore/index.ts:446

@deprecated, pass similarityTopK or topK in constructor instead or directly modify topK

Parameters

similarityTopK

number

Returns

void

Methods

_retrieve()

_retrieve(params): Promise<NodeWithScore<Metadata>[]>

Defined in: llamaindex/src/indices/vectorStore/index.ts:450

Parameters

params

QueryBundle

Returns

Promise<NodeWithScore<Metadata>[]>

Overrides

BaseRetriever._retrieve

---

retrieveQuery()

protected retrieveQuery(query, type, vectorStore, filters?): Promise<NodeWithScore<Metadata>[]>

Defined in: llamaindex/src/indices/vectorStore/index.ts:464

Parameters

query

MessageContent

type

ModalityType

vectorStore

BaseVectorStore<unknown>

filters?

MetadataFilters

Returns

Promise<NodeWithScore<Metadata>[]>

---

buildNodeListFromQueryResult()

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

Defined in: llamaindex/src/indices/vectorStore/index.ts:499

Parameters

result

VectorStoreQueryResult

Returns

NodeWithScore<Metadata>[]