英文作文批改（文本輸入-高級版） API 簡介

說明

Hi，您好，歡迎使用有道智云英文作文批改（文本輸入-高級版）API 接口服務。

本文檔主要針對需要集成 HTTP API 的技術開發工程師，詳細描述英文作文批改（文本輸入-高級版）能力相關的技術內容。

如果您有與我們商務合作的需求，可以通過以下方式聯系我們：

商務郵箱： AIcloud_Business@corp.youdao.com

如果您對文檔內容有任何疑問，可以通過以下幾種方式聯系我們：

客服 QQ：1906538062

智云作文批改技術交流 QQ 1 群: 1092639188

聯系郵箱： zhiyun@corp.youdao.com

溫馨提示：

本文檔主要針對開發人員，接入測試前需要獲取應用 ID 和應用密鑰；如果您還沒有，請按照 新手指南 獲取。 平臺向每個賬戶贈送 50 元的體驗金，供用戶集成前測試所用，具體資費規則詳見 英文作文批改服務報價 。

接口說明

有道 AI 團隊自研的基于深度學習網絡技術的自動作文批改技術。覆蓋學生英語學習全周期，提供高參考價值的智能批改功能，用戶只需要輸入一篇英文作文，選擇對應的英文級別，智能批改服務即可一鍵給出文章得分、整體評價、拼寫錯誤反饋、語法錯誤反饋、主題相關度反饋、以及高級詞匯和推薦詞組等一系列結果，從而向用戶提供針對性的作文指導意見。

請求地址

https://openapi.youdao.com/v3/correct_writing_text

協議須知

調用方在集成文本翻譯 API 時，請遵循以下規則。

請求參數

簽名生成算法如下：

signType=v3，sha256(應用 ID+input+salt+curtime+密鑰)，推薦使用 sha256 簽名計算方法為：sha256(應用ID+input+salt+當前 UTC 時間戳+密鑰)。

其中，input 的計算方式為：input=多個q拼接后前10個字符 + 多個q拼接長度 + 多個q拼接后十個字符（當多個 q 拼接后長度大于 20）或 input=多個q拼接的字符串（當多個 q 拼接后長度小于等于 20）。

不同語言獲取時間戳，請參看此鏈接

如果對簽名有疑問，可以參看各語言 demo。

grade取值

返回結果

返回結果

例:

