批量异步检测

2022.08.18 18:03:01

    易盾内容安全文本批量异步检测接口与同步检测接口不同,该接口不同步返回易盾内容安全服务实时内容安全引擎检测结果,批量提交待检测文本后只返回当前业务等待检测的缓冲池数量,异步检测发布的内容、发布者、ip、设备等信息是否为需拦截内容

    接口说明

    该接口只返回文本提交的结果,具体检测结果需要通过文本结果获取接口-轮询模式文本结果获取接口-推送模式获取,支持http协议接口调用

    鉴权说明

    易盾内容安全服务使用签名方法对接口进行鉴权,所有接口每一次请求都需要包含签名信息(signature 参数),以验证用户身份,防止信息被恶意篡改。目前支持MD5,SHA1,SHA256,SM3几种加密算法,详细信息,请参见接口鉴权

    文本要求

    • 文本限制:单次批量提交1-100条,单条<1万字符,字段长度超过1万字符,会截取前面1万字符进行检测和存储

    检测耗时

    文本批量异步检测接口不涉及具体检测流程,建议超时时间1s

    历史版本

    v4版本异步批量检测接口文档请点此查看

    请求

    请求地址

    名称
    HTTP URL http://as.dun.163.com/v5/text/async-batch-check
    HTTP Method POST

    请求头

    名称 类型 必填 描述
    Content-Type String 固定值:"application/x-www-form-urlencoded"

    请求参数

    请求参数由公共参数和业务参数两部分组成

    公共参数

    公共参数包含密钥信息和参数签名信息,公共参数详细见请求公共参数

    业务参数

    名称 类型 必填 最大长度 描述
    version String 4 接口版本号,可选值 v5.2
    checkLabels String 512 业务过检分类,如果没有勾选分类提交返回参数错误,您可指定多个垃圾类别进行机器检测,多个垃圾类别以逗号分隔("100,200"),指定后业务配置过检分类即失效,过检分类列表:100:色情,200:广告,260:广告法,300:暴恐,400:违禁,500:涉政,600:谩骂,700:灌水,900:其他,1100:涉价值观
    texts String 1-100条文本数据 文本数据,json格式对象数组
     ∟ dataId String 128 数据唯一标识,能够根据该值定位到该条数据,如对数据结果有异议,可以发送该值给客户经理查询
     ∟ content String 10000 用户发表内容,建议对内容中JSON、表情符、HTML标签、UBB标签等做过滤,只传递纯文本,以减少误判概率
     ∟ title String 512 内容标题,适用于贴子、博客的文章标题等场景,建议抄送,辅助机审策略精准调优
     ∟ dataType Number 4 子数据类型,与易盾内容安全服务约定即可
     ∟ callback String 2^16-1 数据回调参数,调用方根据业务情况自行设计,当调用文本结果获取接口-轮询模式文本结果获取接口-推送模式时,该接口会原样返回该字段,详细见文本离线检测结果获取。作为数据处理标识,因此该字段应该设计为能唯一定位到该次请求的数据结构,如对用户的昵称进行检测,dataId可设为用户标识(用户ID),用户修改多次,每次请求数据的dataId可能一致,但是callback参数可以设计成定位该次请求的数据结构,比如callback字段设计成json,包含dataId和请求的时间戳等信息,当然如果不想做区分,也可以直接把callback设置成dataId的值
     ∟ publishTime Number 13 发表时间,UNIX 时间戳(毫秒值)
     ∟ callbackUrl String 256 人工审核结果回调通知到客户的URL。主动回调数据接口超时时间设置为2s,为了保证顺利接收数据,需保证接收接口性能稳定并且保证幂等性
     ∟ category String 128 来源,用于展示渠道名称,应用名称等
    token String 256 内容安全与反作弊融合版专属字段,来自易盾反作弊SDK返回的token,接入SDK必传,接入流程请参考防刷版说明文档

    业务扩展参数

    建议您将发布内容的用户信息、设备信息、场景信息同步传入,易盾将结合用户风险画像、设备风险画像、场景化策略全方位检测内容风险,检测结果更精准。请参见业务扩展参数

    请求体示例

    version=v5&texts=xxx&signature=xxx&secretId=xxx&businessId=xxx
    

    响应

    响应结果

    响应字段如下,响应通用字段已省略,详细见响应公共字段

    名称 类型 必填 描述
    result Object 文本回调结果
     ∟ dealingCount Number 缓冲池中待处理数据
     ∟ checkTexts Object[] 提交文本数据的检测信息
      ∟ dataId String 数据ID
      ∟ taskId String 检测任务ID,示例值:"fx6sxdcd89fvbvg4967b4787d78a"

    响应体示例

    {
        "code": 200,
        "msg": "ok",
        "result": {
            "dealingCount": 10,
            "checkTexts": [
                {
                    "taskId": "fx6sxdcd89fvbvg4967b4787d78a",
                    "dataId": "xxx"
                }
            ]
            
        }
    }
    

    响应返回码

    响应返回码见:响应返回码

    SDK接入方法

    为方便 JAVA 开发者调试和接入API,我们提供了配套的开发工具集(SDK),用于简化API接入流程。SDK中各接口调用方式基本相同,接入方式统一,并提供了一些接口调用过程中常见的异常处理方案。以下介绍了SDK的使用流程,以及首次使用SDK的简单示例。

    如果您使用的是其他语言,请参考各语言示例demo

    • 准备工作

    准备步骤详见通用步骤

    • 使用方法

    使用方法可参考使用SDK

    Online Chat Tel:95163223