SummaryIndex
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:63
A SummaryIndex keeps nodes in a sequential order for use with summarization.
Extends
Section titled “Extends”BaseIndex<IndexList>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SummaryIndex(
init):SummaryIndex
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:64
Parameters
Section titled “Parameters”BaseIndexInit<IndexList>
Returns
Section titled “Returns”SummaryIndex
Overrides
Section titled “Overrides”Properties
Section titled “Properties”storageContext
Section titled “storageContext”storageContext:
StorageContext
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:52
Inherited from
Section titled “Inherited from”docStore
Section titled “docStore”docStore:
BaseDocumentStore
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:53
Inherited from
Section titled “Inherited from”indexStore?
Section titled “indexStore?”
optionalindexStore:BaseIndexStore
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:54
Inherited from
Section titled “Inherited from”indexStruct
Section titled “indexStruct”indexStruct:
IndexList
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:55
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”asQueryTool()
Section titled “asQueryTool()”asQueryTool(
params):QueryEngineTool
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:94
Returns a query tool by calling asQueryEngine. Either options or retriever can be passed, but not both. If options are provided, they are passed to generate a retriever.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”insert()
Section titled “insert()”insert(
document):Promise<void>
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:110
Insert a document into the index.
Parameters
Section titled “Parameters”document
Section titled “document”Document
Returns
Section titled “Returns”Promise<void>
Inherited from
Section titled “Inherited from”retriever()
Section titled “retriever()”retriever(
options?):BaseRetriever
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:127
Alias for asRetriever
Parameters
Section titled “Parameters”options?
Section titled “options?”any
Returns
Section titled “Returns”BaseRetriever
Inherited from
Section titled “Inherited from”queryEngine()
Section titled “queryEngine()”queryEngine(
options?):BaseQueryEngine
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:135
Alias for asQueryEngine
Parameters
Section titled “Parameters”options?
Section titled “options?”you can supply your own custom Retriever and ResponseSynthesizer
retriever?
Section titled “retriever?”BaseRetriever
responseSynthesizer?
Section titled “responseSynthesizer?”BaseSynthesizer
Returns
Section titled “Returns”BaseQueryEngine
Inherited from
Section titled “Inherited from”queryTool()
Section titled “queryTool()”queryTool(
params):QueryEngineTool
Defined in: .build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:147
Alias for asQueryTool Either options or retriever can be passed, but not both. If options are provided, they are passed to generate a retriever.
Parameters
Section titled “Parameters”params
Section titled “params”Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”init()
Section titled “init()”
staticinit(options):Promise<SummaryIndex>
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:68
Parameters
Section titled “Parameters”options
Section titled “options”Returns
Section titled “Returns”Promise<SummaryIndex>
fromDocuments()
Section titled “fromDocuments()”
staticfromDocuments(documents,args):Promise<SummaryIndex>
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:133
Parameters
Section titled “Parameters”documents
Section titled “documents”Document<Metadata>[]
storageContext?
Section titled “storageContext?”Returns
Section titled “Returns”Promise<SummaryIndex>
asRetriever()
Section titled “asRetriever()”asRetriever(
options?):BaseRetriever
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:157
Create a new retriever from the index.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”BaseRetriever
Overrides
Section titled “Overrides”asQueryEngine()
Section titled “asQueryEngine()”asQueryEngine(
options?):RetrieverQueryEngine
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:170
Create a new query engine from the index. It will also create a retriever and response synthezier if they are not provided.
Parameters
Section titled “Parameters”options?
Section titled “options?”you can supply your own custom Retriever and ResponseSynthesizer
retriever?
Section titled “retriever?”BaseRetriever
responseSynthesizer?
Section titled “responseSynthesizer?”BaseSynthesizer
preFilters?
Section titled “preFilters?”unknown
nodePostprocessors?
Section titled “nodePostprocessors?”BaseNodePostprocessor[]
Returns
Section titled “Returns”RetrieverQueryEngine
Overrides
Section titled “Overrides”asChatEngine()
Section titled “asChatEngine()”asChatEngine(
options?):BaseChatEngine
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:193
Create a new chat engine from the index.
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”BaseChatEngine
Overrides
Section titled “Overrides”buildIndexFromNodes()
Section titled “buildIndexFromNodes()”
staticbuildIndexFromNodes(nodes,docStore,indexStruct?):Promise<IndexList>
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:203
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
docStore
Section titled “docStore”BaseDocumentStore
indexStruct?
Section titled “indexStruct?”IndexList
Returns
Section titled “Returns”Promise<IndexList>
insertNodes()
Section titled “insertNodes()”insertNodes(
nodes):Promise<void>
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:218
Parameters
Section titled “Parameters”BaseNode<Metadata>[]
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”deleteRefDoc()
Section titled “deleteRefDoc()”deleteRefDoc(
refDocId,deleteFromDocStore?):Promise<void>
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:224
Parameters
Section titled “Parameters”refDocId
Section titled “refDocId”string
deleteFromDocStore?
Section titled “deleteFromDocStore?”boolean
Returns
Section titled “Returns”Promise<void>
Overrides
Section titled “Overrides”deleteNodes()
Section titled “deleteNodes()”deleteNodes(
nodeIds,deleteFromDocStore):Promise<void>
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:243
Parameters
Section titled “Parameters”nodeIds
Section titled “nodeIds”string[]
deleteFromDocStore
Section titled “deleteFromDocStore”boolean
Returns
Section titled “Returns”Promise<void>
getRefDocInfo()
Section titled “getRefDocInfo()”getRefDocInfo():
Promise<Record<string,RefDocInfo>>
Defined in: .build/typescript/packages/llamaindex/src/indices/summary/index.ts:257
Returns
Section titled “Returns”Promise<Record<string, RefDocInfo>>