更新时间:2024-05-06 GMT+08:00

处理结果查询

功能介绍

查询批量图片内容审核任务的结果,任务成功执行时会返回每张图片的详细审核结果,单张图片的失败,不会导致任务失败。

任务最长保留时间为30分钟,过期后会被清理掉。建议在任务提交后,每30s进行一次周期查询。

URI

GET /v2/{project_id}/moderation/image/batch

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

job_id

String

任务标识。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

CheckResultResultBody object

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

调用失败时无此字段。

表5 CheckResultResultBody

参数

参数类型

描述

job_id

String

任务标识。

status

String

任务状态。

  • created:已创建
  • running:正在处理
  • finish:已完成
  • failed:处理失败

create_time

String

任务创建的时间。例如:2018-01-02T15:03:04Z

update_time

String

任务最近更新的时间。例如:2018-01-02T15:03:04Z

items

Array of CheckResultItemsBody objects

图片内容检测的结果列表。

表6 CheckResultItemsBody

参数

参数类型

描述

url

String

图片的URL路径。

suggestion

String

审核结果是否通过。

  • block:包含敏感信息,不通过
  • pass:不包含敏感信息,通过
  • review:需要人工复检
说明:
  1. 当同时检测多个场景时,suggestion的值以最可能包含敏感信息的场景为准。即任一场景出现了block则总的suggestion为block,所有场景都pass时suggestion为pass,这两种情况之外则一定有场景需要review,此时suggestion为review。
  2. 目前本服务不会保存客户的调用结果(如block的历史信息),因为涉及到客户的数据隐私问题,建议您保留接口调用结果的日志信息。

detail

ImageDetectionResultDetail object

针对选定的每个检测场景列出结果列表,porn为涉黄检测结果。如果检测场景中的最高置信度也未达到threshold则结果列表为空。

category_suggestions

Map<String,String>

具体每个场景的检测结果。

  • block:包含敏感信息,不通过
  • pass:不包含敏感信息,通过
  • review:需要人工复检

ocr_text

String

ocr识别结果。

表7 ImageDetectionResultDetail

参数

参数类型

描述

porn

Array of ImageDetectionResultSimpleDetail objects

涉黄检测结果。

表8 ImageDetectionResultSimpleDetail

参数

参数类型

描述

confidence

Float

置信度,取值范围 0-1。

label

String

每个检测结果的标签化说明:

porn:label为对应的涉黄分类(涉黄、性感等)信息。

  • 鉴黄场景当前支持label列表如下:
    • normal:正常
    • porn:色情
    • sexy:性感

状态码: 400

表9 响应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?job_id={job_id}”“project_id”为项目ID,获取方法请参见获取项目ID“job_id”为接口返回的job_id

GET https://{endpoint}/v2/{project_id}/moderation/image/batch?job_id={job_id}

响应示例

状态码: 200

成功响应示例

{
  "result" : {
    "job_id" : "44d93b70-db01-4f96-a618-2a79c964c4b2",
    "status" : "finish",
    "create_time" : "2018-01-02T15:03:04Z",
    "update_time" : "2018-01-02T15:03:04Z",
    "items" : [ {
      "url" : "https://obs-test-llg.obs.myhuaweicloud.com/terrorism",
      "suggestion" : "pass",
      "detail" : {
      }
    }, {
      "url" : "https://obs-test-llg.obs.myhuaweicloud.com/clarity-detect",
      "suggestion" : "pass",
      "detail" : {
      },
      "ocr_text" : "fdfefdfdfdfd"
    } ]
  }
}

状态码: 400

失败响应示例

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

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码