KeywordTableIndex
Defined in: llamaindex/src/indices/keyword/index.ts:164
The KeywordTableIndex, an index that extracts keywords from each Node and builds a mapping from each keyword to the corresponding Nodes of that keyword.
Extends
BaseIndex<KeywordTable>
Constructors
new KeywordTableIndex()
new KeywordTableIndex(
init):KeywordTableIndex
Defined in: llamaindex/src/indices/keyword/index.ts:165
Parameters
init
BaseIndexInit<KeywordTable>
Returns
Overrides
Properties
storageContext
storageContext:
StorageContext
Defined in: llamaindex/src/indices/BaseIndex.ts:27
Inherited from
docStore
docStore:
BaseDocumentStore
Defined in: llamaindex/src/indices/BaseIndex.ts:28
Inherited from
indexStore?
optionalindexStore:BaseIndexStore
Defined in: llamaindex/src/indices/BaseIndex.ts:29
Inherited from
indexStruct
indexStruct:
KeywordTable
Defined in: llamaindex/src/indices/BaseIndex.ts:30
Inherited from
Methods
insert()
insert(
document):Promise<void>
Defined in: llamaindex/src/indices/BaseIndex.ts:68
Insert a document into the index.
Parameters
document
Document<Metadata>
Returns
Promise<void>
Inherited from
init()
staticinit(options):Promise<KeywordTableIndex>
Defined in: llamaindex/src/indices/keyword/index.ts:169
Parameters
options
Returns
Promise<KeywordTableIndex>
asRetriever()
asRetriever(
options?):BaseRetriever
Defined in: llamaindex/src/indices/keyword/index.ts:232
Create a new retriever from the index.
Parameters
options?
any
Returns
BaseRetriever
Overrides
asQueryEngine()
asQueryEngine(
options?):BaseQueryEngine
Defined in: llamaindex/src/indices/keyword/index.ts:243
Create a new query engine from the index. It will also create a retriever and response synthezier if they are not provided.
Parameters
options?
you can supply your own custom Retriever and ResponseSynthesizer
retriever?
BaseRetriever
responseSynthesizer?
BaseSynthesizer
preFilters?
unknown
nodePostprocessors?
BaseNodePostprocessor[]
Returns
BaseQueryEngine
Overrides
asChatEngine()
asChatEngine(
options?):BaseChatEngine
Defined in: llamaindex/src/indices/keyword/index.ts:257
Create a new chat engine from the index.
Parameters
options?
KeywordTableIndexChatEngineOptions
Returns
BaseChatEngine
Overrides
extractKeywords()
staticextractKeywords(text):Promise<Set<string>>
Defined in: llamaindex/src/indices/keyword/index.ts:265
Parameters
text
string
Returns
Promise<Set<string>>
fromDocuments()
staticfromDocuments(documents,args):Promise<KeywordTableIndex>
Defined in: llamaindex/src/indices/keyword/index.ts:284
High level API: split documents, get keywords, and build index.
Parameters
documents
Document<Metadata>[]
args
storageContext?
Returns
Promise<KeywordTableIndex>
buildIndexFromNodes()
staticbuildIndexFromNodes(nodes,docStore):Promise<KeywordTable>
Defined in: llamaindex/src/indices/keyword/index.ts:313
Get keywords for nodes and place them into the index.
Parameters
nodes
BaseNode<Metadata>[]
docStore
BaseDocumentStore
Returns
Promise<KeywordTable>
insertNodes()
insertNodes(
nodes):Promise<void>
Defined in: llamaindex/src/indices/keyword/index.ts:328
Parameters
nodes
BaseNode<Metadata>[]
Returns
Promise<void>
Overrides
deleteNode()
deleteNode(
nodeId):void
Defined in: llamaindex/src/indices/keyword/index.ts:337
Parameters
nodeId
string
Returns
void
deleteNodes()
deleteNodes(
nodeIds,deleteFromDocStore):Promise<void>
Defined in: llamaindex/src/indices/keyword/index.ts:355
Parameters
nodeIds
string[]
deleteFromDocStore
boolean
Returns
Promise<void>
deleteRefDoc()
deleteRefDoc(
refDocId,deleteFromDocStore?):Promise<void>
Defined in: llamaindex/src/indices/keyword/index.ts:369
Parameters
refDocId
string
deleteFromDocStore?
boolean
Returns
Promise<void>