文本纠错

2022.10.12 15:46:13

    请求URL

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

    接口限制

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

    请求参数

    TextGrammarFixReq结构如下:

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

    请求响应

    返回通用结构:

    参数名称 数据类型 是否必填 描述
    code Integer Y 返回错误码, 取值见官网公共返回错误码定义
    msg String Y 返回错误消息
    result TextCheckGrammarFixResult Y 文本纠错结果

    TextCheckGrammarFixResult结构:

    参数名称 数据类型 是否必填 描述
    taskId String Y 数据唯一标识
    level Integer Y 纠错结果标识,0: 无错误,1: 有错误
    details TextCheckGrammarFixDetail Y 纠错详情

    TextCheckGrammarFixDetail结构:

    参数名称 数据类型 是否必填 描述
    correctContent String Y 纠错结果
    fragments List Y 纠错片段

    TextCheckGrammarFixDetailItem结构:

    参数名称 数据类型 是否必填 描述
    oriWord String Y 原错误词
    correctWord String N 错误修正词,仅针对可修改错误类型有效
    headWord String N 错误依赖词,仅针对不可修改错误类型有效
    label String Y 一级错误分类,E100: 常识性错误,E300: 语法错误,E400: 多字少字错误,E500: 涉政错误
    subLabel String N 二级错误分类,可能为空,E100001: 字词错误,E100002: 人名错误,E100003: 地名错误,E400001: 多字,E400002: 少字,E500001: 领土主权错误,E500002: 职务搭配错误
    modifiedType Integer Y 错误类型,0: 可修改错误,1: 不可修改错误
    startPos Integer Y 开始索引位置
    endPos Integer Y 结束索引位置
    headStartPos Integer Y 不可修改错误的相关关键词开始位置
    headEndPos Integer Y 不可修改错误的相关关键词结束位置
    correctSuggestion string Y 当modifiedType=1时返回的建议内容

    请求响应示例

    Request: {
        "businessId": "your_business_id",
        "secretId": "your_secret_id",
        "nonce": 16163,
        "version": "v1",
        "timestamp": 1574653947813,
        "signature": "signature",
        "dataId": "163",
        "content": "今天一期出去玩"
    }
    
    Response: 
    modifiedType为0示例
    {
        "code":200,
        "msg":"ok",
        "result":{
            "taskId":"992351c53dd34958b02512d7723e2049",
            "level":1,
            "details":{
                "correctContent":"今天一起出去玩",
                "fragments":[
                    {
                        "oriWord":"一期",
                        "correctWord":"一起",
                        "label":"E100",
                        "subLabel":"E100001",
                        "modifiedType":0,
                        "startPos":2,
                        "endPos":4
                    }
                ]
            }
        }
    }
    
    modifiedType为1示例
    {
        "code":200,
        "msg":"ok",
        "result":{
            "taskId":"b932f1525f294cf18126e3c5be381708",
            "level":1,
            "details":{
                "correctContent":"中国社会主义",
                "fragments":[
                    {
                        "oriWord":"中国社会主义",
                        "headWord":"",
                        "label":"E500",
                        "subLabel":"",
                        "modifiedType":1,
                        "startPos":0,
                        "endPos":6,
                        "headStartPos":-1,
                        "headEndPos":-1,
                        "correctSuggestion":"中国特色社会主义"
                    }
                ]
            }
        }
    }
    
    Online Chat Tel:95163223