异步检测接口

2024.04.24 13:48:48

    易盾内容安全文本异步检测接口与同步检测接口不同,该接口不同步返回易盾内容安全服务实时内容安全引擎检测结果,提交待检测文本后只返回当前业务等待检测的缓冲池数量,以及本次提交生成的唯一检测任务ID。

    接口说明

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

    鉴权说明

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

    文本要求

    • 文本限制:单次请求≤1万字符,字段长度超过1万字符,需要您自行截取前面1万字符再进行检测和存储

    检测耗时

    文本异步检测接口不涉及具体检测流程,建议超时时间100ms

    历史版本

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

    请求

    请求地址

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

    请求头

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

    请求参数

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

    公共参数

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

    业务参数

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

    业务扩展参数

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

    请求体示例

    content=网易易盾&version=v5.2&dataId=163&signature=xxx&secretId=xxx&businessId=xxx&timestamp=1677207014000&nonce=1234
    

    响应

    响应结果

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

    名称 类型 是否返回 描述
    result Object 文本回调结果
     ∟ dealingCount Number 缓冲池中待处理数据
     ∟ checkTexts Object[] 提交文本数据的检测信息
      ∟ dataId String 上传数据唯一标识,能够根据该值定位到该条数据,如对数据结果有异议,可以发送该值给策略经理查询
      ∟ taskId String 易盾侧机审数据唯一标识,能够根据该值定位到该条数据,如对检测结果有异议,可以发送该值给策略经理查询

    响应体示例

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

    响应返回码

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

    示例代码

    服务端 SDK 接入

    推荐使用我们提供的服务端 SDK 进行接入(目前支持 Java 和 Go 两种语言),不但可以节省接入成本,实现更快速的集成,并享有灵活的请求配置选项,同时 SDK 内置了错误重试、熔断降级等功能,提升服务可用性。点击 服务端 SDK 接入指引 了解更多。

    Github Demo 地址

    Gitee Demo 地址(Github 无法访问时选择)

    HTTP API 接入

    Github Demo 地址

    Gitee Demo 地址(Github 无法访问时选择)

    Online Chat Tel:95163223 Free trial