推送模式

2024.01.30 15:43:16

    文档解决方案获取的推送模式用于将举报解决方案异步检测或人工审核结果主动推送给客户,保证客户最快的获取结果。客户需要按照以下规范实现接收结果的接口。推送模式与轮询模式互斥,只能选取一种模式进行结果获取。

    接口说明

    结果主动推送模式以数据为维度,将人工审核结果或者异步机器检测结果推送给客户,需客户在调用检测接口时设置回调地址callbackUrl参数,客户方需保证回调接收接口的可用性和稳定性,确保能正常接收推送过来的结果数据。

    鉴权说明

    客户接口可以通过业务开通时易盾分配的密钥信息字段进行接口鉴权,鉴权粒度是否要精确到业务级别,用户可以根据需要自行决定,请参见接口鉴权

    接入说明

    • 协议说明:检测接口请求参数中指定了回调地址参数callbackUrl(即一个http(s)协议接口的URL)。主动推送接口需要支持http协议,支持POST方法,传输数据编码采用utf-8
    • 接口性能:推送结果接口默认超时时间为2s,为了保证顺利接收数据,客户需保证接收接口可用性和性能稳定
    • 失败重试:客户接口处理结果数据,并返回应答。如果客户接口请求异常,超时或收到的应答不符合规范,易盾会认为推送失败;我们将每隔10分钟推送一次,如果一直失败,持续一天后不再推送
    • 幂等性:结果推送时同样的结果可能会多次请求客户接口。客户接口需要保证幂等性,能够正确处理重复结果数据

    接口耗时

    客户接收接口需保证接收接口可用性和性能稳定,易盾请求超时时间为2s,客户接口尽量保证在1s内返回应答,如有特殊要求,可联系易盾运营适当调整超时时间

    请求

    请求地址

    名称
    HTTP URL 回调地址callbackUrl
    HTTP Method POST

    请求头

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

    请求参数

    名称 类型 必填 最大长度 描述
    secretId String 32 产品密钥 id ,由易盾内容安全云服务分配,产品标识
    signature String 32 请求签名,用来验证此次请求的合法性,具体算法见接口鉴权
    callbackData String - 主动推送结果数据,格式为json字符串,主动推送数据格式和字段描述请参考轮询模式响应结果格式说明

    请求体示例

    callbackData=***&signature=xxx&secretId=xxx
    

    请求体callbackData格式如下,callbackData为json字符串格式,请自行解析或者反转成json对象使用

    异步结果推送

    {
                "antispam": {
                    "dataId": "1631624661543",
                    "taskId": "9183116cf3e6445aa1fe62596689785d",
                    "resultType": 1,
                    "suggestion": 0,
                    "evidences": {
                        "texts": [
                            {
                                "taskId": "80594e188cb1476faf7e9af0d5674cea",
                                "sequence": 0,
                                "startText": "哈哈",
                                "endText": "嗯嗯",
                                "suggestion": 0,
                                "labels": [],
                                "page": 2
                            },
                            {
                                "taskId": "658b05b4d17b49b9a68bead9780cd80a",
                                "sequence": 1,
                                "startText": "n",
                                "endText": "n",
                                "suggestion": 0,
                                "labels": [
                                    {
                                        "label": 500,
                                        "level": 2,
                                        "subLabels": [
                                            {
                                                "subLabel": "500013",
                                                "details": {
                                                    "hitInfos": [
                                                        {
                                                            "positions": [
                                                                {
                                                                    "fieldName": "content",
                                                                    "startPos": 388,
                                                                    "endPos": 391
                                                                }
                                                            ],
                                                            "value": "xxx"
                                                        }
                                                    ]
                                                }
                                            }
                                        ]
                                    }
                                ],
                                "page": 3
                            }
                        ],
                        "images": [
                            {
                                "taskId": "57a2ecf017b94f4592b5f82659e40e0b",
                                "sequence": 0,
                                "imageUrl": "https://iamge-url",
                                "suggestion": 0,
                                "labels": [
                                    {
                                        "label": 500,
                                        "level": 0,
                                        "rate": 1.0
                                    },
                                    {
                                        "label": 300,
                                        "level": 0,
                                        "rate": 1.0,
                                        "labels": [
                                            {
                                                "label": 400,
                                                "level": 1,
                                                "rate": 0.9804,
                                                "subLabels": [
                                                    {
                                                        "subLabel": "40009",
                                                        "rate": 0.9643,
                                                        "details": {
                                                            "hitInfos": [
                                                                {
                                                                    "value": "fire",
                                                                    "group": "违禁"
                                                                }
                                                            ]
                                                        }
                                                    },
                                                    {
                                                        "subLabel": "40010",
                                                        "rate": 0.9964,
                                                        "details": {
                                                            "hitInfos": [
                                                                {
                                                                    "value": "skull",
                                                                    "group": "违禁"
                                                                }
                                                            ]
                                                        }
                                                    }
                                                ]
                                            }
                                        ]
                                    },
                                    {
                                        "label": 100,
                                        "level": 0,
                                        "rate": 0.9999
                                    },
                                    {
                                        "label": 400,
                                        "level": 0,
                                        "rate": 1.0
                                    },
                                    {
                                        "label": 200,
                                        "level": 0,
                                        "rate": 1.0
                                    }
                                ],
                                "page": 3
                            }
                        ]
                    }
                }
            }
    

    人审证据返回

    {
        "antispam":{
            "dataId":"1631625592988",
            "taskId":"a20f4815fb624f0ba9b02463f5715cb9",
            "reviewEvidences":{
                "remark":"",
                "detail":{
                    "text":[
                        {
                            "text":"xxxx",
                            "reason":"好"
                        }
                    ],
                    "image":[
                        {
                            "url":"https://immage-url",
                            "reason":"图片标注"
                        }
                    ]
                }
            },
            "censorLabels":[
                {
                    "code":"1600762076926",
                    "customCode":"自定义标签编码",
                    "name":"审核标签名称",
                    "desc":""
                },
                {
                    "code":"1600759147543",
                    "customCode":"自定义标签编码",
                    "name":"审核标签名称",
                    "desc":""
                }
            ],
            "censorTime":1631625622490,
            "resultType":2,
            "censorSource":1,
            "censorRound":0,
            "suggestion":0,
            "evidences":{
    
            }
        }
    }
    

    响应

    响应结果

    • 客户接口接收到我们回调的结果后,需要返回应答信息,接口响应HTTP状态码为200,当回调处理异常时,应答的HTTP状态码应为500,或者4xx;
    • 目前推送方式默认连接超时(connect timeout)150ms,回调超时(socket timeout)为2s,建议收到推送检测结果后,优先返回reponse应答信息,异步处理检测结果,避免因为回调超时,易盾侧未收到响应重复推送结果。如业务侧对于超时配置有特殊要求,可联系易盾策略经理调整配置。
    • 应答信息为json格式,字段定义如下:
    名称 类型 必须返回 描述
    code Number 应答code,易盾方解析code为200表示推送成功
    msg String 具体描述信息

    响应体示例

    { 
        "code": 200, 
        "msg": "接收成功"
    }
    
    Online Chat Tel:95163223 Free trial