创建训练任务
更新时间:2024-09-23
注意:为提升开发者使用体验,平台升级了模型调优接口。推荐使用新版模型精调接口,功能更全面、且接口更规范,详见模型调优API列表;V1版本相关接口不再升级,已于2024年9月8日将本文档迁移至历史文档;由于V1版本接口后续可能下线停止服务,为避免影响使用,建议接入新版本接口。
功能介绍
本接口用于创建训练任务。
注意事项
本文接口能力不再升级,如果之前已接入使用,可继续使用;推荐使用模型精调V2版本。
SDK调用
使用说明
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan import resources
# 使用安全认证AK/SK鉴权,通过环境变量方式初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
# 创建任务
resp = resources.FineTune.create_task(name="task_name", description="task_desc")
# 获取返回结果
print(resp)
返回示例
QfResponse(code=200, headers={
...
},
body={
'log_id': '2291960321',
'result': {
'id': 12102,
'name': 'sdk_test_10',
'description': 'heihei',
'createTime': '2023-10-23 20:26:46'}
},
image=None)
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
name | string | 是 | 任务名称,字符串长度为 [2, 20] |
description | string | 否 | 任务描述,字符串长度为 [0, 500] |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 请求ID |
result | dict | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
id | int | 任务ID |
name | string | 任务名称 |
description | string | 任务描述 |
createTime | string | 创建时间 |
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址:https://qianfan.baidubce.com/wenxinworkshop/finetune/createTask
请求方式:POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 否 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
name | string | 是 | 任务名称,字符串长度为 [2, 20] |
description | string | 否 | 任务描述,字符串长度为 [0, 500] |
响应说明
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
id | int | 任务ID |
name | string | 任务名称 |
description | string | 任务描述 |
createTime | string | 创建时间 |
请求示例
# 替换下列示例中的Authorization值、x-bce-date值
curl --location 'https://qianfan.baidubce.com/wenxinworkshop/finetune/createTask' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"name":"test_name",
"description":"test_description"
}'
响应示例
{
"log_id":"123456789",
"result":{
"id":1,
"name":"test_name",
"description":"test_description",
"createTime":"2023-09-07 11:11:11"
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如参数错误返回:
{
"error_code": 500001,
"error_msg": "param invalid"
}
更多千其他错误码,也可以查看错误码说明。