平台功能OpenAPI介绍
更新时间:2024-10-21
本文介绍了千帆ModelBuilder提供的平台功能OpenAPI能力,以及如何调用API的流程等。
API列表
千帆ModelBuilder提供了丰富的平台功能OpenAPI能力,包括TPM配额管理、私有资源池服务付费、Prompt工程、模型服务、模型管理、模型调优、数据管理、系统记忆等,详情请查看平台功能OpenAPI列表。
- TPM配额管理:提供了购买TPM配额、查询配额信息等能力。
- 私有资源池服务付费:提供了购买算力单元实例、查询算力单元实例列表或信息等能力。
- 模型服务:提供创建服务、获取服务详情等API能力。
- 模型管理:提供获取模型、模型版本详情,获取用户/预置模型及将训练任务发布为模型等API能力。
- 模型调优:提供创建训练任务、任务运行、停止任务运行及获取任务运行详情等API能力。
- 数据管理:提供创建数据集等数据集管理、导入导出数据集任务、数据清洗任务管理等API能力。
- Prompt工程:提供模板管理、Prompt优化任务、评估等API能力。
- 插件应用:提供知识库、智慧图问、天气等API能力。
- 系统记忆:提供创建系统记忆、查询系统记忆等能力。
HTTP调用流程
调用平台功能OpenAPI流程,请查看 基于安全认证AK和SK鉴权调用API流程。
注意:调用平台功能OpenAPI,需使用基于安全认证AK/SK进行鉴权。
SDK调用流程
千帆ModelBuilder提供了多种语言的SDK,开发者可使用SDK,快捷地开发功能,提升开发效率。更多SDK调用功能,请参考SDK介绍。
千帆ModelBuilder SDK已开源,欢迎广大开发者加入交流,详见千帆ModelBuilder SDK开源说明。
千帆ModelBuilder提供了以下语言SDK:
- Python SDK,支持 Python >= 3.7版本,请查看Python SDK安装及使用流程
- Go SDK,支持 Golang >= 1.18 版本,请查看Go SDK安装及使用流程
- Java SDK,支持 JDK >= 1.8 版本,请查看Java SDK安装及使用流程
- Node.js SDK,请查看Node.js SDK安装及使用流程
在线调试
千帆ModelBuilder提供了 API在线调试平台-示例代码 ,用于帮助开发者调试接口,平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能,简单易用,更多内容请查看API在线调试介绍。
命令行CLI工具
千帆ModelBuilder提供了命令行CLI工具,方便在命令行中直接使用相关功能,如提供了数据集dataSet、训练trainer等。
错误码
在调用API请求后,可以通过返回的错误码、错误信息及排查建议等进行问题排查,请参考错误码列表。