本文提供了调用图片风险违规内容审核的接口和参数说明,旨在帮助您编写程序构建HTTP调用请求,有效地检测图片中的多维度风险内容。
说明 推荐您使用本文介绍的新版API,该版本经过全新设计更易使用;如果您使用旧版本SDK,您可以单击下载旧版本文档。
描述
业务接口:/green/image/scan
同步检测图片中的违规内容,实时返回检测结果。
支持检测的场景包括:图片智能鉴黄、图片暴恐涉政识别、图片广告识别、图片二维码识别、图片不良场景识别、图片logo识别。
关于scene与label参数
在提交检测任务时,您需要指定
scenes场景参数,并且支持组合使用,即可对同一张图片的多种风险进行检测。
而在检测返回结果中,则包含了您指定的场景对应的
label结果分类参数。您可以根据
suggestion参数的返回值对图片进行处置,根据
label参数的返回值判断风险的具体类型。
说明 同时检测多个场景的情况下,将按照
每个场景的检测图片数量×
每个场景的单价进行累加计费。
在图片审核中,scene与label的对应关系如下:
场景 | 描述 | scene | label |
---|---|---|---|
图片智能监黄 | 识别图片中的色情内容。 | porn |
|
图片暴恐涉政识别 | 识别图片中的暴恐涉政内容。 | terrorism |
|
图片广告识别 | 识别图片中的广告信息。 | ad |
|
图片二维码识别 | 识别图片中的二维码。 | qrcode |
|
图片不良场景识别 | 识别直播或视频中出现的黑屏、黑边、昏暗画面,画中画,抽烟,打架等不良场景图片。 | live |
|
图片logo识别 | 识别图片中的logo信息,比如台标,商标等。 | logo |
|
关于检测时长
同步检测允许的最长检测时间是6秒,如果检测在该时间限制内没有完成,系统会强制返回超时错误码。如果您对实时性要求不高,可以选择异步检测;其它情况下,请选择同步检测,同步检测接口的调用相对简单些。对于同步检测接口的调用,建议您将超时时间设置为6秒。
关于图片的限制
- 图片链接支持以下协议:HTTP和HTTPS。
- 图片支持以下格式:PNG、JPG、JPEG、BMP、GIF、WEBP。
- 图片大小限制为10MB以内(适用于同步和异步调用)。如您有特殊需求(大图片),可以提工单进行调整。
- 图片下载时间限制为3s内,如果下载时间超过3s,返回下载超时。
- 图片像素建议不低于256*256,像素过低可能会影响识别效果。
- 图片检测接口响应时间依赖图片的下载时间。请保证被检测图片所在的存储服务稳定可靠,建议您使用阿里云OSS存储或者CDN缓存等。
请求参数
关于在请求中必须包含的公共请求参数,请参考公共参数。
请求body是一个JSON对象,字段说明如下:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
bizType | 字符串 | 否 | 自定义业务类型,由业务方提供。
每个bizType对应不同的算法/模型,运维人员可以为某一bizType动态地增加、删除要检测的风险场景。通过配置,后端根据该字段对请求做不同处理。
说明 该字段优先级高于
scenes字段。
|
scenes | 字符串数组 | 是 | 指定图片检测的应用场景,可选值包括:
说明 支持多场景(scenes)一起检测。例如,使用
scenes=[“porn”, “terrorism”] ,对一张图片同时进行鉴黄和暴恐识别,计费时也将按照两个场景计费。
|
tasks | JSON数组 | 是 | 指定检测对象,JSON数组中的每个元素是一个图片检测任务结构体(image表)。最多支持100个元素,即对100张图片进行检测。每个元素的具体结构描述见task。 |
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
clientInfo | JSON结构体 | 否 | 客户端信息,参考公共参数中的公共查询参数。
服务器会把全局的
clientInfo和此处独立的
clientInfo合并。
说明 独立的
clientInfo优先级更高。
|
dataId | 字符串 | 否 | 数据Id。需要保证在一次请求中所有的Id不重复。 |
url | 字符串 | 是 | 待检测图像的URL。 |
time | 整型 | 否 | 图片创建/编辑时间,单位为ms。 |
extras | Map | 否 | 额外调用参数。 |
interval | 整型 | 否 | 截帧频率,GIF图/长图检测专用。GIF图可理解为图片数组,每interval张图片抽取一张进行检测。只有该值存在时,才会对GIF进行截帧。长图同时支持长竖图和长横图。
说明 默认只会检测GIF图/长图的第一帧,
interval参数用于指示后台在检测时可按照该间隔跳着检测,以节省检测成本。需要与
maxFrames参数组合使用。例如,设置
interval为2,
maxFrames为100,检测长图/GIF图时,将每间隔1帧检测一次,最多检测100帧,计费则按照实际检测的数量计算。
|
maxFrames | 整型 | 否 | 最大截帧数量,GIF图/长图检测专用,默认值为1。 当 |
返回参数
返回结果说明,参见返回结果。
返回body中的data字段是JSON数组,每一个元素包含如下字段:
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
code | 整型 | 是 | 错误码,和HTTP的status code一致。 |
msg | 字符串 | 是 | 错误描述信息。 |
dataId | 字符串 | 否 | 对应请求中的dataId。 |
taskId | 字符串 | 是 | 该检测任务的ID。 |
url | 字符串 | 是 | 对应请求中的URL。 |
extras | Map | 否 | 附加信息。该值可能会调整,建议您不要在业务上进行依赖。 |
results | 数组 | 否 | 返回结果。调用成功时(code=200),返回结果中包含一个或多个元素。每个元素是个结构体,具体结构描述见result。 |
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
scene | 字符串 | 是 | 图片检测场景,和调用请求中的场景(scenes)对应。 |
label | 字符串 | 是 | 检测结果的分类,与具体的scene对应。取值范围参考scene和label说明。 |
suggestion | 字符串 | 是 | 建议您执行的操作,取值范围:
|
rate | 浮点数 | 是 | 结果为该分类的概率,取值范围为[0.00-100.00]。值越高,表示越有可能属于该分类。 |
qrcodeData | 字符串数组 | 否 | 图片中含有二维码时,返回图片中所有二维码包含的文本信息。
说明 仅适用于qrcode场景。
|
logoData | 字符串数组 | 否 | 图片中含有logo时,返回识别出来的logo信息,具体结构描述见logoData。
说明 仅适用于logo场景。
|
sfaceData | 数组 | 否 | 图片中包含暴恐识涉政内容时,返回识别出来的暴恐涉政信息,具体结构描述见sfaceData。
说明 仅适用于terrorism和sface场景。关于该参数在sface场景中的具体内容,请参考敏感人脸检测。
|
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
type | 字符串 | 是 | 识别出的logo类型,取值为TV (台标)。 |
name | 字符串 | 是 | 识别出的logo名称。 |
x | 浮点数 | 是 | 以图片左上角为坐标原点,logo区域左上角到y轴距离。 |
y | 浮点数 | 是 | 以图片左上角为坐标原点,logo区域左上角到x轴距离。 |
w | 浮点数 | 是 | logo区域宽度。 |
h | 浮点数 | 是 | logo区域高度。 |
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
x | 浮点数 | 是 | 以图片左上角为坐标原点,人脸区域左上角到y轴距离。 |
y | 浮点数 | 是 | 以图片左上角为坐标原点,人脸区域左上角到x轴距离。 |
w | 浮点数 | 是 | 人脸区域宽度。 |
h | 浮点数 | 是 | 人脸区域高度。 |
faces | 数组 | 否 | 识别出的人脸信息,具体结构描述见face。 |
名称 | 类型 | 是否必需 | 描述 |
---|---|---|---|
name | 字符串 | 否 | 相似人物的名称。 |
rate | 浮点数 | 否 | 相似概率。 |
id | 字符串 | 是 | 人脸Id。 |
示例
请求示例
{
"scenes": ["porn"],
"tasks": [
{
"dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
"url": "https://img.alicdn.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png"
}
]
}
返回示例
{
"msg": "OK",
"code": 200,
"requestId": "36D384DA-8023-4E84-BCFD-0C5581352C16",
"data": [
{
"code": 200,
"msg": "\u8c03\u7528\u6210\u529f\u3002",
"dataId": "test2NInmO$tAON6qYUrtCRgLo-1mwxdi",
"taskId": "img2MVcKPU1QGD64LoAb4cK6w-1mwxdi",
"url": "https://img.alicdn.com/tfs/TB1urBOQFXXXXbMXFXXXXXXXXXX-1442-257.png",
"results": [
{
"rate": 100,
"scene": "porn",
"suggestion": "block",
"label": "porn"
}
]
}
]
}
在文档使用中是否遇到以下问题
更多建议
匿名提交