获取模型精调任务列表

更新时间：2024-12-23

接口描述

本接口用于获取模型精调任务列表。

权限说明

调用本文API，需符合以下权限要求，权限介绍及分配，请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限：

完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
只读访问千帆大模型平台的权限：QianfanReadAccessPolicy
完全控制千帆大模型平台模型调优的权限：QianfanModelTuningFullControlAccessPolicy
只读访问千帆大模型平台模型调优的权限：QianfanModelTuningReadAccessPolicy

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求结构

Bash

POST /v2/finetuning?Action=DescribeFineTuningTasks HTTP/1.1
Host: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json

{
    "jobId":"job-n50985crhqq3",
    "marker":"task-n50985crhqq3"
}

请求头域

除公共头域外，无其它特殊头域。

请求参数

Query参数

名称	类型	必填	描述
Action	string	是	方法名称，固定值DescribeFineTuningTasks

Body参数

名称	类型	必填	描述
jobId	string	是	作业ID，可以通过以下方式获取该参数值，以SFT为例说明：在控制台-模型精调页面，查看ID，如下图所示：
marker	string	否	本次查询的起始位置，默认从第一条数据开始
maxKeys	int	否	说明：（1）默认值是10 （2）返回的列表长度最大为100 （3）如果指定的值大于100，按100操作
pageReverse	bool	否	是否倒序，默认为false

响应头域

除公共头域外，无其它特殊头域。

响应参数

名称	类型	描述
requestId	string	请求ID
result	object	请求结果

result说明

名称	类型	描述
taskList	List<task>	任务列表
pageInfo	object	分页信息

task说明

名称	类型	描述
taskId	string	任务ID
jobId	string	作业ID
jobName	string	作业名称
jobDescription	string	作业描述
model	string	基础模型版本
trainMode	string	调优的训练模式
parameterScale	string	调优的参数规模
runStatus	string	任务运行状态，说明： · Running：运行中 · Done：运行完成 · Stopped：运行中止 · Failed：运行失败 · Waiting：排队中
metrics	object	评估指标，运行完成才会返回，目前只支持文本生成类型
checkpointList	List<checkpointItem>	checkpoint信息
createTime	string	任务创建时间
finishTime	string	任务结束时间
errorMessage	string	错误讯息
errorCode	int	错误码

metrics说明

名称	类型	描述
BLEU-4	string	评估指标BLEU-4
ROUGE-1	string	评估指标ROUGE-1
ROUGE-2	string	评估指标ROUGE-2
ROUGE-L	string	评估指标ROUGE-L

checkpointItem说明

名称	类型	描述
step	int	step
perplexity	float	perplexity
trainingLoss	float	trainingLoss

pageInfo说明

名称	类型	描述
marker	string	本次查询的起始位置
maxKeys	int	请求返回的最大数目
isTruncated	bool	是否只返回了部分数据，说明： · false：表示本次已经返回所有结果 · true：表示本次还没有返回所有结果
nextMarker	string	当isTruncated为true时，返回此参数，作为下次查询marker的值

请求示例

bash

curl --location 'https://qianfan.baidubce.com/v2/finetuning?Action=DescribeFineTuningTasks' \
--header 'Authorization: bce-auth-v1/f0ee7a166bxxxc13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfbxxx525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
    "jobId":"job-n50985crhqq3",
    "marker":"task-n50985crhqq3"
}'

响应示例

JSON

{
    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
    "result":{
        "taskList":[
            {
                "taskId":"task-0tgmn4a7h4i6",
                "jobId":"job-ftp4icwebtnc",
                "jobName":"job-name",
                "jobDescription":"job-description",
                "model":"ERNIE-Speed-8K",
                "trainMode":"SFT",
                "parameterScale":"FullFineTuning",
                "runStatus":"Done",
                "metrics": {
                   "BLEU-4": "17.03%",
                   "ROUGE-1": "30.83%",
                   "ROUGE-2": "12.37%",
                   "ROUGE-L": "29.14%"
                },
                "createTime":"2024-01-16T09:48:35Z",
                "finishTime":"2024-01-16T10:48:35Z"
            }
        ],
        "pageInfo":{
            "marker":"task-n50985crhqq3",
            "maxKeys":1,
            "isTruncated":false
        }
    }
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
requestId	请求ID
code	错误码
message	错误描述信息，帮助理解和解决发生的错误

例如错误返回：

{
    "requestId":"6ba7b810-xxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码，也可以查看错误码说明。

停止模型精调任务

获取模型精调任务详情