SummaryIndex

Defined in: packages/llamaindex/src/indices/summary/index.ts:63

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

Extends

• BaseIndex<IndexList>

Constructors

Constructor

new SummaryIndex(init): SummaryIndex

Defined in: packages/llamaindex/src/indices/summary/index.ts:64

Parameters

init

BaseIndexInit<IndexList>

Returns

SummaryIndex

Overrides

BaseIndex.constructor

Properties

storageContext

storageContext: StorageContext

Defined in: packages/llamaindex/src/indices/BaseIndex.ts:52

Inherited from

BaseIndex.storageContext

---

docStore

docStore: BaseDocumentStore

Defined in: packages/llamaindex/src/indices/BaseIndex.ts:53

Inherited from

BaseIndex.docStore

---

indexStore?

optional indexStore: BaseIndexStore

Defined in: packages/llamaindex/src/indices/BaseIndex.ts:54

Inherited from

BaseIndex.indexStore

---

indexStruct

indexStruct: IndexList

Defined in: packages/llamaindex/src/indices/BaseIndex.ts:55

Inherited from

BaseIndex.indexStruct

Methods

asQueryTool()

asQueryTool(params): QueryEngineTool

Defined in: 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

params

QueryToolParams

Returns

QueryEngineTool

Inherited from

BaseIndex.asQueryTool

---

insert()

insert(document): Promise<void>

Defined in: packages/llamaindex/src/indices/BaseIndex.ts:110

Insert a document into the index.

Parameters

document

Document

Returns

Promise<void>

Inherited from

BaseIndex.insert

---

retriever()

retriever(options?): BaseRetriever

Defined in: packages/llamaindex/src/indices/BaseIndex.ts:127

Alias for asRetriever

Parameters

options?

any

Returns

BaseRetriever

Inherited from

BaseIndex.retriever

---

queryEngine()

queryEngine(options?): BaseQueryEngine

Defined in: packages/llamaindex/src/indices/BaseIndex.ts:135

Alias for asQueryEngine

Parameters

options?

you can supply your own custom Retriever and ResponseSynthesizer

retriever?

BaseRetriever

responseSynthesizer?

BaseSynthesizer

Returns

BaseQueryEngine

Inherited from

BaseIndex.queryEngine

---

queryTool()

queryTool(params): QueryEngineTool

Defined in: 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

params

QueryToolParams

Returns

QueryEngineTool

Inherited from

BaseIndex.queryTool

---

init()

static init(options): Promise<SummaryIndex>

Defined in: packages/llamaindex/src/indices/summary/index.ts:68

Parameters

options

SummaryIndexOptions

Returns

Promise<SummaryIndex>

---

fromDocuments()

static fromDocuments(documents, args): Promise<SummaryIndex>

Defined in: packages/llamaindex/src/indices/summary/index.ts:133

Parameters

documents

Document<Metadata>[]

args

storageContext?

StorageContext

Returns

Promise<SummaryIndex>

---

asRetriever()

asRetriever(options?): BaseRetriever

Defined in: packages/llamaindex/src/indices/summary/index.ts:157

Create a new retriever from the index.

Parameters

options?

mode

SummaryRetrieverMode

Returns

BaseRetriever

Overrides

BaseIndex.asRetriever

---

asQueryEngine()

asQueryEngine(options?): RetrieverQueryEngine

Defined in: 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

options?

you can supply your own custom Retriever and ResponseSynthesizer

retriever?

BaseRetriever

responseSynthesizer?

BaseSynthesizer

preFilters?

unknown

nodePostprocessors?

BaseNodePostprocessor[]

Returns

RetrieverQueryEngine

Overrides

BaseIndex.asQueryEngine

---

asChatEngine()

asChatEngine(options?): BaseChatEngine

Defined in: packages/llamaindex/src/indices/summary/index.ts:193

Create a new chat engine from the index.

Parameters

options?

SummaryIndexChatEngineOptions

Returns

BaseChatEngine

Overrides

BaseIndex.asChatEngine

---

buildIndexFromNodes()

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

Defined in: packages/llamaindex/src/indices/summary/index.ts:203

Parameters

nodes

BaseNode<Metadata>[]

docStore

BaseDocumentStore

indexStruct?

IndexList

Returns

Promise<IndexList>

---

insertNodes()

insertNodes(nodes): Promise<void>

Defined in: packages/llamaindex/src/indices/summary/index.ts:218

Parameters

nodes

BaseNode<Metadata>[]

Returns

Promise<void>

Overrides

BaseIndex.insertNodes

---

deleteRefDoc()

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

Defined in: packages/llamaindex/src/indices/summary/index.ts:224

Parameters

refDocId

string

deleteFromDocStore?

boolean

Returns

Promise<void>

Overrides

BaseIndex.deleteRefDoc

---

deleteNodes()

deleteNodes(nodeIds, deleteFromDocStore): Promise<void>

Defined in: packages/llamaindex/src/indices/summary/index.ts:243

Parameters

nodeIds

string[]

deleteFromDocStore

boolean

Returns

Promise<void>

---

getRefDocInfo()

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

Defined in: packages/llamaindex/src/indices/summary/index.ts:257

Returns

Promise<Record<string, RefDocInfo>>