com.volcengine.model.imagex.v2.CreateImageAuditTaskBody Maven / Gradle / Ivy
Show all versions of volc-sdk-java Show documentation
package com.volcengine.model.imagex.v2;
import com.alibaba.fastjson.JSON;
import java.util.List;
/**
* CreateImageAuditTaskBody
*/
@lombok.Data
public final class CreateImageAuditTaskBody {
/**
* 任务类型，当前仅支持取值为 `audit`。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "TaskType")
private String taskType;
/**
* 图片审核任务场景。取值如下所示：
*
* - `UrlFile`：存量图片处理，进针对已有存储内的图片请求获取审核结果。传入方式是 `ResUri`方式，即在.txt 文件（审核文件）内填写了待审核图片文件 URL，并将该 txt 文件上传至指定服务后获取并传入该文件的 StoreUri。
*
* - `Url`：URL 直传场景。传入方式为 `ImageInfos` 方式，即可直接传入待审核图片的 URL 及区分标识。
*
* - `Upload`：图片上传场景，针对上传图片到指定服务下的场景。可在 `EnableAuditRange`下指定审核的范围，例如对指定上传到某目录下的图片进行审核。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Type")
private String type;
/**
* 服务 ID。
*
*
*
* - 您可以在 veImageX 控制台 [服务管理](https://console.volcengine.com/imagex/service_manage/)页面，在创建好的图片服务中获取服务 ID。
*
* - 您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考[获取所有服务信息](https://www.volcengine.com/docs/508/9360)。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "ServiceId")
private String serviceId;
/**
* 审核能力，取值如下所示：
*
* - `0`：基础审核能力
*
* - `1`：智能审核能力
*/
@com.alibaba.fastjson.annotation.JSONField(name = "AuditAbility")
private Integer auditAbility;
/**
* 审核维度，根据审核能力的不同，其具体取值不同。基础审核与智能审核之间不支持混用。
*
*
*
* - 基础安全审核，仅当 `AuditAbility` 取值为 `0` 时，配置生效。
*
*
*
* - `govern`：涉政
*
* - `porn` ：涉黄
*
* - `illegal`：违法违规
*
* - `terror`：涉暴
*
*
*
* - 智能安全审核，仅当 `AuditAbility` 取值为 `1` 时，配置生效。
*
*
*
* - 图像风险识别
*
* - `porn` ：涉黄，主要适用于通用色情、色情动作、性行为、性暗示、性分泌物、色情动漫、色情裸露等涉黄场景的风险识别
*
* - `sensitive1` ：涉敏1，具体指涉及暴恐风险
*
* - `sensitive2`：涉敏2，具体值涉及政治内容风险
*
* - `forbidden`：违禁，主要适用于打架斗殴、爆炸、劣迹艺人等场景的风险识别
*
* - `uncomfortable`：引人不适，主要适用于恶心、恐怖、尸体、血腥等引人不适场景的风险识别
*
* - `qrcode`：二维码，主要适用于识别常见二维码（QQ、微信、其他二维码等）
*
* - `badpicture`：不良画面，主要适用于自我伤害、丧葬、不当车播、吸烟/纹身/竖中指等不良社会风气的风险识别
*
* - `sexy`：性感低俗，主要适用于舌吻、穿衣性行为、擦边裸露等多种性感低俗场景的风险识别
*
* - `age`：年龄，主要适用于图中人物对应的年龄段识别
*
* - `underage`：未成年相关，主要适用于儿童色情、儿童邪典等风险识别
*
* - `quality`：图片质量，主要适用于图片模糊、纯色边框、纯色屏等风险识别
*
* - 图文风险识别，您可在 `AuditTextDimensions` 配置文字审核的维度。
*
*
*
* :::tip
*
* 您可将智能安全审核的图像风险识别和图文风险识别搭配使用。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "AuditDimensions")
private List auditDimensions;
/**
* 智能安全审核类型下图文风险审核的具体维度，取值如下所示：
*
* - `ad`：广告，综合图像及文字内容智能识别广告
*
* - `defraud`：诈骗，综合图像及文字内容智能识别诈骗
*
* - `charillegal`：文字违规，图片上存在涉黄、涉敏、违禁等违规文字
*
*
*
* :::tip
*
* 仅当 `AuditDimensions` 取值为智能安全审核模型时，您可将 `AuditTextDimensions` 与 `AuditDimensions` 搭配使用。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "AuditTextDimensions")
private List auditTextDimensions;
/**
* 图片审核仅支持审核 5MB 以下的图片，若您的图片大小在 5MB~32MB，您可以开启大图审核功能，veImageX 会对图片压缩后再进行审核。开启后，将对压缩能力按照[基础图片处理](https://www.volcengine.com/docs/508/65935#%E5%9F%BA%E7%A1%80%E5%9B%BE%E5%83%8F%E5%A4%84%E7%90%86%E6%9C%8D%E5%8A%A1)进行计费。（您每月可使用 20TB 的免费额度）
*
* 取值如下所示：
*
* - `true`：开启
*
* - `false`：（默认）不开启
*
*
*
* :::tip
*
* - 若未开启大图审核且图片大小 ≥ 5 MB，可能会导致系统超时报错；
*
* - 若已开启大图审核但图片大小 ≥ 32 MB，可能会导致系统超时报错。
*
* :::
*/
@com.alibaba.fastjson.annotation.JSONField(name = "EnableLargeImageDetect")
private Boolean enableLargeImageDetect;
/**
* 仅当 `Type` 取值 `Upload` 时，配置生效。
*
* 审核范围，取值如下所示：
*
* - `0`：（默认）不限范围
*
* - `1`：指定范围
*/
@com.alibaba.fastjson.annotation.JSONField(name = "EnableAuditRange")
private Integer enableAuditRange;
/**
* 仅当 `EnableAuditRange` 取值 `1` 时，配置生效。
*
* 指定前缀审核，若你希望对某个目录进行审核，请设置路径为对应的目录名，以`/`结尾。例如`123/test/`
*/
@com.alibaba.fastjson.annotation.JSONField(name = "AuditPrefix")
private List auditPrefix;
/**
* 仅当 `EnableAuditRange` 取值 `1` 时，配置生效。
*
* 指定前缀不审核，若你希望对某个目录不进行审核，请设置路径为对应的目录名，以`/`结尾。例如`123/test/`
*/
@com.alibaba.fastjson.annotation.JSONField(name = "NoAuditPrefix")
private List noAuditPrefix;
/**
* 是否开启冻结，取值如下所示：
*
* - `true`：开启
*
* - `false`：（默认）不开启
*/
@com.alibaba.fastjson.annotation.JSONField(name = "EnableFreeze")
private Boolean enableFreeze;
/**
* 冻结措施，取值如下所示：
*
* - `recheck`：建议复审
*
* - `nopass`：审核不通过
*/
@com.alibaba.fastjson.annotation.JSONField(name = "FreezeType")
private List freezeType;
/**
* 冻结维度，取值需要与 `AuditDimensions` 审核维度保持一致或少于 `AuditDimensions`。
*
*
*
* 例如，`AuditDimensions` 取值 ["pron","sexy"]，`AuditTextDimensions` 取值 ["ad"]，支持您将 `FreezeDimensions` 取值 ["pron","sexy","ad"] 、 ["pron","sexy"]、["pron","ad"] 和 ["sexy","ad"] 任意一种。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "FreezeDimensions")
private List freezeDimensions;
/**
* 冻结策略，当前仅支持取 `0`，表示禁用图片。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "FreezeStrategy")
private Integer freezeStrategy;
/**
* 仅当 `Type` 为 `UrlFile` 时，配置生效。
*
*
*
* 审核文件的 StoreUri，为 .txt 文件，该文件需上传至指定服务对应存储中。该 txt 文件内需填写待审核图片文件的 URL，每行填写一个，最多可填写 10000 行。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "ResUri")
private List resUri;
/**
* 仅当 `Type` 为 `Url` 时，配置生效。
*
*
*
* 批量提交图片 URL 列表
*/
@com.alibaba.fastjson.annotation.JSONField(name = "ImageInfos")
private List imageInfos;
/**
* 是否开启回调，取值如下所示：
*
* - `true`：开启
*
* - `false`：（默认）不开启
*/
@com.alibaba.fastjson.annotation.JSONField(name = "EnableCallback")
private Boolean enableCallback;
/**
* 回调类型，取值需要与 `AuditDimensions` 审核维度保持一致或少于 `AuditDimensions`。
*
*
*
* 例如，`AuditDimensions` 取值 ["pron","sexy"]，`AuditTextDimensions` 取值 ["ad"]，支持您将 `FreezeDimensions` 取值 ["pron","sexy","ad"] 、 ["pron","sexy"]、["pron","ad"] 和 ["sexy","ad"] 任意一种。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "CallbackDimensions")
private List callbackDimensions;
/**
* 回调图片类型，取值如下所示：
*
* - `normal`：正常图片
*
*
*
* - `problem`：问题图片
*
*
*
* - `frozen`：冻结图片
*
*
*
* - `fail`：审核失败图片
*/
@com.alibaba.fastjson.annotation.JSONField(name = "CallbackImageTypes")
private List callbackImageTypes;
/**
* 回调 URL，veImageX 以 Post 方式向业务服务器发送 JSON 格式回调数据。具体回调参数请参考[回调内容](https://www.volcengine.com/docs/508/134676#%E5%9B%9E%E8%B0%83%E5%86%85%E5%AE%B9)。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "CallbackUrl")
private String callbackUrl;
/**
* 任务地区。当前仅支持取值 `cn`，表示国内。
*/
@com.alibaba.fastjson.annotation.JSONField(name = "Region")
private String region;
@Override
public String toString() {
return JSON.toJSONString(this);
}
}