Class: VectorIndexRetriever
Retrievers retrieve the nodes that most closely match our query in similarity.
Implements
Constructors
constructor
• new VectorIndexRetriever(«destructured»
): VectorIndexRetriever
Parameters
Name | Type |
---|---|
«destructured» | VectorIndexRetrieverOptions |
Returns
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
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
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