VectorIndexRetriever
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:452
Extends
Section titled “Extends”BaseRetriever
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VectorIndexRetriever(
options):VectorIndexRetriever
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:459
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”VectorIndexRetriever
Overrides
Section titled “Overrides”BaseRetriever.constructor
Properties
Section titled “Properties”index:
VectorStoreIndex
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:453
topK:
TopKMap
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:454
filters?
Section titled “filters?”
optionalfilters:MetadataFilters
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:456
queryMode?
Section titled “queryMode?”
optionalqueryMode:VectorStoreQueryMode
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:457
customParams?
Section titled “customParams?”
optionalcustomParams:unknown
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:458
Accessors
Section titled “Accessors”similarityTopK
Section titled “similarityTopK”Set Signature
Section titled “Set Signature”set similarityTopK(
similarityTopK):void
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:482
@deprecated, pass similarityTopK or topK in constructor instead or directly modify topK
Parameters
Section titled “Parameters”similarityTopK
Section titled “similarityTopK”number
Returns
Section titled “Returns”void
Methods
Section titled “Methods”_retrieve()
Section titled “_retrieve()”_retrieve(
params):Promise<NodeWithScore<Metadata>[]>
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:486
Parameters
Section titled “Parameters”params
Section titled “params”QueryBundle
Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
Overrides
Section titled “Overrides”BaseRetriever._retrieve
retrieveQuery()
Section titled “retrieveQuery()”
protectedretrieveQuery(query,type,vectorStore,filters?,customParams?):Promise<NodeWithScore<Metadata>[]>
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:500
Parameters
Section titled “Parameters”MessageContent
ModalityType
vectorStore
Section titled “vectorStore”BaseVectorStore
filters?
Section titled “filters?”MetadataFilters
customParams?
Section titled “customParams?”unknown
Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
buildNodeListFromQueryResult()
Section titled “buildNodeListFromQueryResult()”
protectedbuildNodeListFromQueryResult(result):NodeWithScore<Metadata>[]
Defined in: .build/typescript/packages/llamaindex/src/indices/vectorStore/index.ts:537
Parameters
Section titled “Parameters”result
Section titled “result”VectorStoreQueryResult
Returns
Section titled “Returns”NodeWithScore<Metadata>[]