获取模型精调任务详情
更新时间：2024-11-20
功能介绍
本接口用于获取模型精调任务详情。
HTTP调用
鉴权说明
调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址：
https://qianfan.baidubce.com/v2/finetuning
请求方式： POST
- Header参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值application/json |
| x-bce-date | string | 否 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 |
- Query参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Action | string | 是 | 方法名称，固定值DescribeFineTuningTask |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| taskId | string | 是 | 任务ID，可以通过以下方法获取该字段，以SFT为例说明： 在控制台-模型精调列表页面，点击某个训练任务详情，在任务详情信息页查看，如下图所示：  |
响应说明
| 名称 | 类型 | 描述 |
|---|---|---|
| requestId | string | 请求ID |
| result | object | 请求结果 |
result说明
| 名称 | 类型 | 描述 |
|---|---|---|
| taskId | string | 任务ID |
| jobId | string | 作业ID |
| jobName | string | 作业名称 |
| jobDescription | string | 作业描述 |
| model | string | 基础模型版本 |
| trainMode | string | 调优的训练模式 |
| parameterScale | string | 调优的参数规模 |
| runStatus | string | 任务运行状态，说明： · Running: 运行中 · Done: 运行完成 · Stopped: 运行中止 · Failed: 运行失败 · Waiting：排队中 |
| runProgress | string | 训练进度，说明：只有任务运行状态运行中，才会返回此参数，即runStatus为Running时，返回该参数 |
| vdlLink | string | 训练可视化链接 |
| 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 |
请求示例
curl --location 'https://qianfan.baidubce.com/v2/finetuning?Action=DescribeFineTuningTask' \
--header 'Authorization: bce-auth-v1/f0ee7a1xxx3/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cxxx25543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"taskId":"task-0tgmn4a7h4i6"
}'响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result":{
"taskId":"task-0tgmn4a7h4i6",
"jobId":"job-ftp4icwebtnc",
"jobName":"job-name",
"jobDescription":"job-description",
"model":"ERNIE-Speed-8K",
"trainMode":"SFT",
"parameterScale":"FullFineTuning",
"runStatus":"Running",
"runProgress":"99%",
"vdlLink":"https://console.bce.baidu.com/qianfan/visualdl/index?displayToken=eyJydW5JZCI6InJ1bi10NGczZmZuMXpzampwZHFzIn0="
"createTime":"2024-01-16T09:48:35Z",
"finishTime":"2024-01-16T10:48:35Z"
}
}SDK调用
平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API，SDK调用说明文档请参考获取模型精调任务详情。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
| 名称 | 描述 |
|---|---|
| requestId | 请求ID |
| code | 错误码 |
| message | 错误描述信息，帮助理解和解决发生的错误 |
例如错误返回：
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}更多其他错误码，也可以查看错误码说明。