{
    "RequestId": "9cd0e024-5927-4c43-8fbf-0d36462cb4ca",
    "errorCode": "0",
    "Result": {
      // 請求原文
      "rawEssay": "Actually, it is sort of a fish berry jam.  Lots of job loss is just one thing resulting from automation. We do the essential Python on 22nd September 2019. We do an important python on the 22nd of September 2019. We have 5 apples in the important things 5 on Sep 2019.",
      // 文章句子數
      "sentNum": 5,
      // 每個請求獨一無二的字符串標識 
      "uniqueKey": "3b9e61e0-d6c1-4194-8cf6-2c4c9ae209c2",
      // 文章最終評價
      "essayAdvice": "",
      // 文章最終得分
      "totalScore": 0,
      // 文章最終簡短評價
      "totalEvaluation": "Excellent!",
      // 語言信息
      "essayLangName": "English",
      // 是AllFeatureScore中score整合結果
      "majorScore": {
        // 語法得分：包括拼寫、語法、句子復雜度得分等
        "grammarScore": 89.8,
        // 語法評價
        "grammarAdvice": "存在少量語法錯誤，建議認真檢查",
        // 內容（主題相關性）得分，如果沒有參考范文，該部分得分會從語法和復雜度上考慮
        "topicScore": 66.2,
        // 詞匯得分：包括詞數、豐富度、高級詞匯等得分
        "wordScore": 89,
        // 詞匯評價
        "wordAdvice": "單詞拼寫基本正確，單詞拼寫基礎扎實；詞匯量較為豐富，能使用一定數量的高級詞匯",
        // 邏輯得分：包括段落和連接詞得分
        "structureScore": 88.3,
        // 邏輯評價
        "structureAdvice": "邏輯性不錯，上下文關系銜接較為緊密"
      },
      // 段落數
      "paraNum": 1,
      // 文章批改結果
      "essayFeedback": {
        // 句子批改結果，所有的句子都僅有語法錯誤，語法錯誤詳細說明看下方：語法錯誤類型詳細說明
        "sentsFeedback": [
          // 第1句話，包含單節點-點擊多項替換錯誤、單節點-展示類型
          {
            // 原句
            "rawSent": "Actually, it is sort of a fish berry jam.",
            // 段落id，從0有序編號
            "paraId": 0,
            // 句子id，從0有序編號
            "sentId": 0,
            // 本句話中所有的語法錯誤，包括基礎和高級錯誤
            "errorPosInfos": [
              // 這是一個單節點-點擊多項替換錯誤
              {
                // 推薦標識id
                "id": 1668590140818,
                // 類似下面的isValidSent，判斷是否為合法片段（該片段如果語言檢測結果與期望不一致，則認為不合法）
                "isValidLangChunk": true,
                // 發生錯誤的內容
                "orgChunk": "Actually",
                // 業務錯誤一級信息
                "errorTypeTitle": "詞匯頻繁使用",
                // orgChunk相對rawSent 起始位置的偏移量
                "startPos": 0,
                // 錯誤塊修正后的具體內容
                "correctChunk": "Actually",
                // orgChunk相對rawSent 結束位置的偏移量
                "endPos": 8,
                // 錯誤的副標題信息
                "cardSubtitle": "替換新單詞",
                // 錯誤基本信息
                "errBaseInfo": "詞匯使用頻繁，建議替換新單詞",
                // 業務劃定的錯誤大類信息
                "errToBBasicType": "",
                // 錯誤原因的詳細解釋(比reason更進一步)
                "detailReason": "詞匯使用頻繁",
                // 所有例句
                "exampleCases": [],
                // 節點類型 1-單節點，2-多節點
                "nodeType": 1,
                // 結構類型 1-提示類，2-點擊單項替換，3-點擊多項替換，4-點擊選擇替換類
                "structType": 3,
                // 展示類型，1-基礎卡片與1.0一致，2-高級卡片
                "showType": 2,
                // 當nodeType=1，structType=3時，表示多項值
                "target": [
                  "Really",
                  "Indeed"
                ],
                // 是否vip卡片
                "vip": true
              },
              // 這是一個單節點-提示類型錯誤
              {
                "id": 1668590140820,
                "isValidLangChunk": true,
                "orgChunk": "sort of",
                "errorTypeTitle": "不必要的修飾詞",
                "startPos": 16,
                "correctChunk": "sort of",
                "endPos": 23,
                "cardSubtitle": "刪除修飾詞",
                "errBaseInfo": "學術用詞具體、簡潔，口語化的一些補白詞不夠正式，表意模糊，建議刪除[rValidChunk]",
                "errToBBasicType": "",
                "detailReason": "學術用詞具體、簡潔，口語化的一些補白詞不夠正式，表意模糊",
                "knowledgeExp": "學術寫作要求用詞<b>明確、簡潔</b>，類似kind of的補白詞模糊性較強，過于口語化，建議刪除。",
                // 所有例句
                "exampleCases": [
                  {
                    // 原句
                    "error": "An oil does not blend with water",
                    // 例句翻譯
                    "rightTranslate": "油不溶于水。",
                    // 例句
                    "right": "Oil does not blend with water."
                  }
                ],
                "nodeType": 1,
                "showType": 2,
                "structType": 2,
                "target": [],
                "vip": true
              }
            ],
            // 錯誤原因反饋，基于errorPosInfos中所有reason字段拼接而成
            "sentFeedback": "詞匯頻繁使用，建議替換新單詞；不必要的修飾詞，建議刪除〖sort of〗",
            // 該句子在全文中相對于文章 初始位置的偏移量
            "sentStartPos": 0,
            // 正確的句子
            "correctedSent": "Actually, it is sort of a fish berry jam.",
            // 返回是否含有語法錯誤
            "isContainGrammarError": false,
            // 返回是否含有typo錯誤
            "isContainTypoError": false,
            // 是否為合法句子（合法與否取決于語言檢測對該句的語言信息識別結果與期望結果是否一致）  
            "isValidLangSent": true,
          },
          // 省略的中間的句子反饋信息
          // 第3句話，包含多節點選擇替換錯誤
          {
            "rawSent": "We do the essential Python on 22nd September 2019.",
            "paraId": 0,
            "sentId": 2,
            "errorPosInfos": [
              // 這是一個多節點選擇替換錯誤的其中一個節點
              {
                "id": 1668590140825,
                "isValidLangChunk": true,
                "orgChunk": "22nd September",
                "errorTypeTitle": "日期表達不一致",
                "startPos": 30,
                "correctChunk": "{\"DthMonth\":\"22nd September\",\"TheDthofMonth\":\"the 22nd of September\",\"MonthDth\":\"September 22nd\"}",
                "endPos": 44,
                "cardSubtitle": "使用一致的日期表達",
                "errBaseInfo": "上下文日期表達不一致，建議使用一致的日期表達",
                "errToBBasicType": "",
                "detailReason": "上下文日期表達不一致",
                "knowledgeExp": "<b>日期</b>有幾種不同表達方式。January 20，January 20th，Jan. 20，以及20 January都是正確的。一篇文章通常<b>保持日期表達一致</b>。",
                "exampleCases": [

                ],
                // 多節點的parentId一致
                "parentId": "1668590140767",
                "nodeType": 2,
                // 只有nodeType=2，structType=4，且是日期錯誤才會出現
                // 原片段
                "orgDateType": "Dth Month",
                "showType": 2,
                "structType": 4,
                "vip": true,
                // 只有nodeType=2，structType=4，才會存在
                "statInfo": [
                  {
                    // 該類型出現的數量
                    "count": 1,
                    // 示例，日期類型才會存在
                    "demo": "5th Dec",
                    // 類型
                    "item": "Dth Month"
                  },
                  {
                    "count": 1,
                    "demo": "The 5th of Dec",
                    "item": "The Dth of Month"
                  }
                ],
              }
            ],
            "sentFeedback": "大小寫不統一，建議修改大小寫；日期表達不一致，建議使用一致的日期表達",
            "sentStartPos": 105,
            "correctedSent": "We do the essential {\"lower\":\"python\",\"capitalize\":\"Python\"} on {\"DthMonth\":\"22nd September\",\"TheDthofMonth\":\"the 22nd of September\",\"MonthDth\":\"September 22nd\"} 2019.",
            "isContainGrammarError": false,
            "isContainTypoError": false,
            "isValidLangSent": true
          },
          // 第4句話，包含多節點選擇替換錯誤
          {
            "rawSent": "We do an important python on the 22nd of September 2019.",
            "paraId": 0,
            "sentId": 3,
            "errorPosInfos": [
              // 這是一個多節點選擇替換錯誤的其中一個節點，與第3句話的錯誤有同樣的父parentId
              {
                "id": 1668590140828,
                "isValidLangChunk": true,
                "orgChunk": "the 22nd of September",
                "orgDateType": "The Dth of Month",
                "errorTypeTitle": "日期表達不一致",
                "startPos": 29,
                "correctChunk": "{\"DthMonth\":\"22nd September\",\"TheDthofMonth\":\"the 22nd of September\",\"MonthDth\":\"September 22nd\"}",
                "endPos": 50,
                "cardSubtitle": "使用一致的日期表達",
                "errBaseInfo": "上下文日期表達不一致，建議使用一致的日期表達",
                "errToBBasicType": "",
                "detailReason": "上下文日期表達不一致",
                "knowledgeExp": "<b>日期</b>有幾種不同表達方式。January 20，January 20th，Jan. 20，以及20 January都是正確的。一篇文章通常<b>保持日期表達一致</b>。",
                "exampleCases": [],
                "parentId": "1668590140767",
                "nodeType": 2,
                "showType": 2,
                "statInfo": [
                  {
                    "count": 1,
                    "demo": "5th Dec",
                    "item": "Dth Month"
                  },
                  {
                    "count": 1,
                    "demo": "The 5th of Dec",
                    "item": "The Dth of Month"
                  }
                ],
                "structType": 4,
                "vip": true
              }
            ],
            "sentFeedback": "詞匯頻繁使用，建議替換新單詞；大小寫不統一，建議修改大小寫；日期表達不一致，建議使用一致的日期表達",
            "sentStartPos": 156,
            "correctedSent": "We do an important {\"lower\":\"python\",\"capitalize\":\"Python\"} on {\"DthMonth\":\"22nd September\",\"TheDthofMonth\":\"the 22nd of September\",\"MonthDth\":\"September 22nd\"} 2019.",
            "isContainGrammarError": false,
            "isContainTypoError": false,
            "isValidLangSent": true
          },
          // 第5句話，包含單節點點擊單項替換錯誤
          {
            "rawSent": "We have 5 apples in the important things 5 on Sep 2019.",
            "paraId": 0,
            "sentId": 4,
            "errorPosInfos": [
              {
                "id": 1668590140830,
                "isValidLangChunk": true,
                "orgChunk": "5",
                "errorTypeTitle": "拼寫不統一",
                "startPos": 8,
                "correctChunk": "five",
                "endPos": 9,
                "cardSubtitle": "拼寫單詞",
                "errBaseInfo": "阿拉伯數字應該使用英文拼寫，建議將[orgChunk]修改為[correctChunk]",
                "errToBBasicType": "",
                "detailReason": "阿拉伯數字應該使用英文拼寫",
                "knowledgeExp": "一般來說，<b>0到9的數字</b>都應該<b>拼寫</b>出來。如果想要表達日期、地址、金錢、分數、百分比、分數和小數，可以直接使用數字。",
                "exampleCases": [],
                "nodeType": 1,
                "showType": 2,
                "structType": 2,
                "vip": true
              }
            ],
            "sentFeedback": "拼寫不統一，建議將〖5〗修改為【five】；詞匯頻繁使用，建議替換新單詞",
            "sentStartPos": 213,
            "correctedSent": "We have five apples in the important things 5 on Sep 2019.",
            "isContainGrammarError": true,
            "isContainTypoError": false,
            "isValidLangSent": true

          }
        ]
      },
      // 單詞數
      "wordNum": 0,
      // 文章總分
      "fullScore": 100,
      // 請求學段英文名稱
      "stLevel": "TASK1",
      // 請求學段code
      "stLevelCode": 9,
      // 請求標題
      "title": "yapi-test-1",
      // 請求寫作模式
      "writeModel": 1,
      // 請求文體類型
      "writeType": 1,
      // 請求細分學段code
      "articleFormCode": 90102,
      // 寫作報告，可看下方
      "essayReport": {}
    }
}

