SDK功能列表
更新时间：2025-04-18
千帆ModelBuilder推理服务API兼容OpenAI API，SDK使用参考OpenAI SDK兼容介绍。
本文重点介绍使用千帆bce-qianfan-sdk支持的千帆ModelBuilder平台功能OpenAPI能力。
SDK 支持的功能
SDK支持的能力如下，不同语言SDK，支持的功能可能不同。
- 平台功能OpenAPI相关
| 模块 | 模块介绍 | Python SDK | Go SDK | Java SDK | Node.js SDK |
|---|---|---|---|---|---|
| 批量预测 | 提供创建预测任务、获取详情等能力。 | ✓ | ✓ | ✓ | ✓ |
| TPM配额管理 | 提供了购买TPM配额、查询配额信息等能力。 | ✓ | ✓ | ✓ | ✓ |
| 算力单元服务付费 | 提供了购买算力单元实例、查询算力单元实例列表或信息等能力。 | ✓ | ✓ | ✓ | ✓ |
| 模型服务 | 提供创建服务、获取服务详情等能力。 | ✓ | ✓ | ✓ | ✓ |
| 模型管理 | 提供获取模型、模型版本详情，获取用户/预置模型及将训练任务发布为模型等能力。 | ✓ | ✓ | ✓ | ✓ |
| 模型调优 | 提供创建训练任务、任务运行、停止任务运行及获取任务运行详情等能力。 | ✓ | ✓ | ✓ | ✓ |
| 数据管理 | 提供创建数据集等数据集管理、导入导出数据集任务、数据清洗任务管理等能力。 | ✓ | ✓ | ✓ | ✓ |
| Prompt工程 | 提供模板管理、Prompt优化任务、评估等相关能力。 | ✓ | ✓ | ✓ | ✓ |
| 系统记忆 | 提供创建系统记忆、查询系统记忆等能力。 | ✓ | ✓ | ✓ | ✓ |
| 实例资源自动续费 | 提供创建实例资源自动续费规则API能力。 | ✓ | ✓ | ✓ | ✓ |
| 用户记忆 | 提供创建用户记忆id、写入用户记忆内容等API能力。 | ✓ | ✓ | ✓ | ✓ |
平台功能OpenAPI相关
批量预测
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建批量预测任务 | 用于创建批量预测任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取批量预测任务详情 | 用于获取批量预测任务详情，如任务名称、任务描述、任务运行状态等。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取批量预测任务列表 | 用于获取批量预测任务列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 停止批量预测任务 | 用于停止批量预测任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除批量推理任务 | 用于根据任务ID，删除批量预测任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询支持批量推理模型清单 | 用于查询支持批量推理模型清单。 | 支持 | 支持 | 支持 | 支持 | API文档 |
TPM配额管理
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 购买TPM&RPM配额 | 购买TPM&RPM配额。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询TPM&RPM配额信息详情 | 查询预置服务TPM&RPM配额信息。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 终止按小时后付费TPM&RPM配额 | 用于终止按小时后付费TPM&RPM配额。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| TPM配额实例变配 | 用于创建TPM配额实例的变配订单。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 修改TMP后付费自动释放时间 | 用于修改后付费TMP配额自动释放时间。 | 支持 | 支持 | 支持 | 支持 | API文档 |
算力单元服务付费
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 购买算力单元实例 | 用于购买当前服务部署所需的算力单元实例。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询算力单元实例列表 | 用于查询当前服务已使用的全部或特定算力单元实例列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询算力单元实例信息 | 用于查询当前服务已使用的全部或特定算力单元实例信息。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 终止算力单元后付费实例 | 用于终止算力单元后付费实例。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 修改算力单元后付费自动释放时间 | 用于修改算力单元示例后付费自动释放时间。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 购买算力单元 | 用于购买算力单元。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询算力单元列表 | 用于筛选算力单元列表信息。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询算力单元详情 | 用于查询指定算力单元详细信息。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 算力单元变配 | 用于变更算力单元配置。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 释放后付费算力单元 | 用于释放算力单元。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 定时释放后付费算力单元 | 用于设置算力单元后付费定时释放时间。 | 支持 | 支持 | 支持 | 支持 | API文档 |
模型服务
模型服务开放以下能力，SDK及文档等支持情况如下。
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建定制服务 | 用于创建服务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 更新定制服务 | 用于更新服务基础模型版本。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取定制服务列表 | 用于获取服务列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取定制服务详情 | 用于获取服务详情，如服务ID、模型ID、模型版本ID、服务名称、类型等。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询服务调用情况 | 用于查询服务调用情况。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取预置服务列表 | 用于获取预置服务列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 服务绑定bls日志集 | 用于预置服务和定制服务绑定bls日志集。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 服务解绑bls日志集 | 用于预置服务和定制服务解绑bls日志集。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 下线定制服务 | 用于下线定制服务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 扩缩容定制服务 | 调整服务当前使用算力单元实例的部署副本数或为服务添加一个新的算力单元实例。 | 支持 | 支持 | 支持 | 支持 | API文档 |
模型管理
模型管理开放以下能力，SDK及文档等支持情况如下。
注意：推荐使用以下模型管理接口，功能更全面、且接口更规范。历史V1版本接口文档已下线，为避免影响使用，建议接入以下新版接口。
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 新建我的模型 | 用于新建我的模型。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取预置模型列表 | 用于获取预置模型列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取我的模型列表 | 用于获取我的模型列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取模型详情 | 用于获取模型详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除我的模型 | 用于根据模型ID删除我的模型。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 新建我的模型版本 | 用于新建我的模型版本。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 上传自定义对话模板文件 | 用于在新建导入的huggingface对话模型版本时，上传自定义的对话模板配置文件。 | 支持 | ✕ | ✕ | 支持 | API文档 |
| 获取导入模型平台预置高级配置 | 用于新建我的模型版本时，获取导入模型平台预置高级配置。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取模型版本详情 | 用于获取模型版本详情，如模型版本名称、描述、创建时间、输入输出模式、输入输出模式限制等。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取模型版本的高级配置 | 用于获取模型版本的自定义高级配置。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除我的模型版本 | 用于删除我的模型版本。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 创建模型版本导出任务 | 用于创建模型版本导出任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取模型版本打包导出任务 | 用于获取模型版本打包导出任务，不包含失败任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取预置模型详情 | 用于获取预置模型详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取预置模型版本详情 | 用于获取预置模型版本详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
模型调优
注意：推荐使用V2版本接口，V2版本API能力更全面、且接口更规范。V1版本接口功能不再升级，如果之前已接入使用，可继续使用。
- 模型精调
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建模型精调作业 | 用于创建模型精调作业。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 创建模型精调任务 | 用于创建模型精调任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 停止模型精调任务 | 用于停止模型精调任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取模型精调作业列表 | 用于获取模型精调作业列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取模型精调任务列表 | 用于获取模型精调任务列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取模型精调任务详情 | 用于获取模型精调任务详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除模型精调作业 | 用于删除模型精调作业。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除模型精调任务 | 用于删除模型精调任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
- 模型评估V2
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建模型评估任务 | 用于创建模型评估任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看模型评估任务详情 | 用于根据评估任务id，查看模型评估任务详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看模型评估任务报告 | 用于根据评估任务id，查看模型评估任务报告。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除模型评估任务 | 用于根据评估任务id，删除模型评估任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看模型评估任务列表 | 用于查看可评估模型列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 更新模型评估任务 | 用于更新模型评估任务信息。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看模型评估结果导出任务状态 | 用于获取模型评估导出任务状态信息。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 发起模型评估结果导出任务 | 用于创建模型评估结果导出任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 停止模型评估任务 | 用于停止模型评估任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
- 模型压缩
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建模型压缩任务 | 用于创建模型压缩任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看模型压缩任务列表 | 用于查看模型压缩任务列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取模型压缩任务详情 | 用于获取模型压缩任务详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 停止模型压缩任务 | 用于停止模型压缩任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除模型压缩任务 | 用于删除模型压缩任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
数据管理
数据管理开放以下能力，SDK及文档等支持情况如下。
- 数据集管理
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建数据集 | 用于创建新的数据集。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取数据集列表 | 用于获取符合特定查询条件的数据集列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除数据集 | 根据数据集ID，删除数据集。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 新增数据集版本 | 用于为数据集新增版本。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取数据集版本详情 | 用于获取特定数据集版本的详情信息，如数据集名称、数据类型、版本信息等。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除数据集版本 | 根据数据集版本ID，删除数据集特定版本。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 发布数据集版本 | 用于发布数据集版本。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取数据集版本列表 | 用于查询某数据集的版本列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取数据集版本导入详情 | 用于获取数据集版本的导入任务详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 发起数据集版本导入任务 | 用于对特定数据集版本发起数据导入任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取数据集版本导出详情 | 用于获取数据集版本的导出任务详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 发起数据集版本导出任务 | 用于对特定数据集版本发起数据导出任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
- 数据清洗
| API名称 | 说明 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建数据清洗任务 | 用于创建数据清洗任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看数据清洗任务详情 | 用于查看数据清洗任务详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看清洗任务列表 | 用于查看清洗任务列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除数据清洗任务 | 用于删除数据清洗任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
- 数据增强
| API名称 | 说明 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建数据增强任务 | 用于创建数据增强任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看数据增强详情 | 用于查看数据增强任务详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查看增强任务列表 | 用于查看增强任务列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除数据增强任务 | 用于删除数据增强任务。 | 支持 | 支持 | 支持 | 支持 | API文档 |
- 数据标注
| API名称 | 说明 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 样本标注 | 用于进行样本标注 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取样本列表 | 用于获取样本列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
Prompt工程
Prompt工程指针对于Prompt进行结构、内容等维度进行优化的AI技术，它把大模型的输入限定在了一个特定的范围之中，进而更好地控制模型的输出。
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 获取Prompt模板列表 | 用于获取Prompt模板列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 创建Prompt模板 | 用于创建Prompt模板。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取单个Prompt模板详情 | 用于获取单个Prompt模板详情。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 更新Prompt模板 | 用于更新Prompt模板。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除Prompt模板 | 用于根据Prompt模版ID删除Prompt模板。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除Prompt模板标签 | 用于根据标签ID，删除Prompt模板标签。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 创建Prompt模板标签 | 用于新建Prompt模板标签。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 获取Prompt模板标签列表 | 用于获取标签列表信息，如标签ID、标签名称、标签类型等。 | 支持 | 支持 | 支持 | 支持 | API文档 |
系统记忆
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建系统记忆 | 用于创建系统记忆。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询系统记忆列表 | 用于查询系统记忆列表。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除系统记忆 | 用于删除系统记忆，同时删除对应的系统记忆内容。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询一言系统记忆 | 用于查询一言系统记忆。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 更新一言系统记忆 | 用于更新一言系统记忆。 | 支持 | 支持 | 支持 | 支持 | API文档 |
实例资源自动续费
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建实例资源自动续费规则 | 用于创建实例资源自动续费规则。 | 支持 | 支持 | 支持 | 支持 | API文档 |
用户记忆
| API名称 | 介绍 | Python SDK |
Go SDK |
Java SDK |
Node.js SDK |
HTTP 调用 |
|---|---|---|---|---|---|---|
| 创建用户记忆id | 用于创建用户记id。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 写入用户记忆内容 | 用于在用户记忆中写入多条记忆内容，即更新一个appId 下某userMemoryId 的记忆内容。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询用户记忆内容 | 用于查询用户记忆内容，支持查询单个用户所有的记忆内容或单条记忆内容。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 查询应用内所有用户记忆id | 用于查询应用内所有用户记忆id，即根据用户提供的应用appId查询对应的用户所有的记忆内容。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 修改用户记忆内容 | 用于修改用户记忆中的单条记忆内容。 | 支持 | 支持 | 支持 | 支持 | API文档 |
| 删除用户记忆id和记忆内容 | 用于删除用户记忆id和对应的记忆内容。 | 支持 | 支持 | 支持 | 支持 | API文档 |
历史文档
为提升开发者使用体验，平台升级了多个产品模块接口，功能更全面、且接口更规范。
针对历史版本接口，API文档迁移到历史文档，由于历史版本接口后续可能下线停止服务，为避免影响使用，建议接入新版本接口。历史版本接口文档，请查看平台功能OpenAPI-历史文档。