VectorIndexRetriever
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:434
Extends
BaseRetriever
Constructors
Constructor
new VectorIndexRetriever(
options
):VectorIndexRetriever
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:441
Parameters
options
Returns
VectorIndexRetriever
Overrides
BaseRetriever.constructor
Properties
index
index:
VectorStoreIndex
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:435
topK
topK:
TopKMap
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:436
filters?
optional
filters:MetadataFilters
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:438
queryMode?
optional
queryMode:VectorStoreQueryMode
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:439
customParams?
optional
customParams:unknown
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:440
Accessors
similarityTopK
Set Signature
set similarityTopK(
similarityTopK
):void
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:464
@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: packages/llamaindex/src/indices/vectorStore/index.ts:468
Parameters
params
QueryBundle
Returns
Promise
<NodeWithScore
<Metadata
>[]>
Overrides
BaseRetriever._retrieve
retrieveQuery()
protected
retrieveQuery(query
,type
,vectorStore
,filters?
,customParams?
):Promise
<NodeWithScore
<Metadata
>[]>
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:482
Parameters
query
MessageContent
type
ModalityType
vectorStore
BaseVectorStore
filters?
MetadataFilters
customParams?
unknown
Returns
Promise
<NodeWithScore
<Metadata
>[]>
buildNodeListFromQueryResult()
protected
buildNodeListFromQueryResult(result
):NodeWithScore
<Metadata
>[]
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:519
Parameters
result
VectorStoreQueryResult
Returns
NodeWithScore
<Metadata
>[]