VectorStoreIndex
Defined in: packages/core/src/indices/vectorStore/index.ts:61
The VectorStoreIndex, an index that stores the nodes only according to their vector embeddings.
Extends
Section titled “Extends”Properties
Section titled “Properties”vectorStores
Section titled “vectorStores”vectorStores:
VectorStoreByType
Defined in: packages/core/src/indices/BaseIndex.ts:17
Inherited from
Section titled “Inherited from”embedModel?
Section titled “embedModel?”
optionalembedModel:BaseEmbedding
Defined in: packages/core/src/indices/vectorStore/index.ts:63
@deprecated: use embedFunc instead
Methods
Section titled “Methods”insert()
Section titled “insert()”insert(
document):Promise<void>
Defined in: packages/core/src/indices/BaseIndex.ts:34
Insert a document into the index.
Parameters
Section titled “Parameters”document
Section titled “document”Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”retriever()
Section titled “retriever()”retriever(
options?):BaseRetriever
Defined in: packages/core/src/indices/BaseIndex.ts:57
Alias for asRetriever
Parameters
Section titled “Parameters”options?
Section titled “options?”any
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”init()
Section titled “init()”
staticinit(options):Promise<VectorStoreIndex>
Defined in: packages/core/src/indices/vectorStore/index.ts:79
The async init function creates a new VectorStoreIndex.
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<VectorStoreIndex>
getNodeEmbeddingResults()
Section titled “getNodeEmbeddingResults()”getNodeEmbeddingResults(
nodes,options?):Promise<BaseNode<Metadata>[]>
Defined in: packages/core/src/indices/vectorStore/index.ts:113
Calculates the embeddings for the given nodes.
Parameters
Section titled “Parameters”An array of BaseNode objects representing the nodes for which embeddings are to be calculated.
options?
Section titled “options?”An optional object containing additional parameters.
logProgress?
Section titled “logProgress?”boolean
A boolean indicating whether to log progress to the console (useful for debugging).
progressCallback?
Section titled “progressCallback?”(progress, total) => void
Returns
Section titled “Returns”buildIndexFromNodes()
Section titled “buildIndexFromNodes()”buildIndexFromNodes(
nodes,options?):Promise<void>
Defined in: packages/core/src/indices/vectorStore/index.ts:142
Get embeddings for nodes and place them into the index.
Parameters
Section titled “Parameters”options?
Section titled “options?”logProgress?
Section titled “logProgress?”boolean
progressCallback?
Section titled “progressCallback?”(progress, total) => void
Returns
Section titled “Returns”Promise<void>
fromDocuments()
Section titled “fromDocuments()”
staticfromDocuments(documents,args):Promise<VectorStoreIndex>
Defined in: packages/core/src/indices/vectorStore/index.ts:160
High level API: split documents, get embeddings, and build index.
Parameters
Section titled “Parameters”documents
Section titled “documents”VectorIndexOptions & object = {}
Returns
Section titled “Returns”Promise<VectorStoreIndex>
fromVectorStores()
Section titled “fromVectorStores()”
staticfromVectorStores(vectorStores):Promise<VectorStoreIndex>
Defined in: packages/core/src/indices/vectorStore/index.ts:214
Parameters
Section titled “Parameters”vectorStores
Section titled “vectorStores”Returns
Section titled “Returns”Promise<VectorStoreIndex>
fromVectorStore()
Section titled “fromVectorStore()”
staticfromVectorStore(vectorStore):Promise<VectorStoreIndex>
Defined in: packages/core/src/indices/vectorStore/index.ts:229
Parameters
Section titled “Parameters”vectorStore
Section titled “vectorStore”Returns
Section titled “Returns”Promise<VectorStoreIndex>
asRetriever()
Section titled “asRetriever()”asRetriever(
options?):VectorIndexRetriever
Defined in: packages/core/src/indices/vectorStore/index.ts:235
Create a new retriever from the index.
Parameters
Section titled “Parameters”options?
Section titled “options?”Omit<object & object, "index"> | Omit<object & object, "index">
Returns
Section titled “Returns”Overrides
Section titled “Overrides”insertNodes()
Section titled “insertNodes()”insertNodes(
nodes,options?):Promise<void>
Defined in: packages/core/src/indices/vectorStore/index.ts:241
Parameters
Section titled “Parameters”options?
Section titled “options?”logProgress?
Section titled “logProgress?”boolean
progressCallback?
Section titled “progressCallback?”(progress, total) => void
docStoreStrategy?
Section titled “docStoreStrategy?”Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”deleteRefDoc()
Section titled “deleteRefDoc()”deleteRefDoc(
refDocId):Promise<void>
Defined in: packages/core/src/indices/vectorStore/index.ts:262
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”deleteRefDocFromStore()
Section titled “deleteRefDocFromStore()”
protecteddeleteRefDocFromStore(vectorStore,refDocId):Promise<void>
Defined in: packages/core/src/indices/vectorStore/index.ts:268
Parameters
Section titled “Parameters”vectorStore
Section titled “vectorStore”refDocId
Section titled “refDocId”string
Returns
Section titled “Returns”Promise<void>