BaseIndex
Defined in: packages/core/src/indices/BaseIndex.ts:18
Indexes are the data structure that we store our nodes and embeddings in so they can be retrieved for our queries.
Extended by
Section titled “Extended by”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new BaseIndex(
init):BaseIndex
Defined in: packages/core/src/indices/BaseIndex.ts:22
Parameters
Section titled “Parameters”Returns
Section titled “Returns”BaseIndex
Properties
Section titled “Properties”vectorStores
Section titled “vectorStores”vectorStores:
VectorStoreByType
Defined in: packages/core/src/indices/BaseIndex.ts:19
embeddings
Section titled “embeddings”embeddings:
EmbeddingsByType
Defined in: packages/core/src/indices/BaseIndex.ts:20
Methods
Section titled “Methods”asRetriever()
Section titled “asRetriever()”
abstractasRetriever(options?):BaseRetriever
Defined in: packages/core/src/indices/BaseIndex.ts:32
Create a new retriever from the index.
Parameters
Section titled “Parameters”options?
Section titled “options?”any
Returns
Section titled “Returns”insert()
Section titled “insert()”insert(
document):Promise<void>
Defined in: packages/core/src/indices/BaseIndex.ts:38
Insert a document into the index.
Parameters
Section titled “Parameters”document
Section titled “document”Returns
Section titled “Returns”Promise<void>
insertNodes()
Section titled “insertNodes()”
abstractinsertNodes(nodes):Promise<void>
Defined in: packages/core/src/indices/BaseIndex.ts:53
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
deleteRefDoc()
Section titled “deleteRefDoc()”
abstractdeleteRefDoc(refDocId):Promise<void>
Defined in: packages/core/src/indices/BaseIndex.ts:54
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
Returns
Section titled “Returns”Promise<void>
retriever()
Section titled “retriever()”retriever(
options?):BaseRetriever
Defined in: packages/core/src/indices/BaseIndex.ts:61
Alias for asRetriever
Parameters
Section titled “Parameters”options?
Section titled “options?”any