文本异步批量提交接口

2024.04.18 10:17:59

    接口地址

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

    文本限制

    单次批量提交 1-100条,每条 < 1万字符

    请求参数

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

    基本参数

    参数名称 数据类型 是否必填 取值范围 描述
    version String Y v4.2 接口版本号,可选值 v4.2
    checkLabels String N 512 String数组,可指定多个垃圾类别进行机器检测,多个垃圾类别以逗号分隔("100,200")
    texts String(json数组) Y 1-100条文本数据 json格式对象数组

    texts结构如下:

    参数名称 数据类型 是否必填 取值范围 描述
    dataId String Y 128 数据唯一标识,能够根据该值定位到该条数据,如对数据结果有异议,可以发送该值给客户经理查询
    content String Y 10000 用户发表内容,建议对内容中JSON、表情符、HTML标签、UBB标签等做过滤,只传递纯文本,以减少误判概率。请注意为了检测效果和性能,如果该字段长度超过10000字符,会截取前面10000字符进行检测和存储。该字段不能为空,如果为空会返回参数错误。
    title String N 512 内容标题,适用于贴子、博客的文章标题等场景,建议抄送,辅助机审策略精准调优
    dataType Integer N 4 子数据类型,与易盾内容安全服务约定即可
    callback String N 2^16-1 数据回调参数,调用方根据业务情况自行设计,当调用文本离线结果获取接口时,该接口会原样返回该字段,详细见文本离线检测结果获取。作为数据处理标识,因此该字段应该设计为能唯一定位到该次请求的数据结构,如对用户的昵称进行检测,dataId可设为用户标识(用户ID),用户修改多次,每次请求数据的dataId可能一致,但是callback参数可以设计成定位该次请求的数据结构,比如callback字段设计成json,包含dataId和请求的时间戳等信息,当然如果不想做区分,也可以直接把callback设置成dataId的值
    publishTime Long N 13 用户发表时间,UNIX 时间戳(毫秒值)
    callbackUrl String N 256 异步机审结果或人工审核结果回调通知到客户的URL。主动回调数据接口超时时间设置为2s,为了保证顺利接收数据,需保证接收接口性能稳定并且保证幂等性

    业务扩展参数

    业务拓展参数与每条提交的文本内容所匹配,具体请求查看请求示例

    参数名称 数据类型 是否必填 取值范围 描述
    用户信息 - N - 用户信息包含账号、昵称、等级、角色等,请查看 业务扩展参数—用户信息
    设备信息 - N - 设备信息包含设备ID、设备ID类型等,请查看 业务扩展参数—设备信息
    场景信息 - N - 场景信息包含私聊、群聊、直播、帖子等场景字段,请查看 业务扩展参数—场景信息
    ip String N 32 用户IP地址
    extStr1 String N 128 自定义扩展参数
    extStr2 String N 128 自定义扩展参数
    extLon1 Long N 2^63-1 自定义扩展参数
    extLon2 Long N 2^63-1 自定义扩展参数
    relatedKeys String(json数组) N 512 json格式对象数组,多个关联Key以逗号分隔["xxx,xxx"],最多三个Key,单个Key长度不超过128,适用于私聊/评论/跟帖等情况同一用户或不同用户发送多条违规内容关联检测的场景。如需要检测同一评论下的同一用户发送违规内容盖楼场景,Key传值方式可以为["评论ID,用户ID"]
    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": 1,
            "checkTexts": [{
                "dataId": "0xxd01",
                "taskId": "0xad89"
            }, {
                "dataId": "0xxd02",
                "taskId": "0xad90"
            }]
        }
    }
    
    在线咨询 电话咨询:95163223 免费试用