创建任务--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

创建任务

最近更新时间：2024.01.31 14:32:02首次发布时间：2023.12.28 11:22:02

本接口支持在指定服务下创建一条离线评估任务。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 5 秒。
前提条件：已开启画质评估组件能力。
计费说明：画质评估功能属于增值服务项，故使用后会产生增值服务费用，当前支持后付费和预付费资源包两种计费方式。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=CreateImageAnalyzeTask&Version=2023-05-01

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`CreateImageAnalyzeTask`	接口名称。当前 API 的名称为 `CreateImageAnalyzeTask`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
Name	String	是	`test`	自定义离线评估任务名称
Desc	String	否	`备注`	任务描述，可作为该条任务的备注信息。
Type	String	是	`UrlFile`	任务类型。取值如下所示： `UrlFile`：在线提交 URL 离线评估，即在.txt 文件（评估文件）内填写了待评估图片文件 URL，并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。 `UriFile`：在线提交 URI 离线评估，即在.txt 文件（评估文件）内填写了待评估图片文件 URI，并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
ServiceId	String	是	`4u***7a`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
ResUri	Array of String	否	`["tos-cn-i-4u***7a/URL.txt"]`	txt 评估文件的 StoreURI，该文件需上传至指定服务对应存储中。
Tpl	String	否	`tplv-xyz-xxx`	仅当`Type` 取值 `UriFile` 时，配置有效。模板名称，您可通过调用 GetAllImageTemplates 获取服务下所有已创建的 `TemplateName`。
EvalPerStage	Boolean	否	`false`	仅当`Type` 取值 `UriFile` 时，配置有效。是否模拟模板每阶段输出，取值如下所示： `true`：是，一个模版中可以选择多种图像处理, 模拟输出时会将所有的处理逐步叠加并编码为最终图片格式运行并输出评估结果。 `false`：否。
Region	String	是	`cn`	任务地区。当前仅支持取值 `cn`，表示国内。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`927930**028930`	任务 ID

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageAnalyzeTask&Version=2023-05-01
{
   "Name":"test",
   "Type":"UrlFile",
   "ServiceId":"4u***7a",
   "ResUri":[
      "tos-cn-i-4u***7a/URL.txt"
   ],
   "Region":"cn"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "CreateImageAnalyzeTask",
    "Version": "2023-05-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskId": "927930**028930"
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。