阿里云OpenAPI开发者门户

通义点金 - OpenAPI 概览2024-06-28
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
平台能力-文档库
OpenAPI 名称描述操作
CreateLibraryhot创建文档库。创建一个新的文档库,文档库用作隔离文档信息、索引信息,如果使用场景中需要经常按类别去做自然语言检索,建议创建多个文档库,来隔离不同类型的数据。支持按照格式自定义向量索引和文本索引查看文档去调试
UploadDocumenthot上传文档至文档库,会对文档进行解析、分块、构建索引等一系列操作查看文档去调试
CreatePredefinedDocument根据业务场景灵活构建文档块查看文档去调试
GetAppConfighot获取app配置查看文档去调试
GetLibraryListhot获取文档库列表,包含文档名称、描述、唯一标识等信息查看文档去调试
GetLibrary查看文档库的详细配置,包括文档库名称、描述以及索引等详细配置信息查看文档去调试
GetDocumentUrl获取文档的下载链接,链接过期时间为1小时查看文档去调试
PreviewDocument预览文档,可获取文档的下载链接,文档类型、标题等信息,可用于文档预览查看文档去调试
GetFilterDocumentList获取文档列表(可按元信息过滤查询,也支持分页查询)查看文档去调试
GetDocumentList获取文档库内文档列表,可分页查询,也根据文档状态进行过滤查询查看文档去调试
GetDocumentChunkList获取文档块列表,可根据查询条件过滤查看文档去调试
RecallDocument文档召回,可根据文本从文档库中召回文档块。并可设置召回文档块数量、也可根据元信息条件进行过滤,同时可选择是否进行文档块的补全查看文档去调试
GetParseResult获取文档解析结果。可查询文档的解析状态以及获取文档的解析结果查看文档去调试
GetHistoryListByBizType根据业务类型获取对话历史记录查看文档去调试
UpdateDocument更新文档,用于更新文档的标题、元数据等信息查看文档去调试
ReIndex重建索引,会对指定文档重新进行文档解析、分块、构建索引等流程查看文档去调试
UpdateLibrary更新文档库,可用于更新文档库的名称、描述、索引配置等信息查看文档去调试
DeleteDocument删除文档,删除后将无法查看原始文档,无法召回该文档查看文档去调试
DeleteLibrary删除文档库,注意⚠️,此接口将会删除文档库及其关联的所有文档查看文档去调试
UpdateDocumentChunk更新文档中的文档块文本内容查看文档去调试
RunLibraryChatGeneration文档库会话生成,用自然语言提问,检索文档库相关信息,总结回答查看文档去调试
InvokePlugin调用插件,获取插件返回结果查看文档去调试
平台能力-应用
OpenAPI 名称描述操作
CreateAnnualDocSummaryTask创建按年份总结文档任务查看文档去调试
CreateQualityCheckTask创建质检任务查看文档去调试
CreateDocsSummaryTask创建多文档总结任务查看文档去调试
CreatePdfTranslateTaskhot创建pdf文档翻译任务。提交翻译任务,异步执行翻译过程查看文档去调试
CreateFinReportSummaryTask创建财报总结接口查看文档去调试
GetQualityCheckTaskResult获取质检结果查看文档去调试
GetTaskResult获取异步任务结果查看文档去调试
GetTaskStatus获取任务状态查看文档去调试
GetSummaryTaskResult获取财报总结任务结果查看文档去调试
CreateDialogAnalysisTask创建会话分析任务,创建成功后可根据会话ID使用GetDialogAnalysisResult查询结果查看文档去调试
RunAgenthot运行智能体,支持流式和非流式查看文档去调试
GetDialogAnalysisResult获取会话分析结果。可批量获取,根据会话ID列表或时间范围查看文档去调试
RealTimeDialoghot实时会话,通过API CreateDialog创建会话后,可使用该API进行实时会话查看文档去调试
CreateDialoghot创建外呼会话查看文档去调试
RebuildTask对已有任务进行重建,但在队列中或执行中的任务不可重建查看文档去调试
RecognizeIntentionhot意图识别,支持意图识别(全局+分层)、态度识别、企业识别查看文档去调试
EvictTask中断任务查看文档去调试
RunChatResultGenerationhot对话结果生成,可选择模型进行对话,支持流式和非流式查看文档去调试
GetChatQuestionResp获取问答结果,即API SubmitChatQuestion的结果查看文档去调试
GenDocQaResult根据文档解析问答QA,可在API UpdateQaLibrary进行QA对的更新查看文档去调试
UpdateQaLibrary更新QA问答库。更新后,可通过API GenDocQaResult来解析QA查看文档去调试
SubmitChatQuestion提交问题列表,通过API GetChatQuestionResp获取结果查看文档去调试