寫作報告essayReport：

{
  "essayReport": {
    // 平均句長
    "avgSentLen": 17.1,
    // 平均句長建議
    "avgSentLenAdvice": "文章平均句長為17.1，達到四級優秀作文平均句長。",
    // 平均詞長
    "avgWordLen": 4.8,
    // 平均詞長建議
    "avgWordLenAdvice": "平均詞長代表了文章單詞的平均長度。\n文章平均詞長為4.8，達到四級優秀作文平均詞長。",
    // 字符數
    "charNum": 1013,
    // 文章連接詞建議
    "conjAdvice": {
      // 需要將占位符替換的值列表
      "fillers": [
        6,
        [
          "并列",
          "因果",
          "順序"
        ]
      ],
      // 建議，包括占位符字段
      "original": "文章行文連貫，銜接手段運用自如，段落間邏輯緊密層次分明，實為佳作！\n文中共使用了%s種邏輯連接詞，使用較多的有表示%s關系的邏輯連接詞。合理運用邏輯連接詞可增強文章的連貫性與邏輯性，建議適當積累一些邏輯連接詞。",
      // 占位符
      "placeholder": "%s"
    },
    // 邏輯連接詞，按比例從降序排序
    "conjTypeInfos": [
      {
        // 數量
        "count": 4,
        // 名稱
        "name": "并列",
        // 比例
        "percent": 0.29
      },
      {
        "count": 4,
        "name": "因果",
        "percent": 0.29
      },
      {
        "count": 2,
        "name": "順序",
        "percent": 0.14
      },
      {
        "count": 2,
        "name": "讓步",
        "percent": 0.14
      },
      {
        "count": 1,
        "name": "遞進",
        "percent": 0.07
      },
      {
        "count": 1,
        "name": "其他",
        "percent": 0.07
      }
    ],
    // 邏輯連接詞數量
    "conjWordNum": 7,
    // 文章最終評價
    "essayAdvice": "作文整體水平有待提高",
    // 對應級別滿分
    "fullScore": 100,
    // 語法錯誤建議
    "grammarErrorAdvice": {
      // 建議
      "advice": "建議復習相關語法知識。",
      // 所有的語法錯誤，按比例降序排序
      "errors": [
        {
          // 出現次數
          "count": 12,
          // 錯誤類型
          "name": "詞匯拼寫錯誤",
          // 出現比例，二位小數
          "percent": 0.33
        },
        {
          "count": 7,
          "name": "詞匯使用錯誤",
          "percent": 0.2
        },
        {
          "count": 4,
          "name": "固定搭配介詞錯誤",
          "percent": 0.11
        },
        {
          "count": 3,
          "name": "名詞單復數錯誤",
          "percent": 0.09
        },
        {
          "count": 2,
          "name": "限定詞缺失",
          "percent": 0.06
        },
        {
          "count": 7,
          "name": "其他",
          "percent": 0.21
        }
      ],
      // 評價
      "evaluation": "整體語法錯誤較多，高頻語法錯誤有",
      // 高頻的語法錯誤
      "highFreqErrors": [
        "詞匯拼寫錯誤",
        "詞匯使用錯誤"
      ]
    },
    // 真正的語法錯誤數量
    "grammarErrorNum": 23,
    // 錯誤的句子比率
    "grammarErrorSentRatio": 0.8,
    // 高頻語法錯誤
    "highFreqErrors": [
      {
        // 出現次數
        "count": 12,
        // 錯誤類型
        "name": "詞匯拼寫錯誤"
      },
      {
        // 出現次數
        "count": 7,
        // 錯誤類型
        "name": "詞匯使用錯誤"
      }
    ],
    // 詞匯水平分布信息，占比保留3位小數
    "lexicalDistribution": {
      // 詞匯水平分布建議
      "advice": "您的文章與<span>優秀四級</span>作文平均詞匯分布相比：使用的詞匯水平有限，詞匯分布合理，滿足考試的需求，建議繼續通過寫作練習詞匯和表達哦！",
      //小學詞匯數量
      "primaryWordNum": 0,
      //小學詞匯數量占比
      "primaryWordNumPercent": 0.000,
      //初中詞匯數量
      "juniorWordNum": 0,
      //初中詞匯數量占比
      "juniorWordNumPercent": 0.000,
      //高中詞匯數量
      "seniorWordNum": 0,
      //高中詞匯數量占比
      "seniorWordNumPercent": 0.000,
      //四級詞匯數量
      "cet4WordNum": 0,
      //四級詞匯數量占比
      "cet4WordNumPercent": 0.000,
      //六級詞匯數量
      "cet6WordNum": 0,
      //六級詞匯數量占比
      "cet6WordNumPercent": 0.000,
      //托福詞匯數量
      "toeflAndIeltsWordNum": 0,
      //托福詞匯數量占比
      "toeflAndIeltsWordNumPercent": 0.000
    },
    // 主要得分和建議，分數一位小數
    "majorScore": {
      //語法得分：包括拼寫、語法、句子復雜度得分等
      "grammarScore": 0.0,
      //語法評價
      "grammarAdvice": "",
      //內容（主題相關性）得分，如果沒有參考范文，該部分得分會從語法和復雜度上考慮
      "topicScore": 0.0,
      //內容評價，目前均為null
      "topicAdvice": "",
      //詞匯得分：包括詞數、豐富度、高級詞匯等得分
      "wordScore": 0.0,
      //詞匯評價
      "wordAdvice": "",
      //邏輯得分：包括段落和連接詞得分
      "structureScore": 0.0,
      //邏輯評價
      "structureAdvice": "",
      /**
       * 重點項
       * 0 :語法分項
       * 1 :單詞分項
       * 2 :結構分項
       */
      "emphasis": 0
    },
    // 批改中包含在語法錯誤中，但在寫作報告中并非語法錯誤的數量（標點、拼寫、空格）
    "notTrueGrammarErrorNum": 15,
    // 段落數
    "paraNum": 1,
    // 原文長度
    "rawLength": 1024,
    // 可讀性得分對應等級
    "readGrade": 5,
    // 可讀性得分
    "readability": 71,
    // 可讀性評價
    "readabilityEvaluation": "文章適合具有專家英語水平的人群閱讀",
    // 優秀分界線，小數點數值類型保留1-3位小數
    "scoreBorders": {
      //水平編號
      "stLevel": "4",
      //水平名稱
      "name": "四級",
      //優秀作文平均詞長上邊界
      "maxAvgWordsLen": 0.0,
      //優秀作文平均詞長下邊界
      "minAvgWordsLen": 0.0,
      //優秀作文平均句長上邊界
      "maxAvgSentsLen": 0.0,
      //優秀作文平均句長下邊界
      "minAvgSentsLen": 0.0,
      //優秀作文句子豐富度上邊界
      "maxStdSentsLen": 0.0,
      //優秀作文句子豐富度下邊界
      "minStdSentsLen": 0.0,
      //優秀作文小學詞匯占比
      "maxPrimary": 0.0,
      //優秀作文初中詞匯占比
      "maxJunior": 0.0,
      //優秀作文高中詞匯占比
      "maxSenior": 0.0,
      //優秀作文四級詞匯占比
      "maxCET4": 0.0,
      //優秀作文六級詞匯占比
      "maxCET6": 0.0,
      //優秀作文托福雅思詞匯占比
      "maxToeflAndIelts": 0.0
    },
    // 句子成分
    "sentComplexInfo": {
      // 復雜句數量
      "complexSentNum": 6,
      // 復雜句百分比
      "complexSentPercent": 0.5,
      // 句子評價建議
      "sentenceStructureAdvice": "簡單句與復雜句均能綜合使用，句子結構較為合理。",
      // 簡單句數量
      "simpleSentNum": 6,
      // 簡單句百分比
      "simpleSentPercent": 0.5
    },
    // 句子數
    "sentNum": 12,
    // 句長豐富度
    "stdSentLen": 7.9,
    // 句長豐富度建議，計算結果
    "stdSentLenAdvice": "句長豐富度會影響文章結構分。\n文章句長豐富度為7.9，達到四級優秀作文句長豐富度，文章讀起來比較生動。",
    // 總得分
    "totalScore": 57,
    // 單子數
    "wordNum": 178
  },
}

錯誤代碼列表

常用語言 Demo

Java 示例

英文文本批改 Java demo

Python 示例~

英文文本批改 Python3 demo

C# 示例

英文文本批改 c# demo

PHP 示例

英文文本批改 php demo

go 示例

英文文本批改 go demo