GetBatchInferenceJob - 获取批量推理任务信息--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

GetBatchInferenceJob - 获取批量推理任务信息

最近更新时间：2024.11.04 19:30:22首次发布时间：2024.09.29 10:33:19

获取批量推理任务

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	GetBatchInferenceJob	要执行的操作，取值：GetBatchInferenceJob。
Version	String	是	2024-01-01	API的版本，取值：2024-01-01。
Id	String	是	-	批量推理任务的ID

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Id	String	-	批量推理任务的ID
Name	String	-	批量推理任务名称
Description	String	-	批量推理任务描述
InputFileTosLocation	Object	-	批量推理任务传入的文件的TOS地址
OutputDirTosLocation	Object	-	批量推理任务的结果输出的TOS地址
ErrorFileTosLocation	Object	-	批量推理任务输出的错误信息的TOS地址
CompletionWindow	String	-	批量推理任务的最大等待时间
Status	Object	-	批量推理任务的状态元信息
ModelReference	Object	-	批量推理任务选中的模型
RequestCounts	Object	-	批量推理任务的request数量
TokenUsage	Object	-	批量推理任务的token用量
Tags	Array of Object	-	批量推理任务绑定的标签
ProjectName	String	-	项目名称
CreateTime	String	-	批量推理任务创建时间，RFC3339格式
UpdateTime	String	-	批量推理任务更新时间，RFC3339格式
ExpireTime	String	-	批量推理任务到期时间，RFC3339格式

请求示例

{
    "Id": "7WtYtkPG9x"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024091910512025A35A851624E4541879",
        "Action": "GetBatchInferenceJob",
        "Version": "2024-01-01",
        "Service": "ark",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "bi-20240918194641-r2nwq",
        "Name": "批量推理任务",
        "Description": "这是一个批量推理任务",
        "InputFileTosLocation": {
            "BucketName": "my-bucket-name",
            "ObjectKey": "batch-inference-job/dataset/my-job.jsonl"
        },
        "OutputDirTosLocation": {
            "BucketName": "my-bucket-name",
            "ObjectKey": "batch-inference-job/output/"
        },
        "CompletionWindow": "1d",
        "Status": {
            "Phase": "Completed",
            "PhaseTime": "2024-09-18T11:50:00Z",
            "Message": "批量推理任务已完成"
        },
        "ModelReference": {
            "FoundationModel": {
                "Name": "doubao-pro-32k",
                "ModelVersion": "240615"
            }
        },
        "RequestCounts": {
            "Total": 2,
            "Completed": 2,
            "Failed": 0
        },
        "Tags": [
            {
                "Key": "sys:ark:createdBy",
                "Value": "IAMUser/30805480/test@bytedance.com"
            },
            {
                "Key": "test_key",
                "Value": "test_value"
            }
        ],
        "ProjectName": "default",
        "CreateTime": "2024-09-18T11:46:41Z",
        "UpdateTime": "2024-09-18T11:50:00Z",
        "ExpireTime": "2024-09-19T11:46:41Z"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。