同步审核图片--veImageX-火山引擎

文档中心

立即注册

导航

同步审核图片

最近更新时间：2024.11.15 15:35:24首次发布时间：2023.12.14 19:50:56

本接口支持对单个图片进行同步审核任务，并获取审核结果。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：超时时间约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
ImageUri	String	是	`http://test.com/demo.png`	审核图片 URL，需满足公网可访问。
DataId	String	是	`92bodw28122j19***018h3i1928g`	建议您根据实际业务情况，将该参数作为可区分审核图片 ImageUri 的自定义标识。
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` 配置文字审核的维度。说明您可将智能安全审核的图像风险识别和图文风险识别搭配使用。
EnableLargeImageDetect	Boolean	是	`true`	图片审核仅支持审核 5MB 以下的图片，若您的图片大小在 5MB~32MB，您可以开启大图审核功能，veImageX 会对图片压缩后再进行审核。开启后，将对压缩能力按照基础图片处理进行计费。（您每月可使用 20TB 的免费额度）取值如下所示： `true`：开启 `false`：（默认）不开启说明若未开启大图审核且图片大小 ≥ 5 MB，可能会导致系统超时报错；若已开启大图审核但图片大小 ≥ 32 MB，可能会导致系统超时报错。
AuditTextDimensions	Array of String	是	`["ad"]`	智能安全审核类型下图文风险审核的具体维度，取值如下所示： `ad`：广告，综合图像及文字内容智能识别广告 `defraud`：诈骗，综合图像及文字内容智能识别诈骗 `charillegal`：文字违规，图片上存在涉黄、涉敏、违禁等违规文字

返回参数

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

参数	类型	示例值	描述
ImageUri	String	`https://test.png`	待审核图片的 URL
DataId	String	`92bodw28122j19***018h3i1928g`	自定义的区分图片的标识
Advice	String	`nopass`	审核建议，取值如下所示： `nopass`：建议不通过 `recheck`：建议复审
Label	Array of String	`["涉黄"]`	被审核图片命中风险的一级标签
SubLabel	Array of String	`["301001"]`	被审核图片命中风险的二级标签
ImageType	String	`fail`	审核后图片类型，取值如下所示： `normal`：正常 `frozen`：冻结图片 `problem`：问题图片 `fail`：审核失败

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=GetSyncAuditResult&Version=2018-08-01
{
	"ImageUri": "http://test.com/demo.png",
  "AuditDimensions": [
    "porn",
    "sensitive1",
    "sensitive2"
  ],
  "AuditTextDimensions": [
    "ad"
  ],
  "AuditAbility": 1,
  "EnableLargeImageDetect": true,
  "DataId": "92bodw28122j19***018h3i1928g"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetSyncAuditResult",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
	    	"ImageUri": "http://test.com/demo.png",
	    	"DataId": "92bodw28122j19***018h3i1928g"
	    	"Advice": "nopass",
	    	"Label": ["涉黄"],
	    	"SubLabel": ["301001"],
	    	"ImageType": "fail"
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。