获取批量预测任务列表

更新时间：2025-01-10

功能介绍

用于批量预测任务列表。

使用说明

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

权限说明

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

完全控制千帆大模型平台的权限：QianfanFullControlAccessPolicy
运维操作千帆大模型平台预测服务的权限：QianfanServiceOperateAccessPolicy
只读访问千帆大模型平台预测服务的权限：QianfanServiceReadAccessPolicy

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/batchinference", 
    # 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeBatchInferenceTasks", 
    # 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    {
        "marker":"infer-n509xxxhqq3"
    }
)
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/batchinference",
    // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
    "DescribeBatchInferenceTasks",
    // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
    map[string]interface{}{
               "marker":"infer-n509xxxhqq3",
    })
    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/batchinference")
                // 调用本文API，该参数值为固定值，无需修改；对应API调用文档-请求参数-Query参数的Action 
                .action("DescribeBatchInferenceTasks")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明，根据实际使用选择参数；对应API调用文档-请求参数-Body参数
                .body(CollUtils.mapOf(
                    "marker","infer-n509xxxhqq3"
                ))
                .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/batchinference', action: 'DescribeBatchInferenceTasks', data: {
         "marker":"infer-n509xxxhqq3"
    }
  });    
    
  console.log(res);
}

main();

返回示例

{
    "requestId":"1bef3f87-c5b2-4419-936b-50xxxx0d4",
    "result":{
        "taskList":[
            {
                "taskId":"infer-9ia3kc1wt9mp",
                "name":"name",
                "description":"description",
                "endpoint":"http://xxx",
                "inferenceParams":{
                    "temperature":0.9,
                    "top_p":0.3
                },
                "runStatus":"Running",
                "inputBosUri":"bos:/user_a/bucket",
                "outputBosUri":"bos:/user_b/output",
                "outputDir":"662f7bfb8055376bcd516942",
                "inputTokenUsage":10000,
                "outputTokenUsage":10000,
                "progress":100,
                "totalDataCount":400,
                "taskSource":"batchInference",
                "dataFormat":"default",
                "creator":"accountName",
                "createTime":"2024-01-16T09:48:35Z",
                "finishTime":"2024-01-16T10:48:35Z"
            }
        ],
        "pageInfo":{
            "marker":"infer-n50985crhqq3",
            "maxKeys":1,
            "isTruncated":False
        }
    }
}

{
    "requestId":"1bef3f87-c5b2-4419-936b-50xxxx0d4",
    "result":{
        "taskList":[
            {
                "taskId":"infer-9ia3kc1wt9mp",
                "name":"name",
                "description":"description",
                "endpoint":"http://xxx",
                "inferenceParams":{
                    "temperature":0.9,
                    "top_p":0.3
                },
                "runStatus":"Running",
                "inputBosUri":"bos:/user_a/bucket",
                "outputBosUri":"bos:/user_b/output",
                "outputDir":"662f7bfb8055376bcd516942",
                "inputTokenUsage":10000,
                "outputTokenUsage":10000,
                "progress":100,
                "totalDataCount":400,
                "taskSource":"batchInference",
                "dataFormat":"default",
                "creator":"accountName",
                "createTime":"2024-01-16T09:48:35Z",
                "finishTime":"2024-01-16T10:48:35Z"
            }
        ],
        "pageInfo":{
            "marker":"infer-n50985crhqq3",
            "maxKeys":1,
            "isTruncated":false
        }
    }
}

{
    "requestId":"1bef3f87-c5b2-4419-936b-50xxxx0d4",
    "result":{
        "taskList":[
            {
                "taskId":"infer-9ia3kc1wt9mp",
                "name":"name",
                "description":"description",
                "endpoint":"http://xxx",
                "inferenceParams":{
                    "temperature":0.9,
                    "top_p":0.3
                },
                "runStatus":"Running",
                "inputBosUri":"bos:/user_a/bucket",
                "outputBosUri":"bos:/user_b/output",
                "outputDir":"662f7bfb8055376bcd516942",
                "inputTokenUsage":10000,
                "outputTokenUsage":10000,
                "progress":100,
                "totalDataCount":400,
                "taskSource":"batchInference",
                "dataFormat":"default",
                "creator":"accountName",
                "createTime":"2024-01-16T09:48:35Z",
                "finishTime":"2024-01-16T10:48:35Z"
            }
        ],
        "pageInfo":{
            "marker":"infer-n50985crhqq3",
            "maxKeys":1,
            "isTruncated":false
        }
    }
}

{
    "requestId":"1bef3f87-c5b2-4419-936b-50xxxx0d4",
    "result":{
        "taskList":[
            {
                "taskId":"infer-9ia3kc1wt9mp",
                "name":"name",
                "description":"description",
                "endpoint":"http://xxx",
                "inferenceParams":{
                    "temperature":0.9,
                    "top_p":0.3
                },
                "runStatus":"Running",
                "inputBosUri":"bos:/user_a/bucket",
                "outputBosUri":"bos:/user_b/output",
                "outputDir":"662f7bfb8055376bcd516942",
                "inputTokenUsage":10000,
                "outputTokenUsage":10000,
                "progress":100,
                "totalDataCount":400,
                "taskSource":"batchInference",
                "dataFormat":"default",
                "creator":"accountName",
                "createTime":"2024-01-16T09:48:35Z",
                "finishTime":"2024-01-16T10:48:35Z"
            }
        ],
        "pageInfo":{
            "marker":"infer-n50985crhqq3",
            "maxKeys":1,
            "isTruncated":false
        }
    }
}

请求参数

名称	类型	必填	描述
runStatus	List<string>	否	运行状态过滤条件，可选值如下 · Queuing：排队中 · Running：运行中 · Done：运行完成 · Stopping：运行终止中 · Stopped：运行终止 · Failed：运行失败 · Expired：运行超时
marker	string	否	本次查询的起始位置，默认从第一条数据开始
maxKeys	int	否	返回的列表长度最大为100，默认值是10，如果指定的值大于100，按100操作
pageReverse	bool	否	是否倒序，默认为false

返回参数

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

result说明

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

taskItem说明

名称	类型	描述
taskId	string	任务ID
name	string	任务名称
description	string	任务描述
endpoint	string	推理服务endpoint
modelId	string	模型版本ID
inferenceParams	object	推理服务参数配置
runStatus	string	任务运行状态 · Queuing：排队中 · Running：运行中 · Done：运行完成 · Stopping：运行终止中 · Stopped: 运行终止 · Failed：运行失败 · Expired：运行超时
errorCode	int	任务运行失败时返回的错误码，即当runStatus=Failed，返回该字段
errorReason	string	任务运行失败时返回的错误原因，即当runStatus=Failed，返回该字段
inputBosUri	string	数据输入bos目录
outputBosUri	string	数据输出bos目录，固定输出格式为jsonl
outputDir	string	数据输出任务目录
inputTokenUsage	int	成功处理的输入总token数，当任务运行状态为Done时返回该字段
outputTokenUsage	int	成功处理的输出总token数，当任务运行状态为Done时返回该字段
progress	int	已处理的数据条数
totalDataCount	int	总数据条数
taskSource	string	任务来源，说明： · batchInference：批量推理 · modelEval：模型评估 · inferenceDataset：推理数据集
dataFormat	string	数据格式，说明： · default · src_tgt · role
creator	string	任务创建人
createTime	string	任务创建时间
finishTime	string	任务结束时间

pageInfo说明

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

获取批量预测任务详情

停止批量预测任务