更新时间:2023-07-17 GMT+08:00

任务提交

功能介绍

提交异步批量图像内容审核任务,返回任务标识,任务标识可用于查询任务结果。此接口为异步接口,相对于批量图像内容审核接口,支持更大图片列表批次。

URI

POST /v2/{project_id}/moderation/image/batch/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。

表3 请求Body参数

参数

是否必选

参数类型

描述

urls

Array of strings

图片的URL路径,目前支持:

  • 公网HTTP/HTTPS URL
  • 华为云OBS提供的URL,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权。详请参见配置OBS访问权限
说明:

图片的URL路径列表最多支持500个URL地址。接口响应时间依赖图片的下载时间,如果图片下载时间过长,会返回接口调用失败。请保证被检测图片所在的存储服务稳定可靠,建议您使用华为云OBS存储。

categories

Array of strings

检测场景。

  • porn:涉黄内容元素的检测。

可通过配置上述场景,来完成对应场景元素的检测。

moderation_rule

String

图像审核规则名称,默认使用default规则。

说明:

审核规则的创建和使用请参见配置审核规则

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

result object

调用成功时表示调用结果。

调用失败时无此字段。

表5 result

参数

参数类型

描述

job_id

String

批量图像内容审核的任务标识,用于后续的结果查询。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

fail_category

String

当包含多个场景时,调用失败的场景。

请求示例

“endpoint”即调用API的请求地址,不同服务不同区域的endpoint不同,具体请参见终端节点

例如,服务部署在“中国-香港”区域的“endpoint”“moderation.ap-southeast-1.myhuaweicloud.com”,请求URL为“https://moderation.ap-southeast-1.myhuaweicloud.com/v2/{project_id}/moderation/image/batch/jobs”“project_id”为项目ID,获取方法请参见获取项目ID

提交异步批量图像内容审核任务,检测场景为涉黄。

POST https://{endpoint}/v2/{project_id}/moderation/image/batch/jobs

{
  "urls" : [ "https://bucketname.obs.myhwclouds.com/ObjectName1", "https://bucketname.obs.myhwclouds.com/ObjectName2" ],
  "categories" : [ "porn" ]
}

响应示例

状态码: 200

成功响应示例

{
  "result" : {
    "job_id" : "44d93b70-db01-4f96-a618-2a79c964c4b2"
  }
}

状态码: 400

失败响应示例

{
  "error_code" : "AIS.0005",
  "error_msg" : "The service does not exist."
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码