Ana içeriğe geç

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​

SummaryIndex

Overrides​

BaseIndex . constructor

Source​

packages/core/src/indices/summary/index.ts:58

Properties​

docStore​

docStore: BaseDocumentStore

Inherited from​

BaseIndex . docStore

Source​

packages/core/src/indices/BaseIndex.ts:60

indexStore?​

optional indexStore: BaseIndexStore

Inherited from​

BaseIndex . indexStore

Source​

packages/core/src/indices/BaseIndex.ts:61

indexStruct​

indexStruct: IndexList

Inherited from​

BaseIndex . indexStruct

Source​

packages/core/src/indices/BaseIndex.ts:62

serviceContext?​

optional serviceContext: ServiceContext

Inherited from​

BaseIndex . serviceContext

Source​

packages/core/src/indices/BaseIndex.ts:58

storageContext​

storageContext: StorageContext

Inherited from​

BaseIndex . storageContext

Source​

packages/core/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

Overrides​

BaseIndex . asQueryEngine

Source​

packages/core/src/indices/summary/index.ts:170

asRetriever()​

asRetriever(options?): BaseRetriever

Create a new retriever from the index.

Parameters​

• options?

• options.mode?: SummaryRetrieverMode

Returns​

BaseRetriever

Overrides​

BaseIndex . asRetriever

Source​

packages/core/src/indices/summary/index.ts:157

deleteNodes()​

deleteNodes(nodeIds, deleteFromDocStore): Promise<void>

Parameters​

• nodeIds: string[]

• deleteFromDocStore: boolean

Returns​

Promise<void>

Source​

packages/core/src/indices/summary/index.ts:238

deleteRefDoc()​

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

Parameters​

• refDocId: string

• deleteFromDocStore?: boolean

Returns​

Promise<void>

Overrides​

BaseIndex . deleteRefDoc

Source​

packages/core/src/indices/summary/index.ts:219

getRefDocInfo()​

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

Returns​

Promise<Record<string, RefDocInfo>>

Source​

packages/core/src/indices/summary/index.ts:252

insert()​

insert(document): Promise<void>

Insert a document into the index.

Parameters​

• document: Document <Metadata>

Returns​

Promise<void>

Inherited from​

BaseIndex . insert

Source​

packages/core/src/indices/BaseIndex.ts:92

insertNodes()​

insertNodes(nodes): Promise<void>

Parameters​

• nodes: BaseNode <Metadata>[]

Returns​

Promise<void>

Overrides​

BaseIndex . insertNodes

Source​

packages/core/src/indices/summary/index.ts:213

buildIndexFromNodes()​

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

Parameters​

• nodes: BaseNode <Metadata>[]

• docStore: BaseDocumentStore

• indexStruct?: IndexList

Returns​

Promise <IndexList>

Source​

packages/core/src/indices/summary/index.ts:198

fromDocuments()​

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

Parameters​

• documents: Document <Metadata>[]

• args= {}

• args.serviceContext?: ServiceContext

• args.storageContext?: StorageContext

Returns​

Promise <SummaryIndex>

Source​

packages/core/src/indices/summary/index.ts:127

init()​

static init(options): Promise <SummaryIndex>

Parameters​

• options: SummaryIndexOptions

Returns​

Promise <SummaryIndex>

Source​

packages/core/src/indices/summary/index.ts:62