获取批量预测任务列表

更新时间：2024-09-30

功能介绍

用于获取批量预测任务列表。

注意事项

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

SDK调用

使用说明

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

调用示例

import os
import qianfan

# 使用安全认证AK/SK鉴权，通过环境变量方式初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
from qianfan.resources.console.data import Data

resp = Data.list_offline_batch_inference_task(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，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求地址的后缀
    "/v2/batchinference",
    // 调用本文API，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求参数-Query参数的Action
    "DescribeBatchInferenceTasks",
    // 对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看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，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求地址的后缀
                .route("/v2/batchinference")
                // 调用本文API，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求参数-Query参数的Action
                .action("DescribeBatchInferenceTasks")
                // 需要传入参数的场景，可以自行封装请求类，或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看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，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求地址的后缀
  //action:调用本文API，该参数值为固定值，无需修改；对应本文HTTP调用-请求说明-请求参数-Query参数的Action
  //data:对应本文HTTP调用-请求说明-请求参数-Body参数，具体使用请查看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',
                '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",
                "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",
                "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",
                "creator":"accountName",
                "createTime":"2024-01-16T09:48:35Z",
                "finishTime":"2024-01-16T10:48:35Z"
            }
        ],
        "pageInfo":{
            "marker":"infer-n50985crhqq3",
            "maxKeys":1,
            "isTruncated":false
        }
    }
}

请求参数

注意：以下为Python SDK参数说明，Go SDK、Java SDK、Node.js SDK参数说明请参考本文HTTP调用-请求说明。

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

返回参数

请参考本文HTTP调用-响应说明。

HTTP调用

鉴权说明

调用本文API，使用“安全认证/Access Key ”中的Access Key ID 和 Secret Access Key等进行鉴权，无法使用获取Access Token的方式鉴权，具体鉴权认证机制参考鉴权认证机制。

请求说明

基本信息

请求地址： https://qianfan.baidubce.com/v2/batchinference

请求方式： POST

Header参数

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

Query参数

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

Body参数

名称	类型	必填	描述
runStatus	List<string>	否	运行状态过滤条件，可选值如下 · Running: 运行中 · Done: 运行完成 · 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	任务运行状态 · Running: 运行中 · Done: 运行完成 · 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：推理数据集
creator	string	任务创建人
createTime	string	任务创建时间
finishTime	string	任务结束时间

pageInfo说明

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

请求示例

bash

curl --location 'https://qianfan.baidubce.com/v2/batchinference?Action=DescribeBatchInferenceTasks' \
--header 'Authorization: bce-auth-v1/f0ee7a166bxxxx02c13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58xxxx4525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
    "marker":"infer-n509xxxhqq3"
}''

响应示例

JSON

{
    "requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
    "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",
                "creator":"accountName",
                "createTime":"2024-01-16T09:48:35Z",
                "finishTime":"2024-01-16T10:48:35Z"
            }
        ],
        "pageInfo":{
            "marker":"infer-n50985crhqq3",
            "maxKeys":1,
            "isTruncated":false
        }
    }
}

错误码

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

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

例如返回：

{
    "requestId":"1bef3f87-xxx0f9884f10d4",
    "code":"AccessDenied",
    "message":"Access denied."
}

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

获取批量预测任务详情

停止批量预测任务

百度智能云

百度智能云千帆大模型服务与开发平台ModelBuilder