图像内容审核(批量)(V2)
功能介绍
分析并识别批量上传的图像内容是否有敏感内容(如涉及暴恐元素、涉黄内容等),并将识别结果返回给您。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v2/{project_id}/moderation/image/batch
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
urls |
是 |
Array of strings |
图片的URL路径,目前支持:
说明:
图片的URL路径列表最多支持10个URL地址。接口响应时间依赖图片的下载时间,如果图片下载时间过长,会返回接口调用失败。请保证被审核图片所在的存储服务稳定可靠,建议您使用华为云OBS存储。 |
categories |
否 |
Array of strings |
检测场景。
可通过配置上述场景,来完对应场景元素的检测。 为空或无此参数表示terrorism检测,但不包含porn场景。
说明:
每个检测场景的检测次数会分类统计。 |
ad_categories |
否 |
Array of strings |
图文审核检测场景。当categories包含ad时,该参数生效。
当前支持的场景有系统场景和用户自定义场景:
|
threshold |
否 |
Double |
结果过滤门限,只有置信度不低于此门限的结果才会呈现在detail的列表中,取值范围 0-1,当未设置此值时各个检测场景会使用各自的默认值。
无特殊需求直接不传此参数或像示例中一样值设为空字符串即可。
说明:
|
moderation_rule |
否 |
String |
图像审核规则名称,默认使用default规则。
说明:
审核规则的创建和使用请参见配置审核规则。 |
show_ocr_text |
否 |
Boolean |
是否返回ocr识别结果,默认值为false。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Array of ImageBatchModerationResultBody objects |
调用成功时表示调用结果。 调用失败时无此字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
url |
String |
图片的URL路径。 |
suggestion |
String |
审核结果是否通过。
说明:
|
detail |
ImageDetectionResultDetail object |
针对选定的每个检测场景列出结果列表,terrorism为暴恐检测结果,porn为涉黄检测结果。如果检测场景中的最高置信度也未达到threshold则结果列表为空。 |
category_suggestions |
Object |
具体每个场景的检测结果。
|
ocr_text |
String |
ocr识别结果,仅在审核图文场景下且“show_ocr_text”=true时返回,否则无此字段,调用失败时也无此字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
porn |
Array of ImageDetectionResultSimpleDetail objects |
涉黄检测结果。 |
terrorism |
Array of ImageDetectionResultSimpleDetail objects |
暴恐检测结果。 |
ad |
Array of ImageDetectionResultAdDetail objects |
广告检测结果。 |
参数 |
参数类型 |
描述 |
---|---|---|
h |
Integer |
人脸区域高度。 |
w |
Integer |
人脸区域宽度。 |
x |
Integer |
人脸区域左上角到y轴距离。 |
y |
Integer |
人脸区域左上角到x轴距离。 |
参数 |
参数类型 |
描述 |
---|---|---|
confidence |
Float |
置信度,取值范围 0-1。 |
label |
String |
每个检测结果的标签化说明。 terrorism:label为对应的暴恐元素信息。
porn:label为对应的涉黄分类(涉黄、性感等)信息。
ad:label为对应的广告识别结果信息。
|
参数 |
参数类型 |
描述 |
---|---|---|
confidence |
Float |
置信度,取值范围 0-1。 |
label |
String |
ad:label为对应的广告识别结果信息。
|
hit_contexts |
Array of strings |
图文审核场景命中的文本列表。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
fail_category |
String |
当包含多个场景时,调用失败的场景。 |
请求示例
识别用户上传的图像内容是否有敏感内容,检测场景为涉黄,暴恐。
POST https://{endpoint}/v2/{project_id}/moderation/image/batch { "urls" : [ "https://bucketname.obs.myhwclouds.com/ObjectName1", "https://bucketname.obs.myhwclouds.com/ObjectName2" ], "categories" : [ "terrorism", "porn" ], "threshold" : "" }
响应示例
状态码: 200
成功响应示例
{ "result": [ { "url": "https://bucketname.obs.myhwclouds.com/ObjectName1", "suggestion": "block", "category_suggestions": { "terrorism": "pass", "porn": "block" }, "detail": { "terrorism": [ { "confidence": 0, "label": "xxx" }, { "confidence": 1, "label": "normal" } ], "porn": [ { "confidence": 0, "label": "normal" }, { "confidence": 1, "label": "xxx" } ] } } ] }
状态码: 400
失败响应示例
{ "error_code" : "AIS.0005", "error_msg" : "The service does not exist." }
状态码
状态码 |
描述 |
---|---|
200 |
成功响应示例。 |
400 |
失败响应示例。 |
错误码
请参见错误码。