Class: BaseIndex<T>
Indexes are the data structure that we store our nodes and embeddings in so they can be retrieved for our queries.
Type parameters
| Name |
|---|
T |
Hierarchy
-
BaseIndex
Constructors
constructor
• new BaseIndex<T>(init): BaseIndex<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
init | BaseIndexInit<T> |
Returns
BaseIndex<T>
Defined in
packages/core/src/indices/BaseIndex.ts:162
Properties
docStore
• docStore: BaseDocumentStore
Defined in
packages/core/src/indices/BaseIndex.ts:157
indexStore
• Optional indexStore: BaseIndexStore
Defined in
packages/core/src/indices/BaseIndex.ts:159
indexStruct
• indexStruct: T
Defined in
packages/core/src/indices/BaseIndex.ts:160
serviceContext
• serviceContext: ServiceContext
Defined in
packages/core/src/indices/BaseIndex.ts:155
storageContext
• storageContext: StorageContext
Defined in
packages/core/src/indices/BaseIndex.ts:156
vectorStore
• Optional vectorStore: VectorStore
Defined in
packages/core/src/indices/BaseIndex.ts:158
Methods
asQueryEngine
▸ asQueryEngine(options?): BaseQueryEngine
Create a new query engine from the index. It will also create a retriever and response synthezier if they are not provided.
Parameters
| Name | Type | Description |
|---|---|---|
options? | Object | you can supply your own custom Retriever and ResponseSynthesizer |
options.responseSynthesizer? | BaseSynthesizer | - |
options.retriever? | BaseRetriever | - |
Returns
BaseQueryEngine
Defined in
packages/core/src/indices/BaseIndex.ts:182
asRetriever
▸ asRetriever(options?): BaseRetriever
Create a new retriever from the index.
Parameters
| Name | Type |
|---|---|
options? | any |
Returns
Defined in
packages/core/src/indices/BaseIndex.ts:175
deleteRefDoc
▸ deleteRefDoc(refDocId, deleteFromDocStore?): Promise<void>
Parameters
| Name | Type |
|---|---|
refDocId | string |
deleteFromDocStore? | boolean |
Returns
Promise<void>
Defined in
packages/core/src/indices/BaseIndex.ts:201
insert
▸ insert(document): Promise<void>
Insert a document into the index.
Parameters
| Name | Type |
|---|---|
document | Document<Metadata> |
Returns
Promise<void>
Defined in
packages/core/src/indices/BaseIndex.ts:191
insertNodes
▸ insertNodes(nodes): Promise<void>
Parameters
| Name | Type |
|---|---|
nodes | BaseNode<Metadata>[] |
Returns
Promise<void>