文档

API概览

更新时间:
本产品(通义点金/2024-06-28)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

平台能力-文档库

API标题API概述
GetAppConfig获取配置信息获取应用配置信息,包含用户可使用模型列表,嵌入列表等。
CreateLibrary创建文档库创建文档库。创建一个新的文档库,文档库用作隔离文档信息、索引信息,如果使用场景中需要经常按类别去做自然语言检索,建议创建多个文档库,来隔离不同类型的数据。支持按照格式自定义向量索引和文本索引。
GetLibraryList获取文档库列表获取文档库列表,包含文档名称、描述、唯一标识等信息。
GetLibrary获取文档详情查看文档库的详细配置,包括文档库名称、描述以及索引等详细配置信息。
UploadDocument上传文档上传文档至文档库,会对文档进行解析、分块、构建索引等一系列操作。
GetDocumentUrl获取文档的下载链接获取文档的下载链接,链接过期时间为1小时。
PreviewDocument预览文档预览文档,可获取文档的下载链接,文档类型、标题等信息,可用于文档预览。
GetFilterDocumentList按元信息过滤查询文档列表获取文档列表(可按元信息过滤查询,也支持分页查询)。
GetDocumentList获取文档列表获取文档库内文档列表,可分页查询,也根据文档状态进行过滤查询。
DeleteDocument删除文档删除文档,删除后将无法查看原始文档,无法召回该文档。
UpdateDocument更新文档更新文档,用于更新文档的标题、元数据等信息。
CreatePredefinedDocument创建预定义文档根据业务场景灵活构建文档块。
GetDocumentChunkList获取文档块列表获取文档块列表,可根据查询条件过滤。
RecallDocument文档召回文档召回,可根据文本从文档库中召回文档块。并可设置召回文档块数量、也可根据元信息条件进行过滤,同时可选择是否进行文档块的补全。
GetParseResult获取文档解析结果获取文档解析结果。可查询文档的解析状态以及获取文档的解析结果。
ReIndex重建索引重建索引,会对指定文档重新进行文档解析、分块、构建索引等流程。
UpdateLibrary更新文档库更新文档库,可用于更新文档库的名称、描述、索引配置等信息。
DeleteLibrary删除文档库删除文档库,注意⚠️,此接口将会删除文档库及其关联的所有文档。
RunLibraryChatGeneration文档库会话生成文档库会话生成,用自然语言提问,检索文档库相关信息,总结回答。
GetHistoryListByBizType根据业务类型获取对话历史记录根据业务类型获取对话历史记录

平台能力-应用

API标题API概述
CreateFinReportSummaryTask创建财报总结任务创建财报总结接口。
GetTaskStatus获取任务状态获取任务状态。
GetSummaryTaskResult获取财报总结任务结果获取财报总结任务结果。
EvictTask取消任务中断任务。
RunChatResultGeneration对话结果生成对话结果生成,可选择模型进行对话,支持流式和非流式。

平台能力-插件

API标题API概述
InvokePlugin调用插件调用插件,获取插件返回结果。