You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /
  • veImageX

创建审核任务

最近更新时间：2023.11.16 17:44:39

首次发布时间：2023.10.20 18:03:21

我的收藏

本接口支持在指定服务下创建审核任务。

注意事项

  • 请求频率：单用户请求频率限制为 5 次/秒。
  • 超时时间：超时时间约为 10 秒。
  • 前提条件：已开通智能审核组件能力。
  • 计费说明：智能审核功能属于增值服务项，故使用后会产生增值服务费用，当前支持后付费的计费方式。具体计费详情请参考后付费-按量计费。
  • 服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

  • 请求方式：POST
  • 请求地址：https://imagex.volcengineapi.com/?Action=CreateImageAuditTask&Version=2018-08-01

调试

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

请求参数

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

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

Query

参数类型是否必选示例值描述
ActionString是CreateImageAuditTask接口名称。当前 API 的名称为 CreateImageAuditTask。
VersionString是2018-08-01接口版本。当前 API 的版本为 2018-08-01。

Body

参数类型是否必选示例值描述

ServiceId

String

是

9u**6i

服务 ID。

  • 您可以在 veImageX 控制台 服务管理页面，在创建好的图片服务中获取服务 ID。
  • 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
TaskTypeString是audit任务类型，当前仅支持取值为 audit。

Type

String

是

UrlFile

图片审核任务场景。取值如下所示：

  • UrlFile：存量图片处理，进针对已有存储内的图片请求获取审核结果。传入方式是 ResUri方式，即在.txt 文件（审核文件）内填写了待审核图片文件 URL，并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
  • Url：URL 直传场景。传入方式为 ImageInfos 方式，即可直接传入待审核图片的 URL 及区分标识。
  • Upload：图片上传场景，针对上传图片到指定服务下的场景。可在 EnableAuditRange下指定审核的范围，例如对指定上传到某目录下的图片进行审核。

EnableAuditRange

Integer

否

1

仅当 Type 取值 Upload 时，配置生效。
审核范围，取值如下所示：

  • 0：（默认）不限范围
  • 1：指定范围

AuditPrefix

Array of String

否

["a/"]

仅当 EnableAuditRange 取值 1 时，配置生效。
指定前缀审核，若你希望对某个目录进行审核，请设置路径为对应的目录名，以/结尾。例如123/test/

NoAuditPrefix

Array of String

否

["b/"]

仅当 EnableAuditRange 取值 1 时，配置生效。
指定前缀不审核，若你希望对某个目录不进行审核，请设置路径为对应的目录名，以/结尾。例如123/test/

ResUri

Array of String

否

[ "指定服务/图片审核文件.txt" ]

仅当 Type 为 UrlFile 时，配置生效。
审核文件的 StoreUri，为 .txt 文件，该文件需上传至指定服务对应存储中。该 txt 文件内需填写待审核图片文件的 URL，每行填写一个，最多可填写 10000 行。

ImageInfos

Array of ImageInfos

否

-

仅当 Type 为 Url 时，配置生效。
批量提交图片 URL 列表

AuditAbility

Integer

是

1

审核能力，取值如下所示：

  • 0：基础审核能力
  • 1：智能审核能力

AuditDimensions

Array of String

是

["pron","sexy"]

审核维度，根据审核能力的不同，其具体取值不同。基础审核与智能审核之间不支持混用。

  • 基础安全审核，仅当 AuditAbility 取值为 0 时，配置生效。
    • govern：涉政
    • porn ：涉黄
    • illegal：违法违规
    • terror：涉暴
  • 智能安全审核，仅当 AuditAbility 取值为 1 时，配置生效。
    • 图像风险识别
      • porn ：涉黄，主要适用于通用色情、色情动作、性行为、性暗示、性分泌物、色情动漫、色情裸露等涉黄场景的风险识别
      • sensitive1 ：涉敏1，具体指涉及暴恐风险
      • sensitive2：涉敏2，具体值涉及政治内容风险
      • forbidden：违禁，主要适用于打架斗殴、爆炸、劣迹艺人等场景的风险识别
      • uncomfortable：引人不适，主要适用于恶心、恐怖、尸体、血腥等引人不适场景的风险识别
      • qrcode：二维码，主要适用于识别常见二维码（QQ、微信、其他二维码等）
      • badpicture：不良画面，主要适用于自我伤害、丧葬、不当车播、吸烟/纹身/竖中指等不良社会风气的风险识别
      • sexy：性感低俗，主要适用于舌吻、穿衣性行为、擦边裸露等多种性感低俗场景的风险识别
      • age：年龄，主要适用于图中人物对应的年龄段识别
      • underage：未成年相关，主要适用于儿童色情、儿童邪典等风险识别
      • quality：图片质量，主要适用于图片模糊、纯色边框、纯色屏等风险识别
    • 图文风险识别，您可在 AuditTextDimensions 配置文字审核的维度。

    说明

    您可将智能安全审核的图像风险识别和图文风险识别搭配使用。

