VectorIndexRetriever
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:452
Extends
BaseRetriever
Constructors
Constructor
new VectorIndexRetriever(
options):VectorIndexRetriever
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:459
Parameters
options
Returns
VectorIndexRetriever
Overrides
BaseRetriever.constructor
Properties
index
index:
VectorStoreIndex
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:453
topK
topK:
TopKMap
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:454
filters?
optionalfilters:MetadataFilters
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:456
queryMode?
optionalqueryMode:VectorStoreQueryMode
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:457
customParams?
optionalcustomParams:unknown
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:458
Accessors
similarityTopK
Set Signature
set similarityTopK(
similarityTopK):void
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:482
@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:486
Parameters
params
QueryBundle
Returns
Promise<NodeWithScore<Metadata>[]>
Overrides
BaseRetriever._retrieve
retrieveQuery()
protectedretrieveQuery(query,type,vectorStore,filters?,customParams?):Promise<NodeWithScore<Metadata>[]>
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:500
Parameters
query
MessageContent
type
ModalityType
vectorStore
BaseVectorStore
filters?
MetadataFilters
customParams?
unknown
Returns
Promise<NodeWithScore<Metadata>[]>
buildNodeListFromQueryResult()
protectedbuildNodeListFromQueryResult(result):NodeWithScore<Metadata>[]
Defined in: packages/llamaindex/src/indices/vectorStore/index.ts:537
Parameters
result
VectorStoreQueryResult
Returns
NodeWithScore<Metadata>[]