阿里云OpenAPI开发者门户

大模型服务平台百炼 - OpenAPI 概览2023-12-29
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
数据中心
OpenAPI 名称描述操作
AddCategoryhot在指定的业务空间中创建一个类目,用于分类和管理文档。每个业务空间最多创建500个类目查看文档去调试
AddFilehot将存储于百炼临时存储空间内的非结构化文档导入至百炼数据管理。不支持通过API导入结构化文档,请通过控制台导入查看文档去调试
ListFilehot获取指定类目下一个或多个文档的详细信息查看文档去调试
ListCategory获取指定业务空间下一个或多个类目的详细信息查看文档去调试
DescribeFilehot获取文档基本信息,包括文档名称、类型、状态等查看文档去调试
ApplyFileUploadLeasehot请求一个上传租约用于上传非结构化文档,或智能体应用会话交互的文件。不支持通过API创建结构化数据表并上传数据,请通过控制台操作查看文档去调试
UpdateFileTag更新指定文档标签查看文档去调试
DeleteCategory永久性删除指定的类目查看文档去调试
DeleteFile永久性删除指定的非结构化文档。暂不支持通过API删除结构化文档,详情请参见下方接口说明查看文档去调试
知识索引
OpenAPI 名称描述操作
CreateIndexhot创建一个非结构化知识库,并将一个或多个已解析的文档导入该知识库。不支持通过API创建结构化知识库,请通过控制台创建查看文档去调试
SubmitIndexJobhot提交指定的 CreateIndex 任务以完成知识库创建查看文档去调试
SubmitIndexAddDocumentsJobhot向一个非结构化知识库追加导入已解析的文档。结构化知识库暂不支持通过API追加导入新知识,详情请参见下方接口说明查看文档去调试
GetIndexJobStatushot查询指定的知识库创建任务或知识库追加任务的当前状态查看文档去调试
Retrievehot在指定的知识库中检索信息查看文档去调试
ListIndexDocuments获取指定知识库中一个或多个文档的详细信息查看文档去调试
ListChunks对于非结构化知识库,获取指定文档的所有切片的详细信息;对于结构化知识库,获取所有文本切片的详细信息查看文档去调试
ListIndices获取指定业务空间下一个或多个知识库的详细信息查看文档去调试
DeleteIndex永久性删除指定的知识库查看文档去调试
DeleteIndexDocument从指定的非结构化知识库中永久删除一个或多个文档。暂不支持通过API删除结构化知识库中的知识,详情请参见下方接口说明查看文档去调试
Prompt工程
OpenAPI 名称描述操作
CreatePromptTemplate创建Prompt模板查看文档去调试
GetPromptTemplate基于模板Id获取Prompt模板查看文档去调试
ListPromptTemplates获取Prompt模板列表查看文档去调试
UpdatePromptTemplate基于模板Id增量更新Prompt模板查看文档去调试
DeletePromptTemplate基于模板Id删除Prompt模板查看文档去调试
长期记忆
OpenAPI 名称描述操作
CreateMemory创建一个长期记忆体查看文档去调试
GetMemory获取指定长期记忆体的描述信息查看文档去调试
UpdateMemory更新指定长期记忆体的描述信息查看文档去调试
DeleteMemory永久性删除指定的长期记忆体查看文档去调试
ListMemories获取指定业务空间下一个或多个长期记忆体的详细信息查看文档去调试
CreateMemoryNode创建记忆片段查看文档去调试
GetMemoryNode获取记忆片段查看文档去调试
UpdateMemoryNode更新记忆片段查看文档去调试
DeleteMemoryNode删除记忆片段查看文档去调试
ListMemoryNodes获取记忆片段列表查看文档去调试