API概览

更新时间:
复制为 MD 格式

API标准及多语言预置SDK

本产品(人工智能平台 PAI - 大模型应用开发/2024-07-10)的 OpenAPI 采用 ROA 签名机制,具体签名方式请参见签名机制说明我们已为开发者封装了主流编程语言的 SDK,您可通过 下载 SDK 快速调用 API,无需关注签名等底层实现细节,显著降低开发门槛与集成复杂度。

自定义签名场景

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

账号与安全准备

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

运行时

API标题API概述
CreateRuntime创建运行时创建一个运行时。
UpdateRuntime更新运行时更新运行时。
GetRuntime获取运行时详情获取运行时的详情。
ListRuntimes获取运行时列表获取运行时列表。
DeleteRuntime删除运行时删除运行时。

部署任务

API标题API概述
CreateDeployment创建部署任务创建部署任务。
GetDeployment获取部署任务详情获取部署任务详情。
UpdateDeployment更新部署任务更新部署任务。
ListDeployments获取部署任务列表获取部署任务列表。
DeleteDeployment删除部署任务删除部署任务。

快照管理

API标题API概述
CreateSnapshot创建快照创建一个快照。
GetSnapshot获取快照详情获取快照详情。
UpdateSnapshot更新快照更新快照。
ListSnapshots获取快照列表获取快照列表。
DeleteSnapshot删除快照删除快照。

知识库

API标题API概述
CreateKnowledgeBase创建知识库创建一个知识库。
GetKnowledgeBase获取知识库获取知识库。
UpdateKnowledgeBase更新知识库更新知识库。
DeleteKnowledgeBase删除知识库删除知识库。
ListKnowledgeBases获取知识库列表获取知识库列表。
RetrieveKnowledgeBase检索知识库检索知识库。
CreateKnowledgeBaseJob创建知识库任务创建知识库任务。
GetKnowledgeBaseJob获取知识库任务获取知识库任务。
UpdateKnowledgeBaseJob更新知识库任务更新知识库任务。
DeleteKnowledgeBaseJob删除知识库任务删除知识库任务。
ListKnowledgeBaseJobs获取知识库任务列表获取知识库任务列表。
UpdateKnowledgeBaseChunk更新知识库切片更新知识库切片。
ListKnowledgeBaseChunks获取知识库切片列表获取知识库切片列表。