获取模型精调任务列表

更新时间：2025-01-14

功能介绍

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

使用说明

本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用，调用流程请参考SDK安装及使用流程。

SDK调用

调用示例

import os
from qianfan  import resources

# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"

resp = resources.console.utils.call_action(
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/finetuning", 
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeFineTuningTasks", 
    # 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    {
        "jobId":"job-n509xxxq3",
        "marker":"task-n509xxxqq3"
    }
)

print(resp.body)

package main
import (
    "context"
    "fmt"
    "os"
    "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
     // 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
    os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
    os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
    
    ca := qianfan.NewConsoleAction()
    
    res, err := ca.Call(context.TODO(),
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
    "/v2/finetuning",
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeFineTuningTasks",
    // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    map[string]interface{}{
               "jobId":"job-n50985crhqq3",
               "marker":"task-n50985crhqq3",
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(string(res.Body))
    
}

import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;

public class Dome {
    public static void main(String args[]){
        // 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
        Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
        
        ConsoleResponse<Map<String, Object>> response = qianfan.console()
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
                .route("/v2/finetuning")
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
                .action("DescribeFineTuningTasks")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
                .body(CollUtils.mapOf(
                        "jobId","job-n50985crhqq3",
                        "marker","task-n50985crhqq3"
                ))
                .execute();

        System.out.println(Json.serialize(response));
    }
}

import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";

// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');

async function main() {
  //base_api_route:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求结构-请求地址的后缀
  //action:调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
  //data:请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
  const res = await consoleAction({base_api_route: '/v2/finetuning', action: 'DescribeFineTuningTasks', data: {
        "jobId":"job-n509xxxq3",
        "marker":"task-n509xxxqq3"
    }
  });    
    
    console.log(res);
}
main();

返回示例

{
    "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
        }
    }
}

{
    "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
        }
    }
}

{
    "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
        }
    }
}

{
    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
        }
    }
}

请求参数

名称	类型	必填	描述
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的值

获取模型精调作业列表

获取模型精调任务详情