文本异步提交接口

2022.06.22 17:29:45

    接口地址

    https://as.dun.163yun.com/v4/text/async-check

    接口描述

    文本异步检测提交接口。检测结果请在文本回调接口中获取,http://as.dun.163.com/v4/text/callback/results

    文本限制

    单次请求<1万字符,字段长度超过1万字符,会截取前面1万字符进行检测和存储;

    请求参数

    公共参数已省略,详细见 请求公共参数,其他参数如下:

    基本参数

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

    业务扩展参数

    业务扩展参数,有助于通过业务维度辅助反垃圾结果判定

    参数名称 类型 是否必选 最大长度 描述
    用户信息 - N - 用户信息包含账号、昵称、等级、角色等,请查看 业务扩展参数—用户信息
    设备信息 - N - 设备信息包含设备ID、设备ID类型等,请查看 业务扩展参数—设备信息
    场景信息 - N - 场景信息包含私聊、群聊、直播、帖子等场景字段,请查看 业务扩展参数—场景信息
    ip String N 128 用户IP地址,建议抄送,辅助机审策略精准调优
    relatedKeys String N 512 String数组,多个关联Key以逗号分隔("xxx,xxx"),最多三个Key,单个Key长度不超过128,适用于私聊/评论/跟帖等情况同一用户或不同用户发送多条违规内容关联检测的场景。如需要检测同一评论下的同一用户或不同用户发送违规内容盖楼场景,Key传值方式可以为("评论ID,用户ID")
    extStr1 String N 128 自定义扩展参数
    extStr2 String N 128 自定义扩展参数
    extLon1 Long N 2^63-1 自定义扩展参数
    extLon2 Long N 2^63-1 自定义扩展参数
    extension String N 30000 自定义扩展参数

    响应结果

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

    参数名称 数据类型 是否必填 描述
    code Integer Y 返回错误码, 取值见官网公共返回错误码定义
    msg String Y 返回错误消息
    result TextCheckAsyncResp Y 异步接口提交返回

    result数据结构

    参数名称 数据类型 是否必填 描述
    dealingCount Long Y 缓冲池待处理数量
    checkTexts List Y 提交结果

    checkTexts数据结构

    参数名称 数据类型 是否必填 描述
    dataId String N 提交时的dataId
    taskId String Y 检测的taskId

    请求响应示例

    {
        "code":200,
        "msg":"ok",
        "result":{
            "dealingCount":0,
            "checkTexts":[
                {
                    "dataId":"12345",
                    "taskId":"0e51c3ab27dd4ea2b7e267db7a9e0b5c"
                }
            ]
        }
    }
    
    Online Chat Tel:95163223