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

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

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

数据中心

API	标题	API概述
ListFile	文档列表	获取指定类目下一个或多个文档的详细信息。
DeleteCategory	删除类目	永久性删除指定的类目。
ListCategory	类目列表	获取指定业务空间下一个或多个类目的详细信息。
AddCategory	新增类目	在指定的业务空间中创建一个类目，用于分类和管理文档。目前对类目创建数量没有限制。
AddFile	添加文档	将存储于百炼临时存储空间内的非结构化文档导入至百炼数据管理。暂不支持通过API导入结构化文档，请通过控制台导入。
ApplyFileUploadLease	申请文档上传租约	请求文档上传租约，进行文档上传。暂不支持通过API上传结构化文档，请通过控制台上传。
DeleteFile	删除文档	永久性删除指定的非结构化文档。暂不支持通过API删除结构化文档，详情请参见下方接口说明。
DescribeFile	查询文档状态	获取文档基本信息，包括文档名称、类型、状态等。
UpdateFileTag	更新文档标签	更新指定文档标签。

知识索引

API	标题	API概述
CreateIndex	创建索引	创建一个非结构化知识库，并将一个或多个已解析的文档导入该知识库。暂不支持通过API创建结构化知识库，请通过控制台创建。
GetIndexJobStatus	查询索引创建任务状态	查询指定的知识库创建任务或知识库追加任务的当前状态。
SubmitIndexJob	提交索引创建任务	提交指定的 CreateIndex 任务以完成知识库创建。
SubmitIndexAddDocumentsJob	提交索引追加任务	向一个非结构化知识库追加导入已解析的文档。结构化知识库暂不支持通过API追加导入新知识，详情请参见下方接口说明。
Retrieve	检索知识索引	在指定的知识库中检索信息。
ListIndexDocuments	查询索引下的文档列表	获取指定知识库中一个或多个文档的详细信息。
ListChunks	查询索引下的分片列表	对于非结构化知识库，获取指定文档的所有切片的详细信息；对于结构化知识库，获取所有文本切片的详细信息。
ListIndices	查询索引列表	获取指定业务空间下一个或多个知识库的详细信息。
DeleteIndex	删除知识库索引	永久性删除指定的知识库。
DeleteIndexDocument	删除知识库索引文档	从指定的非结构化知识库中永久删除一个或多个文档。暂不支持通过API删除结构化知识库中的知识，详情请参见下方接口说明。

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概述
Memory	Memory
CreateMemory	创建长期记忆体	创建一个长期记忆体。
GetMemory	获取长期记忆体	获取指定长期记忆体的描述信息。
UpdateMemory	更新长期记忆体	更新指定长期记忆体的描述信息。
DeleteMemory	删除长期记忆体	永久性删除指定的长期记忆体。
ListMemories	获取长期记忆体列表	获取指定业务空间下一个或多个长期记忆体的详细信息。
MemoryNode	MemoryNode
CreateMemoryNode	创建长期记忆节点	创建长期记忆Node。
GetMemoryNode	获取长期记忆节点	获取长期记忆Node。
UpdateMemoryNode	更新长期记忆节点	更新长期记忆Node。
DeleteMemoryNode	删除长期记忆节点	删除长期记忆Node。
ListMemoryNodes	获取长期记忆节点列表	获取长期记忆Node列表。