更新图片审核任务配置--veImageX-火山引擎

文档中心

立即注册

veImageX

智能审核

更新图片审核任务配置

本接口支持对任务状态为已取消的审核任务，通过指定服务 ID 和任务 ID 来更新该条审核任务的各项配置。

说明

您可通过调用查询所有审核任务查看所有审核任务的状态。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
前提条件：仅支持对状态为已取消的审核任务更新配置，您可登录 veImageX 控制台手动将任务状态修改为已取消。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。详情参见服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Region	String	否	`cn`	指定审核任务所属的地区。当前仅支持国内地区，取值为 `cn`。
ServiceId	String	是	`lk**i0`	指定待更新审核任务所在的服务 ID，您可通过调用查询所有审核任务获取待更新任务对应的服务 ID。
TaskId	String	是	`98172790****918301`	任务 ID，您可通过调用查询所有审核任务获取所需的任务 ID。
EnableAuditRange	Integer	否	`1`	是否开启审核范围配置，仅当 `Type` 取值为 `Upload` 时生效。支持的取值如下所示。 `0`：不限范围（默认）； `1`：指定范围（需配合 `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 行。
AuditDimensions	Array of String	是	`["porn","sexy"]`	图像风险审核的具体维度。取值如下： `porn` ：涉黄，主要适用于通用色情、色情动作、性行为、性暗示、性分泌物、色情动漫、色情裸露等涉黄场景的风险识别 `sensitive1` ：涉敏1，具体指涉及暴恐风险 `sensitive2`：涉敏2，具体值涉及政治内容风险 `forbidden`：违禁，主要适用于打架斗殴、爆炸、劣迹艺人等场景的风险识别 `uncomfortable`：引人不适，主要适用于恶心、恐怖、尸体、血腥等引人不适场景的风险识别 `qrcode`：二维码，主要适用于识别常见二维码（QQ、微信、其他二维码等） `badpicture`：不良画面，主要适用于自我伤害、丧葬、不当车播、吸烟/纹身/竖中指等不良社会风气的风险识别 `sexy`：性感低俗，主要适用于舌吻、穿衣性行为、擦边裸露等多种性感低俗场景的风险识别 `age`：年龄，主要适用于图中人物对应的年龄段识别 `underage`：未成年相关，主要适用于儿童色情、儿童邪典等风险识别 `quality`：图片质量，主要适用于图片模糊、纯色边框、纯色屏等风险识别说明您可将 `AuditDimensions` 与 `AuditTextDimensions` 搭配使用，实现图像和文字内容的综合审核。
AuditTextDimensions	Array of String	否	`["ad","charillegal"]`	文字审核的具体维度。取值如下： `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`	冻结策略，当前仅支持取值为 `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` 参数开启回调功能使用。回调数据格式请参考回调内容文档。
EnableLargeImageDetect	Boolean	否	`true`	是否开启大图审核功能。默认值为 `false`。支持的取值如下所示。 `true`：开启大图审核，系统会对 5MB~32MB 的图片进行压缩后再审核； `false`：不开启大图审核。说明未开启时若图片大小 ≥ 5 MB，可能导致系统超时报错；已开启时若图片大小 ≥ 32 MB，可能导致系统超时报错；开启后将对压缩能力按照基础图片处理进行计费（每月有 20TB 免费额度）。

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageAuditTask&Version=2023-05-01
{
    "ServiceId": "lk**i0",
    "AuditDimensions": [
        "porn",
        "sexy"
    ],
    "EnableAuditRange": 1,
    "AuditPrefix": [
        "images/",
        "temp/"
    ],
    "NoAuditPrefix": [
        "images/temp/",
        "test/"
    ],
    "EnableFreeze": true,
    "FreezeType": [
        "recheck",
        "nopass"
    ],
    "FreezeDimensions": [
        "porn",
        "sexy"
    ],
    "FreezeStrategy": 0,
    "ResUri": [
        "example-service/audit-list.txt"
    ],
    "EnableCallback": true,
    "CallbackDimensions": [
        "porn",
        "sexy"
    ],
    "CallbackImageTypes": [
        "problem",
        "frozen"
    ],
    "CallbackUrl": "https://api.example.com/audit/callback",
    "Region": "cn",
    "TaskId": "98172790****918301",
    "EnableLargeImageDetect": true,
    "AuditTextDimensions": [
        "ad",
        "charillegal"
    ],
    "AuditWildCard": [
        "*_image",
        "test?.jpg"
    ],
    "NoAuditWildCard": [
        "*_image",
        "test?.jpg"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateImageAuditTask",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    }
}

错误码

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

最近更新时间：2025.12.29 17:21:58

这个页面对您有帮助吗？

有用

无用

veImageX

注意事项 #

请求说明 #

调试 #

请求参数 #

Header #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #