创建图片审核任务--veImageX-火山引擎

文档中心

立即注册

导航

创建图片审核任务

最近更新时间：2025.10.09 15:20:50首次发布时间：2023.12.28 11:22:01

本接口用于在指定服务下创建图片审核任务，支持多种审核维度（如涉黄、涉政、违禁等），并可配置冻结策略和回调通知。审核任务完成后，可根据审核结果执行冻结操作或通过回调通知用户。

注意事项

计费说明：智能审核属于附加组件下智能处理模块，属于后付费计费，使用后会产生附加组件智能处理费用。
前提条件：请确保已开通智能处理计费配置。
使用限制：使用组件前，请先确认智能审核使用限制。
请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。详情参见服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ServiceId	String	是	`9u**6i`	指定审核任务所属的服务 ID。可在 veImageX 控制台服务管理页面获取；也可通过获取所有服务信息 OpenAPI 获取。
TaskType	String	是	`audit`	任务类型。当前接口仅支持取值为 `audit`。
Type	String	是	`UrlFile`	审核任务场景。取值如下所示： `UrlFile`：存量文件处理，针对已有存储内的文件请求获取审核结果。传入方式是 `ResUri` 方式，即在 TXT 文件（审核文件）内填写了待审核文件 URL，并将该 TXT 文件上传至指定服务后获取并传入该文件的 StoreUri。 `Url`：URL 直传场景。传入方式为 `ImageInfos` 方式，即可直接传入待审核文件的 URL 及区分标识。 `Upload`：上传场景，针对上传文件到指定服务下的场景。可通过 `EnableAuditRange` 参数指定审核的范围，例如对指定上传到某目录下的文件进行审核。
EnableAuditRange	Integer	否	`1`	是否开启审核范围配置，仅当 `Type` 取值为 `Upload` 时生效。默认值为 `0`。支持的取值如下所示。 `0`：不限范围； `1`：指定前缀匹配（需配合 `AuditPrefix` 或 `NoAuditPrefix` 使用）； `2`：指定通配符匹配（需配合 `AuditPrefix` 或 `NoAuditPrefix` 使用）。
AuditPrefix	Array of String	否	`["images/","temp/"]`	指定需要审核的文件前缀列表，仅当 `EnableAuditRange` 取值为 `1` 时生效。若需要对某个目录进行审核，请设置路径为对应的目录名并以 `/` 结尾，例如 `123/test/`。
NoAuditPrefix	Array of String	否	`["images/temp/", "test/"]`	指定不进行审核的文件前缀列表，仅当 `EnableAuditRange` 取值为 `1` 时生效。若需要对某个目录不进行审核，请设置路径为对应的目录名并以 `/` 结尾，例如 `123/test/`。
AuditWildCard	Array of String	否	`["*_image","test?.jpg"]`	指定需要审核的文件通配符列表，仅当 `EnableAuditRange` 取值为 `1` 时生效。当前支持的通配符为 `*` 和 `?`，不同通配符请用英文逗号隔开。
NoAuditWildCard	Array of String	否	`["*_image","test?.jpg"]`	指定不进行审核的文件通配符列表，仅当 `EnableAuditRange` 取值为 `1` 时生效。当前支持的通配符为 `*` 和 `?`，不同通配符请用英文逗号隔开。
ResUri	Array of String	否	`["example-service/audit-list.txt"]`	审核文件的 StoreUri，仅当 `Type` 为 `UrlFile` 时生效。该文件为 .txt 格式，需上传至指定服务对应存储中，文件内容为待审核文件的 URL 列表，每行一个 URL，最多支持 10000 行。
ImageInfos	Array of ImageInfos	否	`-`	当 `Type` 为 `Url` 时，用于批量提交待审核文件的 URL 列表。每个元素包含文件 URL 和自定义标识。
AuditAbility	Integer	是	`1`	审核能力类型，用于指定审核任务所使用的审核模型。支持的取值如下所示。 `0`：基础审核能力； `1`：智能审核能力。
AuditDimensions	Array of String	是	`["porn","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","charillegal"]`	智能安全审核类型下图文风险审核的具体维度，仅当 `AuditAbility` 取值为 `1` 时生效。支持的取值如下所示。 `ad`：广告，综合图像及文字内容智能识别广告； `defraud`：诈骗，综合图像及文字内容智能识别诈骗； `charillegal`：文字违规，存在涉黄、涉敏、违禁等违规文字。说明您可将 `AuditTextDimensions` 与 `AuditDimensions` 搭配使用，实现图像和图文内容的综合审核。
EnableFreeze	Boolean	否	`true`	是否开启冻结功能，默认值为 `false`。支持的取值如下所示。 `true`：开启； `false`：不开启。说明开启冻结功能后，需配合 `FreezeType`、`FreezeDimensions` 和 `FreezeStrategy` 使用。
FreezeType	Array of String	否	`["recheck","nopass"]`	冻结措施，仅当 `EnableFreeze` 为 `true` 时生效。支持的取值如下所示。 `recheck`：建议复审； `nopass`：审核不通过。
FreezeDimensions	Array of String	否	`["porn","sexy"]`	冻结维度，取值需要与 `AuditDimensions` 审核维度保持一致或少于 `AuditDimensions`。例如，若 `AuditDimensions` 取值为 `["porn","sexy"]`，`AuditTextDimensions` 取值为 `["ad"]`，则支持以下任意一种组合： `["porn","sexy","ad"]` `["porn","sexy"]` `["porn","ad"]` `["sexy","ad"]`
FreezeStrategy	Integer	否		冻结策略，当前仅支持取值为 `0`，表示禁用文件。
EnableCallback	Boolean	否	`true`	是否开启审核结果回调功能，默认值为 `false`。支持的取值如下所示。 `true`：开启回调； `false`：不开启回调。说明开启回调功能后，需配合 `CallbackUrl`、`CallbackDimensions` 和 `CallbackImageTypes` 使用。
CallbackDimensions	Array of String	否	`["porn","sexy"]`	回调类型，取值需要与 `AuditDimensions` 审核维度保持一致或少于 `AuditDimensions`。例如，若 `AuditDimensions` 取值为 `["porn","sexy"]`，`AuditTextDimensions` 取值为 `["ad"]`，则支持以下任意一种组合： `["porn","sexy","ad"]` `["porn","sexy"]` `["porn","ad"]` `["sexy","ad"]`
CallbackImageTypes	Array of String	否	`["problem","frozen"]`	指定需要回调的图片类型，需配合 `EnableCallback` 使用。支持的取值如下所示。 `normal`：正常图片； `problem`：问题图片； `frozen`：冻结图片； `fail`：审核失败图片。
CallbackUrl	String	否	`https://api.example.com/audit/callback`	接收审核结果回调的 URL，veImageX 将以 POST 方式向该地址发送 JSON 格式的回调数据。需配合 `EnableCallback` 参数开启回调功能使用。回调数据格式请参考回调内容文档。
Region	String	是	`cn`	指定审核任务所属的地区。当前仅支持国内地区，取值为 `cn`。
EnableLargeImageDetect	Boolean	否	`true`	是否开启大图审核功能。默认值为 `false`。支持的取值如下所示。 `true`：开启大图审核，系统会对 5MB~32MB 的图片进行压缩后再审核； `false`：不开启大图审核。说明未开启时若图片大小 ≥ 5 MB，可能导致系统超时报错；已开启时若图片大小 ≥ 32 MB，可能导致系统超时报错；开启后将对压缩能力按照基础图片处理进行计费（每月有 20TB 免费额度）。
BktName	String	否	`example-bucket`	指定审核任务关联的存储桶名称，用于标识审核任务对应的存储位置。
BktType	String	否	`volc_tos`	底层存储类型，用于标识审核任务关联的存储桶的底层存储服务类型。支持的取值为 `volc_tos`（火山 TOS）

ImageInfos

参数	类型	是否必选	示例值	描述
ImageUri	String	否	`https://example.com/images/test.jpg`	待审核图片的 URL 地址，需满足公网可访问。当 `Type` 为 `Url` 时，通过该字段批量提交待审核图片的 URL 列表。
DataId	String	否	`92bodw28122j19***018h3i1928g`	自定义标识，用于区分待审核图片 `ImageUri` 的唯一标识，建议根据实际业务需求设置。

返回参数

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

参数	类型	示例值	描述
TaskId	String	`652ceffd309a6dd937a3780d`	审核任务的唯一标识符，用于后续查询或管理该任务。

请求示例

POST https://imagex.volcengineapi.com/?Action=CreateImageAuditTask&Version=2023-05-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": "2023-05-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "TaskId": "652d0558a**3bc6eeee9f"
    }
}

错误码

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

veImageX