获取批量推理任务列表
本接口用于获取批量推理任务列表。
权限说明
调用本文API,需符合以下权限要求,权限介绍及分配,请查看角色与权限控制列表、账号创建与权限分配。需具有以下任一权限:
- 完全控制千帆大模型平台的权限:QianfanFullControlAccessPolicy
- 运维操作千帆大模型平台推理服务的权限:QianfanServiceOperateAccessPolicy
- 只读访问千帆大模型平台推理服务的权限:QianfanServiceReadAccessPolicy
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求参数
方法名称,固定值DescribeBatchInferenceTasks
运行状态过滤条件,可选值如下
· Queuing:排队中
· Running:运行中
· Done:运行完成
· Stopping:运行终止中
· Stopped:运行终止
· Failed:运行失败
· Expired:运行超时
显示子属性
隐藏子属性
本次查询的起始位置,默认从第一条数据开始
返回的列表长度最大为100,默认值是10,如果指定的值大于100,按100操作
是否倒序,默认为false
POST /v2/batchinference?Action=DescribeBatchInferenceTasks HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"marker": "infer-n509xxxhqq3"
}
示例代码
curl -i --location 'https://qianfan.baidubce.com/v2/batchinference?Action=DescribeBatchInferenceTasks'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a5xxxx74525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"marker": "infer-n509xxxhqq3"
}'
返回响应
请求ID
显示子属性
隐藏子属性
任务列表
显示子属性
隐藏子属性
显示子属性
隐藏子属性
任务ID
任务名称
任务描述
推理服务endpoint
模型版本ID
推理服务参数配置
显示子属性
隐藏子属性
暂无参数
任务运行状态
· Queuing:排队中
· Running:运行中
· Done:运行完成
· Stopping:运行终止中
· Stopped: 运行终止
· Failed:运行失败
· Expired:运行超时
任务运行失败时返回的错误码,即当runStatus=Failed,返回该字段
任务运行失败时返回的错误原因,即当runStatus=Failed,返回该字段
数据输入bos目录
数据输出bos目录,固定输出格式为jsonl
数据输出任务目录
成功处理的输入总token数,当任务运行状态为Done时返回该字段
成功处理的输出总token数,当任务运行状态为Done时返回该字段
已处理的数据条数
总数据条数
任务来源,说明:
· batchInference:批量推理
· modelEval:模型评估
· inferenceDataset:推理数据集
数据格式,说明:
· default
· src_tgt
· role
任务创建人
任务创建时间
任务结束时间
推理任务接口版本:
· 1:推理服务V1版本接口,默认使用V1版本
· 2:推理服务V2版本接口
分页信息
显示子属性
隐藏子属性
本次查询的起始位置
请求返回的最大数目
是否只返回了部分数据,说明:
· false:表示本次已经返回所有结果
· true
· 表示本次还没有返回所有结果
当isTruncated为true时,才返回此项,作为下次查询marker的值
{
"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",
"dataFormat": "default",
"creator": "accountName",
"createTime": "2024-01-16T09:48:35Z",
"finishTime": "2024-01-16T10:48:35Z",
"version": 1
}
],
"pageInfo": {
"marker": "infer-n50985crhqq3",
"maxKeys": 1,
"isTruncated": false
}
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
| 名称 | 描述 |
|---|---|
requestId |
请求ID |
code |
错误码 |
message |
错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。
评价此篇文章