AuditTextDimensions

Array of String

否

["ad"]

智能安全审核类型下图文风险审核的具体维度，取值如下所示：

  • ad：广告，综合图像及文字内容智能识别广告
  • defraud：诈骗，综合图像及文字内容智能识别诈骗
  • charillegal：文字违规，图片上存在涉黄、涉敏、违禁等违规文字

说明

仅当 AuditDimensions 取值为智能安全审核模型时，您可将 AuditTextDimensions 与 AuditDimensions 搭配使用。

EnableFreeze

Boolean

否

true

是否开启冻结，取值如下所示：

  • true：开启
  • false：（默认）不开启

FreezeType

Array of String

否

["recheck","nopass"]

冻结措施，取值如下所示：

  • recheck：建议复审
  • nopass：审核不通过

FreezeDimensions

Array of String

否

["pron","sexy","ad"]

冻结维度，取值需要与 AuditDimensions 审核维度保持一致或少于 AuditDimensions。
例如，AuditDimensions 取值 ["pron","sexy"]，AuditTextDimensions 取值 ["ad"]，支持您将 FreezeDimensions 取值 ["pron","sexy","ad"] 、 ["pron","sexy"]、["pron","ad"] 和 ["sexy","ad"] 任意一种。

FreezeStrategyFloat否0冻结策略，当前仅支持取 0，表示禁用图片。

EnableCallback

Boolean

否

true

是否开启回调，取值如下所示：

  • true：开启
  • false：（默认）不开启

CallbackDimensions

Array of String

否

["ad"]

回调类型，取值需要与 AuditDimensions 审核维度保持一致或少于 AuditDimensions。
例如，AuditDimensions 取值 ["pron","sexy"]，AuditTextDimensions 取值 ["ad"]，支持您将 FreezeDimensions 取值 ["pron","sexy","ad"] 、 ["pron","sexy"]、["pron","ad"] 和 ["sexy","ad"] 任意一种。

CallbackImageTypes

Array of String

否

["problem","frozen","fail"]

回调图片类型，取值如下所示：

  • normal：正常图片

  • problem：问题图片

  • frozen：冻结图片

  • fail：审核失败图片

CallbackUrlString否https://example.callback.com回调 URL，veImageX 以 Post 方式向业务服务器发送 JSON 格式回调数据。具体回调参数请参考回调内容。
RegionString是cn任务地区。当前仅支持取值 cn，表示国内。

EnableLargeImageDetect

Boolean

否

true

图片审核仅支持审核 5MB 以下的图片，若您的图片大小在 5MB~32MB，您可以开启大图审核功能，veImageX 会对图片压缩后再进行审核。开启后，将对压缩能力按照基础图片处理进行计费。（您每月可使用 20TB 的免费额度）
取值如下所示：

  • true：开启
  • false：（默认）不开启

说明

  • 若未开启大图审核且图片大小 ≥ 5 MB，可能会导致系统超时报错；
  • 若已开启大图审核但图片大小 ≥ 32 MB，可能会导致系统超时报错。

ImageInfos

参数类型是否必选示例值描述
ImageUriString否https://test.png待审核图片 URL，需满足公网可访问。
DataIdString否92bodw28122j19***018h3i1928g建议您根据实际业务情况，将该参数作为可区分审核图片 ImageUri 的自定义标识。

返回参数

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

参数类型示例值描述
TaskIdString652ceffd309a6dd937a3780d任务 ID

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageAuditTask&Version=2018-08-01
{
  "ServiceId": "lk**i0",
  "Type": "UrlFile",
  "AuditDimensions": [
    "porn",
    "sensitive1",
    "sensitive2"
  ],
  "AuditTextDimensions": [
    "ad"
  ],
  "AuditAbility": 1,
  "EnableLargeImageDetect": true,
  "EnableFreeze": true,
  "EnableCallback": true,
  "ResUri": [
    "指定服务/图片审核文件.txt"
  ],
  "FreezeType": [
    "nopass",
    "recheck"
  ],
  "FreezeDimensions": [
    "porn",
    "sensitive1"
  ],
  "FreezeStrategy": 0,
  "CallbackDimensions": [
    "porn",
    "sensitive1"
  ],
  "CallbackImageTypes": [
    "problem",
    "frozen"
  ],
  "CallbackUrl": "http://example.callback.com"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20231016174144CD8C36D58177D5DDE53F",
    "Action": "CreateImageAuditTask",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "TaskId": "652d0558a**3bc6eeee9f"
  }
}

错误码

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

服务端 SDK

推荐您使用服务端 SDK 来调用 API，我们已在 GitHub 提供了 PHP 的参考示例。