API功能分类与调用说明-大模型服务平台百炼-阿里云-大模型服务平台百炼(Model Studio)-阿里云帮助中心

API标准及多语言预置SDK

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

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

自定义签名场景

若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。

应用数据

API	标题	API概述
ListFile	文件列表	获取指定类目下一个或多个文档的详细信息。
ListCategory	类目列表	获取指定业务空间下一个或多个类目的详细信息。
AddFile	添加文件	将存储于阿里云百炼临时存储空间内的文件导入至阿里云百炼应用数据。
AddFilesFromAuthorizedOss	从已授权OSS Bucket中导入文件	将已授权OSS Bucket中的文件导入阿里云百炼应用数据中。
ApplyFileUploadLease	申请文件上传租约	请求一个上传租约用于上传知识库文件，或智能体应用会话交互的文件。
DescribeFile	查询文件状态	查询应用数据中文件的基本信息，包括文件名称、类型、状态等。
UpdateFileTag	更新文件标签	更新指定文件标签。
GetParseSettings	获取类目解析设置	查询指定类目的数据解析设置。
GetAvailableParserTypes	获取文件支持的解析器类型	根据输入的文件类型（文件扩展名），获取所有支持的解析器类型列表。
ChangeParseSetting	修改类目解析设置	配置特定文件类型的解析方式。例如，为 .pdf 文件指定使用大模型文档解析，为 .jpg 文件指定使用Qwen VL解析。

知识库

API	标题	API概述
CreateIndex	创建知识库	使用此API可创建两类知识库：基于文档或音视频的非结构化知识库，以及用于数据查询或图片问答的结构化知识库。
GetIndexJobStatus	查询知识库创建任务状态	查询指定的知识库创建任务或知识库追加任务的当前状态。
SubmitIndexJob	提交知识库创建任务	提交指定的 CreateIndex 任务以完成知识库创建。
SubmitIndexAddDocumentsJob	提交知识库追加任务	向指定知识库中追加导入已解析的文件。
Retrieve	检索知识库	在指定的知识库中检索信息。
ListIndexDocuments	查询知识库下的文件列表	获取指定知识库中的文件，以及它们的概要信息。
ListIndexFileDetails	查询知识库下的文件详情	获取指定知识库中的文件，以及它们的详细信息。
UpdateIndex	更新知识库	更新指定知识库的部分配置。
DeleteIndexDocument	删除知识库下的文件	永久删除指定知识库中的文件。
ListIndices	查询知识库列表	获取指定业务空间下知识库列表。
DeleteIndex	删除知识库	永久性删除指定的知识库。
ListChunks	查询索引下的分片列表	查看文本切片列表及信息。
UpdateChunk	修改切片	修改知识库中指定文本切片的内容（content）和标题（title），并设置是否参与知识库检索。
DeleteChunk	删除切片	删除知识库中的指定文本切片，被删的文本切片将无法被检索和召回。
GetIndexMonitor	获取知识库监控数据	调用GetIndexMonitor接口，查询指定知识库在特定时间范围内的监控数据。这些数据对于性能分析、容量规划和成本管理至关重要。监控数据主要包含两大维度：存储监控：获取知识库的索引存储限额和当前使用量。检索（QPS）监控：获取查询时间段内总的及按时间窗口细分的检索性能指标，包括QPS峰值、总请求数、平均QPS，并细分为成功、失败和被限流的请求。

Prompt工程

API	标题	API概述
CreatePromptTemplate	创建Prompt模板	创建Prompt模板。
GetPromptTemplate	获取Prompt模板	基于模板Id获取Prompt模板。
UpdatePromptTemplate	更新Prompt模板	基于模板Id增量更新Prompt模板。
DeletePromptTemplate	删除Prompt模板	基于模板Id删除Prompt模板。
ListPromptTemplates	获取Prompt模板列表	获取Prompt模板列表。

其他

API	标题	API概述
长期记忆（旧）	长期记忆（旧）
CreateMemory	创建长期记忆体	创建一个长期记忆体。
GetMemory	获取长期记忆体	获取指定长期记忆体的描述信息。
UpdateMemory	更新长期记忆体	更新指定长期记忆体的描述信息。
DeleteMemory	删除长期记忆体	永久性删除指定的长期记忆体。
ListMemories	获取长期记忆体列表	获取指定业务空间下一个或多个长期记忆体的详细信息。
CreateMemoryNode	创建记忆片段	创建记忆片段。
GetMemoryNode	获取记忆片段	获取记忆片段。
UpdateMemoryNode	更新记忆片段	更新记忆片段。
DeleteMemoryNode	删除记忆片段	删除记忆片段。
ListMemoryNodes	获取记忆片段列表	获取记忆片段列表。
GetAlipayTransferStatus	查询支付宝打赏状态	查询应用中绑定的支付宝钱包的打赏状态。
GetAlipayUrl	获取支付宝打赏URL	获取应用上支付宝的打赏链接。
ApplyTempStorageLease	申请临时文件上传许可	该接口用于高代码部署，其他场景暂不支持。用于申请临时文件上传许可，之后需要自己完成文件上传动作。
AddCategory	新增类目	在指定的业务空间中创建一个类目，用于分类和管理文件。每个业务空间最多创建500个类目。
AddTable	添加表格	为表格数据连接器添加表格。
DeleteCategory	删除类目	永久性删除指定的类目。
DeleteFile	删除文件	永久删除应用数据中的指定文件。不支持通过API删除数据表，详见下方接口说明。
UpdateTableFromAuthorizedOss	从已授权OSS Bucket中选择文件更新表格	使用已授权OSS Bucket中的文件更新阿里云百炼数据连接中表格连接器中的表格。