获取模型精调作业列表
更新时间:2024-12-23
接口描述
本接口用于获取模型精调作业列表。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 只读访问千帆大模型平台的权限:QianfanReadAccessPolicy
- 完全控制千帆大模型平台模型调优的权限:QianfanModelTuningFullControlAccessPolicy
- 只读访问千帆大模型平台模型调优的权限:QianfanModelTuningReadAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求结构
POST /v2/finetuning?Action=DescribeFineTuningJobs HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"marker":"job-n50***qq3"
}
请求头域
除公共头域外,无其它特殊头域。
请求参数
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值DescribeFineTuningJobs |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
trainMode | string | 否 | 调优的训练模式类型,说明:该字段取值,请参考模型支持情况 |
model | string | 否 | 基础模型版本,支持对话续写类、图像生成类模型版本,具体值请查看模型支持情况-model值 |
marker | string | 否 | 本次查询的起始位置,默认从第一条数据开始 |
maxKeys | int | 否 | 说明: (1)默认值是10 (2)返回的列表长度最大为100 (3)如果指定的值大于100,按100操作 |
pageReverse | bool | 否 | 是否倒序,默认为false |
响应头域
除公共头域外,无其它特殊头域。
响应参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
jobList | List<job> | 作业列表 |
pageInfo | object | 分页信息 |
job说明
名称 | 类型 | 描述 |
---|---|---|
jobId | string | 作业ID |
name | string | 作业名称 |
description | string | 作业描述 |
model | string | 基础模型版本 |
trainMode | string | 调优的训练模式 |
createTime | string | 创建时间 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置 |
maxKeys | int | 请求返回的最大数目 |
isTruncated | bool | 是否只返回了部分数据,说明: · false:表示本次已经返回所有结果, · true:表示本次还没有返回所有结果 |
nextMarker | string | 当isTruncated为true时,返回此参数,作为下次查询marker的值 |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/finetuning?Action=DescribeFineTuningJobs' \
--header 'Authorization: bce-auth-v1/f0exxx3/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8eexxxx3' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"marker":"job-n50985crhqq3"
}'
响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"jobList":[
{
"jobId":"job-n50985crhqq3",
"name":"test_name",
"description":"test_description",
"model":"ERNIE-Speed-8K",
"trainMode":"SFT",
"createTime":"2024-01-16T09:48:35Z"
}
],
"pageInfo":{
"marker":"job-n50985crhqq3",
"maxKeys":1,
"isTruncated":false
}
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。