获取批量预测任务详情
更新时间:2024-04-30
功能介绍
本接口用于获取批量预测任务详情,如任务名称、任务描述、任务运行状态等。
注意事项
- 调用本文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 | 是 | 方法名称,固定值DescribeBatchInferenceTask |
Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
taskId | string | 是 | 任务ID,说明:只能通过调用创建批量预测任务接口,返回的字段taskId获取 |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
result | object | 请求结果 |
result说明
名称 | 类型 | 描述 |
---|---|---|
taskId | string | 任务ID |
name | string | 任务名称 |
description | string | 任务描述 |
endpoint | string | 推理服务endpoint |
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 | 已处理的数据条数 |
createTime | string | 任务创建时间 |
finishTime | string | 任务结束时间 |
示例
请求示例
curl --location 'https://qianfan.baidubce.com/v2/batchinference?Action=DescribeBatchInferenceTask' \
--header 'Authorization: bce-auth-v1/f0ee7a166xxxx79702c13/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58axxxxx3d080016e374525543' \
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \
--data '{
"taskId":"infer-9iaxxxwt9mp"
}'
响应示例
{
"requestId":"1bef3f87-c5b2-4419-936b-50f9884f10d4",
"result": {
"taskId":"infer-9iaxxx1wt9mp",
"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":"662f7bfb805xxxx516942",
"inputTokenUsage":10000,
"outputTokenUsage":10000,
"progress":100,
"createTime":"2024-01-16T09:48:35Z",
"finishTime":"2024-01-16T10:48:35Z"
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码,帮助理解和解决发生的错误 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如返回:
{
"requestId":"1bef3f87-xxx0f9884f10d4",
"code":"AccessDenied",
"message":"Access denied."
}
更多千帆大模型平台其他错误码,也可以查看错误码说明。