CreateBatchInferenceJob - 创建批量推理任务--火山方舟大模型服务平台-火山引擎

文档中心

立即注册

导航

CreateBatchInferenceJob - 创建批量推理任务

最近更新时间：2024.11.28 15:53:17首次发布时间：2024.09.29 10:33:19

创建批量推理任务

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
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	是否仅对此请求进行预检。取值： true：发送检查请求。 false(默认)：发送正常请求。

返回参数

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

参数	类型	示例值	描述
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****-****"
  }
}

错误码

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