创建任务运行
更新时间:2025-07-15
注意:为提升开发者使用体验,平台升级了模型调优接口。推荐使用新版模型精调接口,功能更全面、且接口更规范,详见模型调优API列表;V1版本相关接口不再升级,已于2024年9月8日将本文档迁移至历史文档;由于V1版本接口后续可能下线停止服务,为避免影响使用,建议接入新版本接口。
接口描述
本接口用于创建训练任务运行。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 完全控制千帆大模型平台模型调优的权限:QianfanModelTuningFullControlAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
Bash
1POST /wenxinworkshop/finetune/createJob HTTP/1.1
2Host: qianfan.baidubce.com
3Authorization: authorization string
4Content-Type: application/json
5
6{
7 "taskId": 362,
8 "description": "",
9 "jobRunType": 0,
10 "baseTraintype": "ERNIE-***",
11 "trainType": "ERNIE-***",
12 "trainMode": "SFT",
13 "pefttype": "ALL",
14 "trainConfig": {
15 "epoch": 1,
16 "learningRate": 0.00003,
17 "maxSeqLen": 4096
18 },
19 "trainset": [
20 {
21 "type": 1,
22 "id": 188
23 }
24 ],
25 "trainsetRate": 20
26}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
taskId | int | 是 | 任务ID |
description | string | 否 | 运行描述 |
jobRunType | int | 是 | 任务运行类型,可选值如下: · 0:普通训练 · 1:增量训练 |
increConfig | object | 否 | 增量训练基础任务信息 |
baseTrainType | string | 否 | 基础算法类型 |
trainType | string | 否 | 具体算法类型版本 |
trainMode | string | 否 | 训练方法 |
peftType | string | 否 | parameter efficient finetuning方式 |
trainConfig | object | 是 | 训练配置 |
trainset | array | 是 | 数据集配置 |
trainsetRate | float | 是 | 数据拆分比例,取值范围:[0,50] |
increConfig说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
taskId | int | 是 | 基础任务ID |
jobId | int | 是 | 基础任务运行ID |
trainConfig说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
epoch | int | 是 | 迭代轮次,取值范围:[1, 50] |
batchSize | int | 否 | 批处理大小 |
learningRate | float | 是 | 学习率 |
maxSeqLen | int | 否 | 序列长度 |
loggingSteps | int | 否 | 保存日志间隔 |
warmupRatio | float | 否 | 预热比例 |
weightDecay | float | 否 | 正则化系数 |
loraRank | int | 否 | LoRA 策略中的秩 |
loraAllLinear | string | 否 | LoRA 所有线性层 |
trainset说明
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
type | int | 是 | 数据集类型,可选值如下: 1:表示平台数据集 2:表示bos数据集 |
id | int | 否 | 数据集版本ID,当type为1时,该字段必传 |
bosPath | string | 否 | 数据集版本bos路径,当type为2时,该字段必传 |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
id | int | 运行ID |
请求示例
- 普通训练
bash
1# 替换下列示例中的Authorization值、x-bce-date值
2curl --location 'https://qianfan.baidubce.com/wenxinworkshop/finetune/createJob' \
3--header 'Authorization: bce-auth-v1/f0ee7a166b934f75b8703a8079702c13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8exxxxx525543' \
4--header 'x-bce-date: 2023-09-19T13:37:10Z' \
5--header 'Content-Type: application/json' \
6--data '{
7 "taskId": 362,
8 "description": "",
9 "jobRunType": 0,
10 "baseTraintype": "ERNIE-***",
11 "trainType": "ERNIE-***",
12 "trainMode": "SFT",
13 "pefttype": "ALL",
14 "trainConfig": {
15 "epoch": 1,
16 "learningRate": 0.00003,
17 "maxSeqLen": 4096
18 },
19 "trainset": [
20 {
21 "type": 1,
22 "id": 188
23 }
24 ],
25 "trainsetRate": 20
26}'
- 增量训练
bash
1curl --location 'https://qianfan.baidubce.com/wenxinworkshop/finetune/createJob' \
2--header 'Authorization: bce-auth-v1/f0ee7axxxx3/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8exxxxx525543' \
3--header 'x-bce-date: 2023-09-19T13:37:10Z' \
4--header 'Content-Type: application/json' \
5--data '{
6 "taskId": 362,
7 "description": "",
8 "jobRunType": 1,
9 "increConfig": {
10 "taskId":362,
11 "jobId":1264
12 },
13 "trainConfig": {
14 "epoch": 1,
15 "learningRate": 0.00003,
16 "maxSeqLen": 4096
17 },
18 "trainset": [
19 {
20 "type": 1,
21 "id": 188
22 }
23 ],
24 "trainsetRate": 20
25}'
响应示例
JSON
1{
2 "log_id":"123",
3 "result":{
4 "id":123
5 }
6}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如参数错误返回:
Plain Text
1{
2 "error_code": 500001,
3 "error_msg": "param invalid"
4}
更多其他错误码,也可以查看错误码说明。