API概览_大模型服务平台百炼(Model Studio)-阿里云帮助中心

本产品（通义点金/2024-06-28）的OpenAPI采用ROA签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

平台能力-文档库

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

平台能力-应用

API	标题	API概述
GetDialogAnalysisResult	获取会话分析结果	获取会话分析结果。可批量获取，根据会话ID列表或时间范围。
RealTimeDialog	实时会话	实时会话，通过API CreateDialog创建会话后，可使用该API进行实时会话。
CreateDialog	创建外呼会话	创建外呼会话。
RebuildTask	重建任务	对已有任务进行重建，但在队列中或执行中的任务不可重建。
CreateAnnualDocSummaryTask	创建按年份总结文档任务	创建按年份总结文档任务。
GetQualityCheckTaskResult	获取质检结果	获取质检结果。
CreateQualityCheckTask	创建质检任务	创建质检任务。
CreateDocsSummaryTask	创建多文档总结任务	创建多文档总结任务。
GetTaskResult	获取结果	获取异步任务结果。
CreatePdfTranslateTask	创建pdf文档翻译任务	创建pdf文档翻译任务。提交翻译任务，异步执行翻译过程。
RecognizeIntention	意图识别	意图识别，支持意图识别（全局+分层）、态度识别、企业识别。
CreateFinReportSummaryTask	创建财报总结任务	创建财报总结接口。
GetTaskStatus	获取任务状态	获取任务状态。
GetSummaryTaskResult	获取财报总结任务结果	获取财报总结任务结果。
EvictTask	取消任务	中断任务。
RunChatResultGeneration	对话结果生成	对话结果生成，可选择模型进行对话，支持流式和非流式。
GetChatQuestionResp	获取问答结果	获取问答结果，即API SubmitChatQuestion的结果。
GenDocQaResult	根据文档解析问答QA	根据文档解析问答QA，可在API UpdateQaLibrary进行QA对的更新。
UpdateQaLibrary	更新QA问答库	更新QA问答库。更新后，可通过API GenDocQaResult来解析QA。
SubmitChatQuestion	提交问题列表	提交问题列表，通过API GetChatQuestionResp获取结果。