异步检测
图片异步检测提供包括智能鉴黄、暴恐、涉政、违禁、广告、恶心、涉价值观等违规内容识别能力,以及logo识别、OCR识别、人脸识别、图片质量等多维度辅助信息能力,图片中的违规内容和多维度的辅助信息异步结果获取,该接口适用于异步处理违规数据和历史数据扫描的场景。
接口说明
该接口异步提交图片检测任务,返回图片标识和异步检测量,建议http协议接口调用。
鉴权说明
易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5,SHA1,SHA256,SM3几种加密算法,详细信息,请参见接口鉴权
图片要求
- 图片支持类型:URL、暂不支持BASE64
- 图片支持格式:PNG、JPG、JPEG、BMP、GIF、WEBP、TIFF、ICO、HEIC、SVG、JFIF
- 图片大小(适用于同步和异步检测): 单张<10M,像素建议不低于50px*50px,像素过低会影响识别效果
- 图片下载:下载时间限制为5秒内,如果下载时间超过5秒,异步结果返回检测失败
- 请求体限制:所有请求参数大小总和不能超过10M(BASE64参数较大),单次请求图片数不能超过32
- 截帧说明:易盾自动将GIF图,长图(长宽比大于5的图片)截帧过检,最多5张,GIF图,长图均按照实际截图张数进行计费
检测耗时
图片异步检测只是提交检测任务,下载及检测这些耗时逻辑异步完成,相对同步检测耗时较短,建议您将超时时间设置为2秒。
历史版本
请求
请求地址
名称 | 值 |
---|---|
HTTP URL | http://as.dun.163.com/v5/image/asyncCheck |
HTTP Method | POST |
请求头
名称 | 类型 | 描述 |
---|---|---|
Content-Type | String | 固定值:"application/x-www-form-urlencoded" |
请求参数
请求参数由公共参数和业务参数两部分组成。
公共参数
公共参数包含密钥信息和参数签名信息,公共参数详细见请求公共参数
业务参数
名称 | 类型 | 是否必填 | 最大长度 | 描述 |
---|---|---|---|---|
images | String | 是 | 32张或10MB | images为json数组,支持批量检测,为具体图片检测数据,数组长度不能超过32,大小不能超过10M |
∟ name | String | 是 | 1024 | 图片名称(或图片标识), 该字段为回调信号字段,产品可以根据业务情况自行设计,如json结构,或者为图片url均可 |
∟ type | Number | 是 | 4 | 类型,分别为1:图片URL,异步检测暂不支持base64 |
∟ data | String | 是 | - | 图片内容,如type=1,则该值为图片URL,请求时会校验图片url协议支持http,https。 |
∟ callbackUrl | String | 否 | 256 | 离线结果回调通知到客户的URL。主动回调数据接口超时时间默认设置为2s,为了保证顺利接收数据,需保证接收接口性能稳定并且保证幂等性。 |
∟ dataId | String | 否 | 128 | 上传数据唯一标识,能够根据该值定位到该条数据,如对数据结果有异议,可以发送该值给策略经理查询 |
version | String | 是 | 4 | 接口版本号,值为v5 |
dataType | Number | 否 | 4 | 子数据类型,用于区分过滤标注完全一致的不同模块数据,与易盾内容安全服务约定即可 |
publishTime | Number | 否 | 13 | 发表时间,UNIX 时间戳(毫秒值) |
censorExt | String | 否 | 1024 | 人审标签扩展字段,可传入任意标签内容,用于在人审模板(审核模板配置请参考人工审核模板高级配置)时指定数据并配置特殊审核逻辑。一次传入支持多个标签,标签间使用英文逗号","隔开,不支持大写英文字母,请全部使用小写 |
checkLabels | String | 否 | 512 | 业务自定义过检分类,请谨慎写入,并与策略经理充分沟通,以免引起漏判,如果没有勾选分类提交返回参数错误,您可指定多个垃圾类别进行机器检测,多个垃圾类别以逗号分隔"100,200",指定后业务配置过检分类即失效,过检分类列表:100:色情,110:性感低俗,200:广告,210:二维码,260:广告法,300:暴恐,400:违禁,500:涉政,800:恶心类,900:其他,1100:涉价值观 |
subProduct | String | 否 | 32 | 业务结算id(自定义),业务方传入参数,用于资源账单统计,如需开启请联系易盾策略经理。开启之后资源账单按套餐结算sheet增加subProduct维度的数据请求量、检测量、消耗金额的统计 |
token | String | 否 | 256 | 内容安全与反作弊融合版专属字段,来自易盾反作弊SDK返回的token,接入SDK必传,请联系您的专属策略经理获取相关开发文档 |
riskControlToken | String | 否 | 15000 | 来自易盾智能风控SDK返回的token,接入SDK必传,接入流程请参考智能风控融合版说明文档 ,建议客户端获取token后30分钟内及时提交检测。 |
riskControlBusinessId | String | 否 | 256 | 调用易盾智能风控getToken时使用智能风控业务id,接入流程请参考智能风控融合版说明文档 |
业务扩展参数
建议您将发布内容的用户信息、设备信息、场景信息同步传入,易盾将结合用户风险画像、设备风险画像、场景化策略全方位检测内容风险,检测结果更精准。请参见业务扩展参数
请求体示例
images=[{"name":"test","type":1,"data":"url","dataId":"dataId"}]&version=v5&signature=xxx&secretId=xxx&businessId=xxx×tamp=1646984669446&nonce=12353
响应
响应结果
响应字段如下,响应公共字段已省略,详细见响应公共字段:
名称 | 类型 | 是否返回 | 描述 |
---|---|---|---|
result | Object | 是 | 图片异步提交检测结果 |
∟ dealingCount | Number | 是 | 缓冲池中待检测数据 |
∟ checkImages | Object[] | 是 | 提交图片数据的检测信息 |
∟ name | String | 是 | 图片名称(或图片标识) |
∟ taskId | String | 是 | 易盾侧机审数据唯一标识,能够根据该值定位到该条数据,如对检测结果有异议,可以发送该值给策略经理查询 |
∟ dataId | String | 否 | 上传数据唯一标识,能够根据该值定位到该条数据,如对数据结果有异议,可以发送该值给策略经理查询 |
响应体示例
{
"code": 200,
"msg": "ok",
"result": {
"checkImages": [
{
"dataId": "1234",
"name": "name",
"taskId": "15f9b1a0dec847d8a0ff08bad0ea5b17"
}
],
"dealingCount": 0
}
}
响应返回码
响应返回码见:响应返回码
示例代码
服务端 SDK 接入
推荐使用我们提供的服务端 SDK 进行接入(目前支持 Java 和 Go 两种语言),不但可以节省接入成本,实现更快速的集成,并享有灵活的请求配置选项,同时 SDK 内置了错误重试、熔断降级等功能,提升服务可用性。点击 服务端 SDK 接入指引 了解更多。