Class: SummaryIndex
A SummaryIndex keeps nodes in a sequential order for use with summarization.
Hierarchy
Constructors
constructor
• new SummaryIndex(init
): SummaryIndex
Parameters
Name | Type |
---|---|
init | BaseIndexInit <IndexList > |
Returns
Overrides
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:51
Properties
docStore
• docStore: BaseDocumentStore
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:157
indexStore
• Optional
indexStore: BaseIndexStore
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:159
indexStruct
• indexStruct: IndexList
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:160
serviceContext
• serviceContext: ServiceContext
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:155
storageContext
• storageContext: StorageContext
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:156
vectorStore
• Optional
vectorStore: VectorStore
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:158
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.nodePostprocessors? | BaseNodePostprocessor [] | - |
options.preFilters? | unknown | - |
options.responseSynthesizer? | BaseSynthesizer | - |
options.retriever? | BaseRetriever | - |
Returns
BaseQueryEngine
Overrides
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:159
asRetriever
▸ asRetriever(options?
): BaseRetriever
Create a new retriever from the index.
Parameters
Name | Type |
---|---|
options? | Object |
options.mode | SummaryRetrieverMode |
Returns
Overrides
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:146
deleteNodes
▸ deleteNodes(nodeIds
, deleteFromDocStore
): Promise
<void
>
Parameters
Name | Type |
---|---|
nodeIds | string [] |
deleteFromDocStore | boolean |
Returns
Promise
<void
>
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:227
deleteRefDoc
▸ deleteRefDoc(refDocId
, deleteFromDocStore?
): Promise
<void
>
Parameters
Name | Type |
---|---|
refDocId | string |
deleteFromDocStore? | boolean |
Returns
Promise
<void
>
Overrides
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:208
getRefDocInfo
▸ getRefDocInfo(): Promise
<Record
<string
, RefDocInfo
>>
Returns
Promise
<Record
<string
, RefDocInfo
>>
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:241
insert
▸ insert(document
): Promise
<void
>
Insert a document into the index.
Parameters
Name | Type |
---|---|
document | Document <Metadata > |
Returns
Promise
<void
>
Inherited from
Defined in
packages/core/src/indices/BaseIndex.ts:191
insertNodes
▸ insertNodes(nodes
): Promise
<void
>
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
Returns
Promise
<void
>
Overrides
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:202
buildIndexFromNodes
▸ buildIndexFromNodes(nodes
, docStore
, indexStruct?
): Promise
<IndexList
>
Parameters
Name | Type |
---|---|
nodes | BaseNode <Metadata >[] |
docStore | BaseDocumentStore |
indexStruct? | IndexList |
Returns
Promise
<IndexList
>
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:187
fromDocuments
▸ fromDocuments(documents
, args?
): Promise
<SummaryIndex
>
Parameters
Name | Type |
---|---|
documents | Document <Metadata >[] |
args | Object |
args.serviceContext? | ServiceContext |
args.storageContext? | StorageContext |
Returns
Promise
<SummaryIndex
>
Defined in
packages/core/src/indices/summary/SummaryIndex.ts:120
init
▸ init(options
): Promise
<SummaryIndex
>
Parameters
Name | Type |
---|---|
options | SummaryIndexOptions |
Returns
Promise
<SummaryIndex
>