文本纠错

请求URL

https://as.dun.163yun.com/v1/grammarfix/submit

接口限制

接口qps为5;纠错内容单次请求<2000字符,包含标点符号。

请求参数

TextGrammarFixReq结构如下:

参数名称数据类型是否必填取值范围描述
secretIdStringY产品秘钥 id ,由易盾内容安全服务分配,产品标识
businessIdStringY业务id ,由易盾内容安全服务分配,业务标识
timestampLongY13位时间毫秒数请求当前 UNIX 时间戳,请注意服务器时间是否同步
nonceIntegerY1-65535随机正整数,与 timestamp 联合起来,用于防止重放攻击
versionStringYv1接口版本号,可选值 v1
signatureStringY见官网签名计算方法请求签名,用来验证此次请求的合法性
dataIdStringY128数据标识,建议每条数据保持唯一性
contentStringY1-2000文本纠错内容 ,最长支持2000字

请求响应

返回通用结构:

参数名称数据类型是否必填描述
codeIntegerY返回错误码, 取值见官网公共返回错误码定义
msgStringY返回错误消息
resultTextCheckGrammarFixResultY文本纠错结果

TextCheckGrammarFixResult结构:

参数名称数据类型是否必填描述
taskIdStringY数据唯一标识
levelIntegerY纠错结果标识,0: 无错误,1: 有错误
detailsTextCheckGrammarFixDetailY纠错详情

TextCheckGrammarFixDetail结构:

参数名称数据类型是否必填描述
correctContentStringY纠错结果
fragmentsListY纠错片段

TextCheckGrammarFixDetailItem结构:

参数名称数据类型是否必填描述
oriWordStringY原错误词
correctWordStringN错误修正词,仅针对可修改错误类型有效
headWordStringN错误依赖词,仅针对不可修改错误类型有效
labelStringY一级错误分类,E100: 常识性错误,E200: 符号单位错误,E300: 语法错误,E400: 多字少字错误,E500: 涉政错误
subLabelStringN二级错误分类,可能为空,E100001: 字词错误,E100002: 人名错误,E100003: 地名错误,E100004: 的地得错误,E100005: 他她它错误,E200001: 标点符号错误,E200002: 数值错误,E200003: 单位错误,E300001:主谓搭配错误,E300002: 述宾搭配错误,E400001: 多字,E400002: 少字,E500001: 领土主权错误,E500002: 职务搭配错误,E500003: 国家机构搭配错误
modifiedTypeIntegerY错误类型,0: 可修改错误,1: 不可修改错误
startPosIntegerY开始索引位置
endPosIntegerY结束索引位置

请求响应示例

Request: {
    "businessId": "your_business_id",
    "secretId": "your_secret_id",
    "nonce": 16163,
    "version": "v1",
    "timestamp": 1574653947813,
    "signature": "signature",
    "dataId": "163",
    "content": "今天一期出去玩"
}

Response: {
    "code": 200,
    "msg": "ok",
    "result": {
        "taskId": "163",
        "level": 1,
        "details": {
            "correctContent": "今天一起出去玩",
            "fragments": [
                "oriWord": "期",
                "correctWord": "起",
                "modifiedType": 0,
                "label": "E100",
                "subLabel": "E100001",
                "startPos": 3,
                "endPos": 4
            ]
        }
}