Class: SummaryIndex

A SummaryIndex keeps nodes in a sequential order for use with summarization.

Hierarchy

• BaseIndex<IndexList>

  ↳ SummaryIndex

Constructors

constructor

• new SummaryIndex(init)

Parameters

Name	Type
init	BaseIndexInit<IndexList>

Overrides

BaseIndex.constructor

Defined in

indices/summary/SummaryIndex.ts:47

Properties

docStore

• docStore: BaseDocumentStore

Inherited from

BaseIndex.docStore

Defined in

indices/BaseIndex.ts:125

---

indexStore

• Optional indexStore: BaseIndexStore

Inherited from

BaseIndex.indexStore

Defined in

indices/BaseIndex.ts:127

---

indexStruct

• indexStruct: IndexList

Inherited from

BaseIndex.indexStruct

Defined in

indices/BaseIndex.ts:128

---

serviceContext

• serviceContext: ServiceContext

Inherited from

BaseIndex.serviceContext

Defined in

indices/BaseIndex.ts:123

---

storageContext

• storageContext: StorageContext

Inherited from

BaseIndex.storageContext

Defined in

indices/BaseIndex.ts:124

---

vectorStore

• Optional vectorStore: VectorStore

Inherited from

BaseIndex.vectorStore

Defined in

indices/BaseIndex.ts:126

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?	ResponseSynthesizer	-
options.retriever?	BaseRetriever	-

Returns

BaseQueryEngine

Overrides

BaseIndex.asQueryEngine

Defined in

indices/summary/SummaryIndex.ts:155

---

asRetriever

▸ asRetriever(options?): BaseRetriever

Create a new retriever from the index.

Parameters

Name	Type
options?	Object
options.mode	SummaryRetrieverMode

Returns

BaseRetriever

Overrides

BaseIndex.asRetriever

Defined in

indices/summary/SummaryIndex.ts:142

---

deleteNodes

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

Parameters

Name	Type
nodeIds	string[]
deleteFromDocStore	boolean

Returns

Promise<void>

Defined in

indices/summary/SummaryIndex.ts:216

---

deleteRefDoc

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

Parameters

Name	Type
refDocId	string
deleteFromDocStore?	boolean

Returns

Promise<void>

Overrides

BaseIndex.deleteRefDoc

Defined in

indices/summary/SummaryIndex.ts:197

---

getRefDocInfo

▸ getRefDocInfo(): Promise<Record<string, RefDocInfo>>

Returns

Promise<Record<string, RefDocInfo>>

Defined in

indices/summary/SummaryIndex.ts:230

---

insert

▸ insert(document): Promise<void>

Insert a document into the index.

Parameters

Name	Type
document	Document

Returns

Promise<void>

Inherited from

BaseIndex.insert

Defined in

indices/BaseIndex.ts:159

---

insertNodes

▸ insertNodes(nodes): Promise<void>

Parameters

Name	Type
nodes	BaseNode[]

Returns

Promise<void>

Overrides

BaseIndex.insertNodes

Defined in

indices/summary/SummaryIndex.ts:191

---

buildIndexFromNodes

▸ Static buildIndexFromNodes(nodes, docStore, indexStruct?): Promise<IndexList>

Parameters

Name	Type
nodes	BaseNode[]
docStore	BaseDocumentStore
indexStruct?	IndexList

Returns

Promise<IndexList>

Defined in

indices/summary/SummaryIndex.ts:176

---

fromDocuments

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

Parameters

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

Returns

Promise<SummaryIndex>

Defined in

indices/summary/SummaryIndex.ts:116

---

init

▸ Static init(options): Promise<SummaryIndex>

Parameters

Name	Type
options	SummaryIndexOptions

Returns

Promise<SummaryIndex>

Defined in

indices/summary/SummaryIndex.ts:51