Class: SummaryIndex
A SummaryIndex keeps nodes in a sequential order for use with summarization.
Extends
Constructors
new SummaryIndex()
new SummaryIndex(
init
):SummaryIndex
Parameters
• init: BaseIndexInit
<IndexList
>
Returns
Overrides
Source
packages/llamaindex/src/indices/summary/index.ts:58
Properties
docStore
docStore:
BaseDocumentStore
Inherited from
Source
packages/llamaindex/src/indices/BaseIndex.ts:60
indexStore?
optional
indexStore:BaseIndexStore
Inherited from
Source
packages/llamaindex/src/indices/BaseIndex.ts:61
indexStruct
indexStruct:
IndexList
Inherited from
Source
packages/llamaindex/src/indices/BaseIndex.ts:62
serviceContext?
optional
serviceContext:ServiceContext
Inherited from
Source
packages/llamaindex/src/indices/BaseIndex.ts:58
storageContext
storageContext:
StorageContext
Inherited from
Source
packages/llamaindex/src/indices/BaseIndex.ts:59
Methods
asQueryEngine()
asQueryEngine(
options
?):QueryEngine
&RetrieverQueryEngine
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
• options.nodePostprocessors?: BaseNodePostprocessor
[]
• options.preFilters?: unknown
• options.responseSynthesizer?: BaseSynthesizer
• options.retriever?: BaseRetriever
Returns
QueryEngine
& RetrieverQueryEngine