跳转到内容
LlamaIndex TypeScript API Reference

SummaryIndex

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:63

SummaryIndex 按顺序维护节点，用于摘要生成。

扩展

Section titled “Extends”

构造函数

Section titled “Constructors”

构造函数

Section titled “Constructor”

new SummaryIndex(init): SummaryIndex

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:64

参数

Section titled “Parameters”
初始化
Section titled “init”

BaseIndexInit<IndexList>

返回

Section titled “Returns”

SummaryIndex

覆盖设置

Section titled “Overrides”

BaseIndex.constructor

属性

Section titled “Properties”

storageContext

Section titled “storageContext”

存储上下文: StorageContext

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:52

继承自

Section titled “Inherited from”

BaseIndex.storageContext

docStore

Section titled “docStore”

文档存储: BaseDocumentStore

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:53

继承自

Section titled “Inherited from”

BaseIndex.docStore

索引存储？

Section titled “indexStore?”

optional 索引存储: BaseIndexStore

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:54

继承自

Section titled “Inherited from”

BaseIndex.indexStore

indexStruct

Section titled “indexStruct”

索引结构: IndexList

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:55

继承自

Section titled “Inherited from”

BaseIndex.indexStruct

方法

Section titled “Methods”

asQueryTool()

Section titled “asQueryTool()”

asQueryTool(params): QueryEngineTool

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:94

通过调用 asQueryEngine 返回一个查询工具。 可以传递 options 或 retriever 其中之一，但不能同时传递两者。 如果提供了 options，它们将被传递用于生成检索器。

参数

Section titled “Parameters”
参数
Section titled “params”

QueryToolParams

返回

Section titled “Returns”

QueryEngineTool

继承自

Section titled “Inherited from”

BaseIndex.asQueryTool

insert()

Section titled “insert()”

insert(document): Promise<void>

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:110

将文档插入索引中。

参数

Section titled “Parameters”
文档
Section titled “document”

Document

返回

Section titled “Returns”

Promise<void>

继承自

Section titled “Inherited from”

BaseIndex.insert

retriever()

Section titled “retriever()”

retriever(options?): BaseRetriever

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:127

asRetriever 的别名

参数

Section titled “Parameters”
选项？
Section titled “options?”

any

返回

Section titled “Returns”

BaseRetriever

继承自

Section titled “Inherited from”

BaseIndex.retriever

queryEngine()

Section titled “queryEngine()”

queryEngine(options?): BaseQueryEngine

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:135

asQueryEngine 的别名

参数

Section titled “Parameters”
选项？
Section titled “options?”

您可以提供自定义的检索器和响应合成器

检索器？
Section titled “retriever?”

BaseRetriever

响应合成器？
Section titled “responseSynthesizer?”

BaseSynthesizer

返回

Section titled “Returns”

BaseQueryEngine

继承自

Section titled “Inherited from”

BaseIndex.queryEngine

queryTool()

Section titled “queryTool()”

queryTool(params): QueryEngineTool

定义于：.build/typescript/packages/llamaindex/src/indices/BaseIndex.ts:147

asQueryTool 的别名 可以传入 options 或 retriever 中的任意一个，但不能同时传入。 如果提供了 options，它们将被传递给生成检索器。

参数

Section titled “Parameters”
参数
Section titled “params”

QueryToolParams

返回

Section titled “Returns”

QueryEngineTool

继承自

Section titled “Inherited from”

BaseIndex.queryTool

init()

Section titled “init()”

static init(options): Promise<SummaryIndex>

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:68

参数

Section titled “Parameters”
选项
Section titled “options”

SummaryIndexOptions

返回

Section titled “Returns”

Promise<SummaryIndex>

fromDocuments()

Section titled “fromDocuments()”

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

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:133

参数

Section titled “Parameters”
文档
Section titled “documents”

Document<Metadata>[]

参数
Section titled “args”
存储上下文？
Section titled “storageContext?”

StorageContext

返回

Section titled “Returns”

Promise<SummaryIndex>

asRetriever()

Section titled “asRetriever()”

asRetriever(options?): BaseRetriever

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:157

从索引创建一个新的检索器。

参数

Section titled “Parameters”
选项？
Section titled “options?”
模式
Section titled “mode”

SummaryRetrieverMode

返回

Section titled “Returns”

BaseRetriever

覆盖设置

Section titled “Overrides”

BaseIndex.asRetriever

asQueryEngine()

Section titled “asQueryEngine()”

asQueryEngine(options?): RetrieverQueryEngine

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:170

从索引创建新的查询引擎。如果未提供检索器和响应合成器，它也会创建它们。

参数

Section titled “Parameters”
选项？
Section titled “options?”

您可以提供自定义的检索器和响应合成器

检索器？
Section titled “retriever?”

BaseRetriever

响应合成器？
Section titled “responseSynthesizer?”

BaseSynthesizer

前置过滤器？
Section titled “preFilters?”

unknown

节点后处理器？
Section titled “nodePostprocessors?”

BaseNodePostprocessor[]

返回

Section titled “Returns”

RetrieverQueryEngine

覆盖设置

Section titled “Overrides”

BaseIndex.asQueryEngine

asChatEngine()

Section titled “asChatEngine()”

asChatEngine(options?): BaseChatEngine

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:193

从索引创建一个新的聊天引擎。

参数

Section titled “Parameters”
选项？
Section titled “options?”

SummaryIndexChatEngineOptions

返回

Section titled “Returns”

BaseChatEngine

覆盖设置

Section titled “Overrides”

BaseIndex.asChatEngine

buildIndexFromNodes()

Section titled “buildIndexFromNodes()”

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

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:203

参数

Section titled “Parameters”
节点
Section titled “nodes”

BaseNode<Metadata>[]

docStore
Section titled “docStore”

BaseDocumentStore

indexStruct?
Section titled “indexStruct?”

IndexList

返回

Section titled “Returns”

Promise<IndexList>

insertNodes()

Section titled “insertNodes()”

insertNodes(nodes): Promise<void>

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:218

参数

Section titled “Parameters”
节点
Section titled “nodes”

BaseNode<Metadata>[]

返回

Section titled “Returns”

Promise<void>

覆盖设置

Section titled “Overrides”

BaseIndex.insertNodes

deleteRefDoc()

Section titled “deleteRefDoc()”

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

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:224

参数

Section titled “Parameters”
refDocId
Section titled “refDocId”

string

从文档存储中删除？
Section titled “deleteFromDocStore?”

boolean

返回

Section titled “Returns”

Promise<void>

覆盖设置

Section titled “Overrides”

BaseIndex.deleteRefDoc

deleteNodes()

Section titled “deleteNodes()”

deleteNodes(nodeIds, deleteFromDocStore): Promise<void>

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:243

参数

Section titled “Parameters”
nodeIds
Section titled “nodeIds”

string[]

deleteFromDocStore
Section titled “deleteFromDocStore”

boolean

返回

Section titled “Returns”

Promise<void>

getRefDocInfo()

Section titled “getRefDocInfo()”

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

定义于：.build/typescript/packages/llamaindex/src/indices/summary/index.ts:257

返回

Section titled “Returns”

Promise<Record<string, RefDocInfo>>