获取批量预测任务列表
更新时间:2024-07-25
功能介绍
用于获取批量预测任务列表。
SDK调用
使用说明
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见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)
返回示例
{
"requestId":"1bef3f87-c5b2-4419-936b-5xxxxxxxx4",
"result":{
"taskList":[
{
"taskId":"infer-9ixxxxxxmp",
"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":"662f7bfb80xxxd516942",
"inputTokenUsage":10000,
"outputTokenUsage":10000,
"progress":100,
"creator":"accountName",
"createTime":"2024-01-16T09:48:35Z",
"finishTime":"2024-01-16T10:48:35Z"
}
],
"pageInfo":{
"marker":"infer-n50985crhqq3",
"maxKeys":1,
"isTruncated":false
}
}
}
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
run_status | List[string] | 否 | 运行状态过滤条件,可选值如下 · Running: 运行中 · Done: 运行完成 · Stopped: 运行中止 · Failed: 运行失败 |
marker | string | 否 | 本次查询的起始位置,默认从第一条数据开始 |
max_keys | int | 否 | 返回的列表长度最大为100,默认值是10,如果指定的值大于100,按100操作 |
page_reverse | bool | 否 | 是否倒序,默认为false |
返回参数
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | dict | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
taskList | List[taskItem] | 任务列表 |
pageInfo | dict | 分页信息 |
taskItem说明
名称 | 类型 | 描述 |
---|---|---|
taskId | string | 任务ID |
name | string | 任务名称 |
description | string | 任务描述 |
endpoint | string | 推理服务endpoint |
modelId | string | 模型版本ID |
inferenceParams | dict | 推理服务参数配置 |
runStatus | string | 任务运行状态,说明: · Running: 运行中 · Done: 运行完成 · Stopped: 运行中止 · Failed: 运行失败 |
inputBosUri | string | 数据输入bos目录 |
outputBosUri | string | 数据输出bos目录,千帆固定输出格式为jsonl |
outputDir | string | 数据输出任务目录 |
inputTokenUsage | int | 成功处理的输入总token数,当任务运行状态为Done时返回该字段 |
outputTokenUsage | int | 成功处理的输出总token数,当任务运行状态为Done时返回该字段 |
progress | int | 已处理的数据条数 |
creator | string | 任务创建人 |
createTime | string | 任务创建时间 |
finishTime | string | 任务结束时间 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置 |
maxKeys | int | 请求返回的最大数目 |
isTruncated | bool | 是否只返回了部分数据,说明: · False:表示本次已经返回所有结果 · True:表示本次还没有返回所有结果 |
nextMarker | string | 说明:当isTruncated为True时,才返回此项,作为下次查询marker的值 |
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: 运行失败 |
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: 运行失败 |
inputBosUri | string | 数据输入bos目录 |
outputBosUri | string | 数据输出bos目录,千帆固定输出格式为jsonl |
outputDir | string | 数据输出任务目录 |
inputTokenUsage | int | 成功处理的输入总token数,当任务运行状态为Done时返回该字段 |
outputTokenUsage | int | 成功处理的输出总token数,,当任务运行状态为Done时返回该字段 |
progress | int | 已处理的数据条数 |
creator | string | 任务创建人 |
createTime | string | 任务创建时间 |
finishTime | string | 任务结束时间 |
pageInfo说明
名称 | 类型 | 描述 |
---|---|---|
marker | string | 本次查询的起始位置 |
maxKeys | int | 请求返回的最大数目 |
isTruncated | bool | 是否只返回了部分数据,说明: · false:表示本次已经返回所有结果 · true · 表示本次还没有返回所有结果 |
nextMarker | string | 说明:当isTruncated为true时,才返回此项,作为下次查询marker的值 |
请求示例
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"
}''
响应示例
{
"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":"662f7bfb80xxxd516942",
"inputTokenUsage":10000,
"outputTokenUsage":10000,
"progress":100,
"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."
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。