API列表
更新时间:2024-11-14
千帆ModelBuilder提供了丰富的平台功能OpenAPI能力:
- 批量预测:提供创建批量预测任务、获取批量预测任务详情等能力。
- TPM配额管理:提供了购买TPM配额、查询配额信息等能力。
- 私有资源池服务付费:提供了购买算力单元实例、查询算力单元实例列表或信息等能力。
- 模型服务:提供创建服务、获取服务详情等API能力。
- 模型管理:提供获取模型、模型版本详情及将训练任务发布为模型等API能力。
- 模型调优:提供创建训练任务、任务运行、停止任务运行及获取任务运行详情等API能力。
- 数据管理:提供创建数据集、导入导出数据集等API能力。
- Prompt工程:提供模板、Prompt评估、Prompt优化等相关API能力。
- 系统记忆:提供创建系统记忆、查询系统记忆等能力。
- 实例资源自动续费:提供创建实例资源自动续费规则API能力。
批量预测
API名称 | 介绍 |
---|---|
创建批量预测任务 | 用于创建批量预测任务。 |
获取批量预测任务详情 | 用于获取批量预测任务详情。 |
获取批量预测任务列表 | 用于获取批量预测任务列表。 |
停止批量预测任务 | 用于停止批量预测任务。 |
删除批量推理任务 | 用于根据任务ID删除批量预测任务。 |
TPM配额管理
API名称 | 介绍 |
---|---|
购买TPM&RPM配额 | 用于购买TPM&RPM配额。 |
查询TPM&RPM配额信息详情 | 用于查询预置服务TPM&RPM配额信息。 |
终止按小时后付费TPM&RPM配额 | 用于终止按小时后付费TPM&RPM配额。 |
TPM配额实例变配 | 用于创建TPM配额实例的变配订单。 |
修改TMP后付费自动释放时间 | 用于修改后付费TMP配额自动释放时间。 |
私有资源池服务付费
API名称 | 介绍 |
---|---|
购买算力单元实例 | 用于购买当前服务部署所需的算力单元实例。 |
查询算力单元实例列表 | 用于查询当前服务已使用的全部或特定算力单元实例列表。 |
查询算力单元实例信息 | 用于查询当前服务已使用的全部或特定算力单元实例信息。 |
终止算力单元后付费实例 | 用于终止算力单元后付费实例。 |
修改算力单元后付费自动释放时间 | 用于修改算力单元示例后付费自动释放时间。 |
模型服务
大模型服务提供了全面的在线服务管理功能,满足不同大语言模型业务场景的需要。大模型服务提供了以下API能力。
注意:推荐使用以下模型服务接口,功能更全面、且接口更规范。历史V1版本接口文档已下线,为避免影响使用,建议接入以下新版接口。
API名称 | 介绍 |
---|---|
创建定制服务 | 用于创建服务。 |
更新定制服务 | 用于更新服务基础模型版本。 |
获取定制服务列表 | 用于获取服务列表。 |
获取定制服务详情 | 用于获取服务详情,如服务ID、模型ID、模型版本ID、服务名称、类型等。 |
查询服务调用情况 | 用于查询服务调用情况。 |
获取预置服务列表 | 用于获取预置服务列表。 |
服务绑定bls日志集 | 用于预置服务和定制服务绑定bls日志集。 |
服务解绑bls日志集 | 用于预置服务和定制服务解绑bls日志集。 |
模型管理
模型管理用于集中管理平台训练、压缩及预置的生成式大模型,支持对模型进行评估、压缩及部署大模型管理提供了以下API能力。
注意:推荐使用以下模型管理接口,功能更全面、且接口更规范。历史V1版本接口文档已下线,为避免影响使用,建议接入以下新版接口。
API名称 | 介绍 |
---|---|
新建我的模型 | 用于新建我的模型。 |
获取预置模型列表 | 用于获取预置模型列表。 |
获取我的模型列表 | 用于获取我的模型列表。 |
获取模型详情 | 用于获取模型详情。 |
删除我的模型 | 用于根据模型ID删除我的模型。 |
新建我的模型版本 | 用于新建我的模型版本。 |
上传自定义对话模板文件 | 用于在新建导入的huggingface对话模型版本时,上传自定义的对话模板配置文件。 |
获取导入模型平台预置高级配置 | 用于新建我的模型版本时,获取导入模型平台预置高级配置。 |
获取模型版本详情 | 用于获取模型版本详情,如模型版本名称、描述、创建时间、输入输出模式、输入输出模式限制等。 |
获取模型版本的高级配置 | 用于获取模型版本的自定义高级配置。 |
删除我的模型版本 | 用于删除我的模型版本。 |
创建模型版本导出任务 | 用于创建模型版本导出任务。 |
获取模型版本打包导出任务 | 用于获取模型版本打包导出任务,不包含失败任务。 |
模型调优
大模型训练指基于基础模型的Fine-Tuning的训练模式,开发者可以选择适合自己任务场景的训练模式并加以调参训练,从而实现理想的模型效果;也可以通过RLHF训练模式,依次训练奖励模型和利用强化学习机制,训练得到性能更优的模型。大模型训练支持以下API能力。
- 模型精调
API名称 | 介绍 |
---|---|
创建模型精调作业 | 用于创建模型精调作业。 |
获取模型精调作业列表 | 用于获取模型精调作业列表。 |
删除模型精调作业 | 用于删除模型精调作业。 |
创建模型精调任务 | 用于创建模型精调任务。 |
获取模型精调任务列表 | 用于获取模型精调任务列表。 |
获取模型精调任务详情 | 用于获取模型精调任务详情。 |
停止模型精调任务 | 用于停止模型精调任务。 |
删除模型精调任务 | 用于删除模型精调任务。 |
- 模型评估V2
API名称 | 说明 |
---|---|
创建模型评估任务 | 用于创建模型评估任务。 |
查看模型评估任务详情 | 用于根据评估任务id,查看模型评估任务详情。 |
查看模型评估任务报告 | 用于根据评估任务id,查看模型评估任务报告。 |
删除模型评估任务 | 用于根据评估任务id,删除模型评估任务。 |
查看模型评估任务列表 | 用于查看可评估模型列表。 |
- 模型评估V1
推荐使用模型评估V2版本接口,功能更全面、且接口更规范。
API名称 | 说明 |
---|---|
创建模型评估任务 | 用于创建并启动模型评估任务。 |
查看模型评估详情 | 用于获得模型评估任务详情。 |
查看模型评估报告 | 用于获取评估报告(整体指标)。 |
停止模型评估任务 | 用于停止模型评估任务,目前只支持纯自动评估任务的停止,当评估包含人工评估模式的时候,不允许停止。 |
查看可评估模型列表 | 用于查看可评估模型列表。 |
查看模型评估结果列表 | 用于查看模型评估结果列表。 |
批量删除模型评估 | 用于删除模型评估任务。 |
发起模型评估结果导出任务 | 用于发起评估结果导出任务。 |
查看模型评估结果导出任务状态 | 用于查看模型评估结果导出任务状态。 |
- 模型压缩
API名称 | 说明 |
---|---|
创建模型压缩任务 | 用于创建模型压缩任务。 |
查看模型压缩任务列表 | 用于查看模型压缩任务列表。 |
获取模型压缩任务详情 | 用于获取模型压缩任务详情。 |
停止模型压缩任务 | 用于停止模型压缩任务。 |
删除模型压缩任务 | 用于删除模型压缩任务。 |
数据管理
- 数据集管理
API名称 | 说明 |
---|---|
创建数据集 | 用于创建新的数据集。 |
获取数据集列表 | 用于获取符合特定查询条件的数据集列表。 |
删除数据集 | 根据数据集ID,删除数据集。 |
新增数据集版本 | 用于为数据集新增版本。 |
获取数据集版本详情 | 用于获取特定数据集版本的详情信息,如数据集名称、数据类型、版本信息等。 |
删除数据集版本 | 根据数据集版本ID,删除数据集特定版本。 |
发布数据集版本 | 用于发布数据集版本。 |
获取数据集版本列表 | 用于查询某数据集的版本列表。 |
获取数据集版本导入详情 | 用于获取数据集版本的导入任务详情。 |
发起数据集版本导入任务 | 用于对特定数据集版本发起数据导入任务。 |
获取数据集版本导出详情 | 用于获取数据集版本的导出任务详情。 |
发起数据集版本导出任务 | 用于对特定数据集版本发起数据导出任务。 |
- 数据清洗
API名称 | 说明 |
---|---|
创建数据清洗任务 | 用于创建数据清洗任务。 |
查看数据清洗任务详情 | 用于查看数据清洗任务详情。 |
查看清洗任务列表 | 用于查看清洗任务列表。 |
删除数据清洗任务 | 用于删除数据清洗任务。 |
- 数据增强
API名称 | 说明 |
---|---|
创建数据增强任务 | 用于创建数据增强任务。 |
查看数据增强详情 | 用于查看数据增强任务详情。 |
查看增强任务列表 | 用于查看增强任务列表。 |
删除数据增强任务 | 用于删除数据增强任务。 |
- 数据标注
API名称 | 说明 |
---|---|
样本标注 | 用于进行样本标注 |
获取样本列表 | 用于获取样本列表。 |
Prompt工程
Prompt工程指针对于Prompt进行结构、内容等维度进行优化的AI技术,它把大模型的输入限定在了一个特定的范围之中,进而更好地控制模型的输出。Prompt工程支持以下API能力。
注意:推荐使用以下Prompt工程接口,API功能更全面、且接口更规范。历史V1版本接口文档已下线,为避免影响使用,建议接入以下新版接口。
API名称 | 介绍 |
---|---|
获取Prompt模板列表 | 用于获取Prompt模板列表。 |
创建Prompt模板 | 用于创建Prompt模板。 |
获取单个Prompt模板详情 | 用于获取单个Prompt模板详情。 |
更新Prompt模板 | 用于更新Prompt模板。 |
删除Prompt模板 | 用于根据Prompt模版ID删除Prompt模板。 |
删除Prompt模板标签 | 用于根据标签ID,删除Prompt模板标签。 |
创建Prompt模板标签 | 用于新建Prompt模板标签。 |
获取Prompt模板标签列表 | 用于获取标签列表信息,如标签ID、标签名称、标签类型等。 |
系统记忆
API名称 | 介绍 |
---|---|
创建系统记忆 | 用于创建系统记忆。 |
查询系统记忆列表 | 用于查询系统记忆列表。 |
删除系统记忆 | 用于删除系统记忆,同时删除对应的系统记忆内容。 |
查询一言系统记忆 | 用于查询一言系统记忆。 |
更新一言系统记忆 | 用于更新一言系统记忆。 |
实例资源自动续费
API名称 | 介绍 |
---|---|
创建实例资源自动续费规则 | 用于创建实例资源自动续费规则。 |
历史版本
为提升开发者使用体验,平台升级了多个产品模块接口,功能更全面、且接口更规范。
针对历史版本接口,API文档迁移到历史文档,由于历史版本接口后续可能下线停止服务,为避免影响使用,建议接入新版本接口。历史版本接口文档,请查看平台功能OpenAPI-历史文档。