Class: KeywordTableIndex

The KeywordTableIndex, an index that extracts keywords from each Node and builds a mapping from each keyword to the corresponding Nodes of that keyword.

Hierarchy

• BaseIndex<KeywordTable>

  ↳ KeywordTableIndex

Constructors

constructor

• new KeywordTableIndex(init): KeywordTableIndex

Parameters

Name	Type
init	BaseIndexInit<KeywordTable>

Returns

KeywordTableIndex

Overrides

BaseIndex.constructor

Defined in

packages/core/src/indices/keyword/index.ts:158

Properties

docStore

• docStore: BaseDocumentStore

Inherited from

BaseIndex.docStore

Defined in

packages/core/src/indices/BaseIndex.ts:62

---

indexStore

• Optional indexStore: BaseIndexStore

Inherited from

BaseIndex.indexStore

Defined in

packages/core/src/indices/BaseIndex.ts:64

---

indexStruct

• indexStruct: KeywordTable

Inherited from

BaseIndex.indexStruct

Defined in

packages/core/src/indices/BaseIndex.ts:65

---

serviceContext

• Optional serviceContext: ServiceContext

Inherited from

BaseIndex.serviceContext

Defined in

packages/core/src/indices/BaseIndex.ts:60

---

storageContext

• storageContext: StorageContext

Inherited from

BaseIndex.storageContext

Defined in

packages/core/src/indices/BaseIndex.ts:61

---

vectorStore

• Optional vectorStore: VectorStore

Inherited from

BaseIndex.vectorStore

Defined in

packages/core/src/indices/BaseIndex.ts:63

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.nodePostprocessors?	BaseNodePostprocessor[]	-
options.preFilters?	unknown	-
options.responseSynthesizer?	BaseSynthesizer	-
options.retriever?	BaseRetriever	-

Returns

BaseQueryEngine

Overrides

BaseIndex.asQueryEngine

Defined in

packages/core/src/indices/keyword/index.ts:238

---

asRetriever

▸ asRetriever(options?): BaseRetriever

Create a new retriever from the index.

Parameters

Name	Type
options?	any

Returns

BaseRetriever

Overrides

BaseIndex.asRetriever

Defined in

packages/core/src/indices/keyword/index.ts:227

---

deleteNode

▸ deleteNode(nodeId): void

Parameters

Name	Type
nodeId	string

Returns

void

Defined in

packages/core/src/indices/keyword/index.ts:335

---

deleteNodes

▸ deleteNodes(nodeIds, deleteFromDocStore): Promise<void>

Parameters

Name	Type
nodeIds	string[]
deleteFromDocStore	boolean

Returns

Promise<void>

Defined in

packages/core/src/indices/keyword/index.ts:353

---

deleteRefDoc

▸ deleteRefDoc(refDocId, deleteFromDocStore?): Promise<void>

Parameters

Name	Type
refDocId	string
deleteFromDocStore?	boolean

Returns

Promise<void>

Overrides

BaseIndex.deleteRefDoc

Defined in

packages/core/src/indices/keyword/index.ts:367

---

insert

▸ insert(document): Promise<void>

Insert a document into the index.

Parameters

Name	Type
document	Document<Metadata>

Returns

Promise<void>

Inherited from

BaseIndex.insert

Defined in

packages/core/src/indices/BaseIndex.ts:96

---

insertNodes

▸ insertNodes(nodes): Promise<void>

Parameters

Name	Type
nodes	BaseNode<Metadata>[]

Returns

Promise<void>

Overrides

BaseIndex.insertNodes

Defined in

packages/core/src/indices/keyword/index.ts:325

---

buildIndexFromNodes

▸ buildIndexFromNodes(nodes, docStore, serviceContext?): Promise<KeywordTable>

Get keywords for nodes and place them into the index.

Parameters

Name	Type
nodes	BaseNode<Metadata>[]
docStore	BaseDocumentStore
serviceContext?	ServiceContext

Returns

Promise<KeywordTable>

Defined in

packages/core/src/indices/keyword/index.ts:308

---

extractKeywords

▸ extractKeywords(text, serviceContext?): Promise<Set<string>>

Parameters

Name	Type
text	string
serviceContext?	ServiceContext

Returns

Promise<Set<string>>

Defined in

packages/core/src/indices/keyword/index.ts:253

---

fromDocuments

▸ fromDocuments(documents, args?): Promise<KeywordTableIndex>

High level API: split documents, get keywords, and build index.

Parameters

Name	Type
documents	Document<Metadata>[]
args	Object
args.serviceContext?	ServiceContext
args.storageContext?	StorageContext

Returns

Promise<KeywordTableIndex>

Defined in

packages/core/src/indices/keyword/index.ts:275

---

init

▸ init(options): Promise<KeywordTableIndex>

Parameters

Name	Type
options	KeywordIndexOptions

Returns

Promise<KeywordTableIndex>

Defined in

packages/core/src/indices/keyword/index.ts:162