资讯 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

获取任务运行详情

注意:为提升开发者使用体验,平台升级了模型调优接口。推荐使用新版模型精调接口,功能更全面、且接口更规范,详见模型调优API列表;V1版本相关接口不再升级,本文档内容不再更新;由于V1版本接口后续可能下线停止服务,为避免影响使用,建议接入新版本接口。

功能介绍

本接口用于获取训练运行详情信息,如任务名称、任务版本、训练方法、训练状态、任务运行时间等。

权限说明

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

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

HTTP调用

鉴权说明

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

请求说明

  • 基本信息

请求地址: https://qianfan.baidubce.com/wenxinworkshop/finetune/jobDetail

请求方式: POST

  • Header参数
名称 类型 必填 描述
Content-Type string 固定值:application/json
x-bce-date string 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z
Authorization string 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具
  • Body参数
名称 类型 必填 描述
taskId int 任务ID
jobId int 运行ID

响应说明

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

result说明

名称 类型 描述
id int 运行ID
description string 运行描述
taskId int 任务ID
taskName string 任务名称
version int 任务版本
jobRunType int 任务运行方式,说明:
· 普通训练:0
· 增量训练:1
increConfig object 增量训练,基础任务信息
trainType string 算法类型
trainMode string 训练方法
peftType string parameter efficient finetuning方式
trainStatus string 训练状态,说明:
· RUNNING:运行中
· FINISH:完成
· STOP:停止
· FAIL:失败
startTime string 任务开始时间
finishTime string 任务结束时间
runTime int 任务运行时长
trainTime int 训练时长
progress float 训练进度
vdlLink string 训练可视化链接

increConfig说明

名称 类型 描述
taskId int 基础任务ID
jobId int 基础任务运行ID

请求示例

# 替换下列示例中的Authorization值、x-bce-date值
curl --location 'https://qianfan.baidubce.com/wenxinworkshop/finetune/jobDetail' \
--header 'Authorization: bce-auth-v1/f0eexxxxx/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 '{
    "taskId": 7263,
    "jobId": 4612
}'

响应示例

{
    "log_id":"123",
    "result":
    {
        "id":1,
        "description":"desc",
        "taskId":1,
        "taskName":"test",
        "version":1,
        // 增量训练
        "jobRunType":1,
        "increConfig": {
            "taskId":362,
            "jobId":1264
        },
        "trainType":"ernieBotLite-v200",
        "trainMode":"SFT",
        "peftType":"ALL",
        "trainStatus":"FINISH",
        "startTime":"2023-05-05 00:00:00",
        "finishtime":"2023-05-05 01:00:00",
        "runTime":3600,
        "trainTime":1800,
        "progress":99,
        "vdlLink":"https://console.bce.baidu.com/qianfan/visualdl/index?displayToken=eyJydW5JZCI6InJ1bi10NGczZmZuMXpzampwZHFzIn0="
    }
}

SDK调用

平台支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用本文API,SDK调用说明文档请参考获取任务运行详情

错误码

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

名称 描述
error_code 错误码
error_msg 错误描述信息,帮助理解和解决发生的错误

例如参数错误返回:

{
  "error_code": 500001,
  "error_msg": "param invalid"
}

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

上一篇
创建任务运行
下一篇
停止任务运行