创建批量推理任务。
为了避免异常情况下重复提交任务带来额外推理和计费,平台在创建批量推理任务时提供幂等控制:当用户、项目名(Project Name)、存储桶(bucket)和输入文件名(object-key)完全相同时,平台仅保留一个任务处于活跃状态(运行或排队),其他重复提交将报错,并在错误信息中包含在运行或排队中任务的ID,供用户查询。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | CreateBatchInferenceJob | 要执行的操作,取值:CreateBatchInferenceJob。 |
Version | String | 是 | 2024-01-01 | API的版本,取值:2024-01-01。 |
ProjectName | String | 否 | my-project |
|
Name | String | 是 | my-batch-Inference-job | 批量推理任务名称 |
Description | String | 否 | my-batch-Inference-job | 批量推理任务描述 |
ModelReference | Object | 是 | - | 批量推理任务选择的模型。CustomModelId(定制模型)、FoundationModel(基础模型),两个参数需要指定一个。 |
InputFileTosLocation | Object | 是 | - | 批量推理输入的文件 |
OutputDirTosLocation | Object | 是 | - | 批量推理任务输出结果的文件夹 |
CompletionWindow | String | 否 | - | 批量推理任务的最大等待时间 |
Tags | Array of Object | 否 | - | 批量推理任务绑定的标签 |
DryRun | Boolean | 否 | true | 是否仅对此请求进行预检。
|
下表仅列出本接口特有的返回参数。更多信息请参见返回结构。
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
Id | String | bi-20240918****-r2*** | 批量推理任务的Id |
POST /?Action=CreateBatchInferenceJob&Version=2024-01-01 HTTP/1.1 Host: open.volcengineapi.com Content-Type: application/json; charset=UTF-8 X-Date: 20240514T132743Z X-Content-Sha256: 287e874e******d653b44d21e Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240514/cn-beijing/ark/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f { "Name": "批量推理任务", "Description": "这是一个批量推理任务", "ModelReference": { "FoundationModel": { "Name": "doubao-pro-32k", "ModelVersion": "240615" } }, "InputFileTosLocation": { "BucketName": "my-bucket-name", "ObjectKey": "batch-inference-job/dataset/my-job.jsonl" }, "OutputDirTosLocation": { "ObjectKey": "batch-inference-job/output/", "BucketName": "my-bucket-name" }, "ProjectName":"default", "CompletionWindow": "1d", "Tags": [ { "Key": "test_key", "Value": "test_value" } ] }
{ "ResponseMetadata": { "RequestId": "20240918194640ECB302768CB287CEDAC6", "Action": "CreateBatchInferenceJob", "Version": "2024-01-01", "Service": "ark", "Region": "cn-beijing" }, "Result": { "Id": "bi-2024091****-****" } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | DryRunOperation | DryRun请求通过了全部检查,空运行成功。 |
400 | InvalidParameter.{{Parameter}} | 请求参数值不合法。请检查参数值的正确性后重试。 |
403 | AccessDenied | 请求未通过IAM权限验证。 |
403 | OperationDenied.InputFileTosLocation | |
500 | InternalError | 未知错误,请稍后重试。如果多次尝试仍失败,请提交工单。 |