VectorIndexRetriever
Defined in: packages/core/src/indices/vectorStore/index.ts:279
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VectorIndexRetriever(
options):VectorIndexRetriever
Defined in: packages/core/src/indices/vectorStore/index.ts:287
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”VectorIndexRetriever
Overrides
Section titled “Overrides”Properties
Section titled “Properties”index:
VectorStoreIndex
Defined in: packages/core/src/indices/vectorStore/index.ts:280
topK:
object
Defined in: packages/core/src/indices/vectorStore/index.ts:281
text:
number
image:
number
audio:
number
filters?
Section titled “filters?”
optionalfilters:MetadataFilters
Defined in: packages/core/src/indices/vectorStore/index.ts:283
queryMode?
Section titled “queryMode?”
optionalqueryMode:VectorStoreQueryMode
Defined in: packages/core/src/indices/vectorStore/index.ts:284
customParams?
Section titled “customParams?”
optionalcustomParams:unknown
Defined in: packages/core/src/indices/vectorStore/index.ts:285
alpha?
Section titled “alpha?”
optionalalpha:number
Defined in: packages/core/src/indices/vectorStore/index.ts:286
objectMap
Section titled “objectMap”objectMap:
Map<string,unknown>
Defined in: packages/core/src/retriever/index.ts:35
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”similarityTopK
Section titled “similarityTopK”Set Signature
Section titled “Set Signature”set similarityTopK(
similarityTopK):void
Defined in: packages/core/src/indices/vectorStore/index.ts:318
@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: packages/core/src/indices/vectorStore/index.ts:322
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
Overrides
Section titled “Overrides”retrieveQuery()
Section titled “retrieveQuery()”
protectedretrieveQuery(query,type,vectorStore,filters?,customParams?):Promise<NodeWithScore<Metadata>[]>
Defined in: packages/core/src/indices/vectorStore/index.ts:336
Parameters
Section titled “Parameters”vectorStore
Section titled “vectorStore”filters?
Section titled “filters?”customParams?
Section titled “customParams?”unknown
Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
buildNodeListFromQueryResult()
Section titled “buildNodeListFromQueryResult()”
protectedbuildNodeListFromQueryResult(result):NodeWithScore<Metadata>[]
Defined in: packages/core/src/indices/vectorStore/index.ts:380
Parameters
Section titled “Parameters”result
Section titled “result”Returns
Section titled “Returns”retrieve()
Section titled “retrieve()”retrieve(
params):Promise<NodeWithScore<Metadata>[]>
Defined in: packages/core/src/retriever/index.ts:39
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
Inherited from
Section titled “Inherited from”_handleRecursiveRetrieval()
Section titled “_handleRecursiveRetrieval()”_handleRecursiveRetrieval(
params,nodes):Promise<NodeWithScore<Metadata>[]>
Defined in: packages/core/src/retriever/index.ts:56
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
Inherited from
Section titled “Inherited from”BaseRetriever._handleRecursiveRetrieval
_retrieveFromObject()
Section titled “_retrieveFromObject()”_retrieveFromObject(
object,queryBundle,score):NodeWithScore<Metadata>[]
Defined in: packages/core/src/retriever/index.ts:79
Parameters
Section titled “Parameters”object
Section titled “object”unknown
queryBundle
Section titled “queryBundle”number