API标准及多语言预置SDK
本产品（大模型服务平台百炼/2023-12-29）的 OpenAPI 采用 ROA 签名机制，具体签名方式请参见签名机制说明。我们已为开发者封装了主流编程语言的 SDK，您可通过 下载 SDK 快速调用 API，无需关注签名等底层实现细节，显著降低开发门槛与集成复杂度。自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的 RAM 用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
应用数据
| API | 标题 | API概述 |
|---|---|---|
| ListFile | 文件列表 | 获取指定类目下一个或多个文档的详细信息。 |
| DeleteCategory | 删除类目 | 永久性删除指定的类目。 |
| ListCategory | 类目列表 | 获取指定业务空间下一个或多个类目的详细信息。 |
| AddCategory | 新增类目 | 在指定的业务空间中创建一个类目，用于分类和管理文件。每个业务空间最多创建500个类目。 |
| AddFile | 添加文件 | 将存储于阿里云百炼临时存储空间内的文件导入至阿里云百炼应用数据。 |
| AddFilesFromAuthorizedOss | 从已授权OSS Bucket中导入文件 | 将已授权OSS Bucket中的文件导入阿里云百炼应用数据中。 |
| ApplyFileUploadLease | 申请文件上传租约 | 请求一个上传租约用于上传知识库文件，或智能体应用会话交互的文件。 |
| DescribeFile | 查询文件状态 | 查询应用数据中文件的基本信息，包括文件名称、类型、状态等。 |
| GetParseSettings | 获取类目解析设置 | 查询指定类目的数据解析设置。 |
| GetAvailableParserTypes | 获取文件支持的解析器类型 | 根据输入的文件类型（文件扩展名），获取所有支持的解析器类型列表。 |
| ChangeParseSetting | 修改类目解析设置 | 配置特定文件类型的解析方式。例如，为 .pdf 文件指定使用大模型文档解析，为 .jpg 文件指定使用Qwen VL解析。 |
知识库
| API | 标题 | API概述 |
|---|---|---|
| CreateIndex | 创建知识库 | 创建一个文档搜索类知识库。 |
| GetIndexJobStatus | 查询知识库创建任务状态 | 查询指定的知识库创建任务或知识库追加任务的当前状态。 |
| SubmitIndexJob | 提交知识库创建任务 | 提交指定的 CreateIndex 任务以完成知识库创建。 |
| SubmitIndexAddDocumentsJob | 提交知识库追加任务 | 向指定知识库中追加导入已解析的文件。 |
| Retrieve | 检索知识库 | 在指定的知识库中检索信息。 |
| ListIndexDocuments | 查询知识库下的文件列表 | 获取指定知识库中的文件，以及它们的概要信息。 |
| ListIndexFileDetails | 查询知识库下的文件详情 | 获取指定知识库中的文件，以及它们的详细信息。 |
| DeleteIndexDocument | 删除知识库下的文件 | 永久删除指定知识库中的文件。 |
| ListIndices | 查询知识库列表 | 获取指定业务空间下知识库列表。 |
| DeleteIndex | 删除知识库 | 永久性删除指定的知识库。 |
| ListChunks | 查询索引下的分片列表 | 查看文本切片列表及信息。 |
| UpdateChunk | 修改切片 | 修改知识库中指定文本切片的内容（content）和标题（title），并设置是否参与知识库检索。 |
| DeleteChunk | 删除切片 | 删除知识库中的指定文本切片，被删的文本切片将无法被检索和召回。 |
Prompt工程
| API | 标题 | API概述 |
|---|---|---|
| CreatePromptTemplate | 创建Prompt模板 | 创建Prompt模板。 |
| GetPromptTemplate | 获取Prompt模板 | 基于模板Id获取Prompt模板。 |
| UpdatePromptTemplate | 更新Prompt模板 | 基于模板Id增量更新Prompt模板。 |
| DeletePromptTemplate | 删除Prompt模板 | 基于模板Id删除Prompt模板。 |
| ListPromptTemplates | 获取Prompt模板列表 | 获取Prompt模板列表。 |
| ListPromptTemplates | 获取Prompt模板列表 | 获取Prompt模板列表。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| ApplyTempStorageLease | 申请临时文件上传许可 | 该接口用于高代码部署，其他场景暂不支持。用于申请临时文件上传许可，之后需要自己完成文件上传动作。 |