中文作文批改(文本輸入) API 簡介
說明
Hi,您好,歡迎使用有道智云中文作文批改(文本輸入)API 接口服務(wù)。
本文檔主要針對需要集成 HTTP API 的技術(shù)開發(fā)工程師,詳細(xì)描述中文作文批改(文本輸入)能力相關(guān)的技術(shù)內(nèi)容。
如果您有與我們商務(wù)合作的需求,可以通過以下方式聯(lián)系我們:
商務(wù)郵箱: AIcloud_Business@corp.youdao.com
如果您對文檔內(nèi)容有任何疑問,可以通過以下幾種方式聯(lián)系我們:
客服 QQ:1906538062
智云作文批改技術(shù)交流 QQ 1 群: 1092639188
聯(lián)系郵箱: zhiyun@corp.youdao.com
溫馨提示:
- 本文檔主要針對開發(fā)人員,接入測試前需要獲取應(yīng)用 ID 和應(yīng)用密鑰;如果您還沒有,請按照 新手指南 獲取。
- 平臺向每個賬戶贈送 50 元的體驗(yàn)金,供用戶集成前測試所用,具體資費(fèi)規(guī)則詳見 中文作文批改服務(wù)報(bào)價 。
接口說明
有道 AI 團(tuán)隊(duì)自研的基于深度學(xué)習(xí)網(wǎng)絡(luò)技術(shù)的自動作文批改技術(shù)。覆蓋學(xué)生學(xué)習(xí)全周期,提供高參考價值的智能批改功能,用戶只需要輸入一篇作文,選擇對應(yīng)的作文級別,智能批改服務(wù)即可一鍵給出文章得分、整體評價、拼寫錯誤反饋、語法錯誤反饋、主題相關(guān)度反饋、以及高級詞匯和推薦詞組等一系列結(jié)果,從而向用戶提供針對性的作文指導(dǎo)意見。
中文作文批改(文本輸入) API HTTPS 地址:
請求方式:POST
https://openapi.youdao.com/correct_writing_cn_text
協(xié)議須知
調(diào)用方在集成文本翻譯 API 時,請遵循以下規(guī)則。
規(guī)則 | 描述 |
---|
傳輸方式 | HTTPS |
請求方式 | POST |
字符編碼 | 統(tǒng)一使用 UTF-8 編碼 |
請求格式 | 表單 |
響應(yīng)格式 | JSON |
接口調(diào)用參數(shù)
調(diào)用 API 需要向接口發(fā)送以下字段來訪問服務(wù)。
字段名 | 含義 | 備注 | 必填 |
---|
appKey | 應(yīng)用標(biāo)識(應(yīng)用 ID) | 控制臺創(chuàng)建應(yīng)用獲取 | true |
curtime | 當(dāng)前UTC時間戳(秒) | 時間戳 | true |
q | 正文文本 | 支持中文,長度<=1200 | true |
salt | 隨機(jī)字符串 | 1658393284erw | true |
sign | 簽名信息:sha256(appKey+input+salt+密鑰+curtime) | sha256(appKey+input+salt+密鑰) | true |
signType | 簽名類型 | v3 | true |
grade | 作文等級 | 對應(yīng)k12等級(詳見注意) | false |
title | 作文標(biāo)題 | 長度<=30 | false |
requirement | 題目要求 | 長度<=200 | false |
- 注意:grade 級別為 K12,參數(shù)從 g1、g2、...、g12,默認(rèn)g1
服務(wù)配置
服務(wù)內(nèi)容 | 說明 |
---|
文本輸入 | 最大支持 1200字符 |
錯誤代碼列表
錯誤碼 | 含義 |
---|
101 | 缺少必填的參數(shù),首先確保必填參數(shù)齊全,然后,確認(rèn)參數(shù)書寫是否正確。 |
102 | 不支持的語言類型 |
103 | 翻譯文本過長 |
104 | 不支持的 API 類型 |
105 | 不支持的簽名類型 |
106 | 不支持的響應(yīng)類型 |
107 | 不支持的傳輸加密類型 |
108 | appKey 無效,注冊賬號, 登錄后臺創(chuàng)建應(yīng)用和實(shí)例并完成綁定, 可獲得應(yīng)用 ID 和密鑰等信息,其中應(yīng)用 ID 就是 appKey( 注意不是應(yīng)用密鑰) |
109 | batchLog 格式不正確 |
110 | 無相關(guān)服務(wù)的有效實(shí)例,應(yīng)用沒有綁定服務(wù)實(shí)例,可以新建服務(wù)實(shí)例,綁定服務(wù)實(shí)例。注:某些服務(wù)的翻譯結(jié)果發(fā)音需要 tts 實(shí)例,需要在控制臺創(chuàng)建語音合成實(shí)例綁定應(yīng)用后方能使用。 |
111 | 開發(fā)者賬號異常 |
201 | 解密失敗,可能為 DES,BASE64,URLDecode 的錯誤 |
202 | 簽名檢驗(yàn)失敗,如果確認(rèn)應(yīng)用 ID 和應(yīng)用密鑰的正確性,仍返回 202,一般是編碼問題。請確保翻譯文本 q 為 UTF-8 編碼. |
203 | 訪問 IP 地址不在可訪問 IP 列表 |
205 | 請求的接口與應(yīng)用的平臺類型不一致,確保接入方式(Android SDK、IOS SDK、API)與創(chuàng)建的應(yīng)用平臺類型一致。 |
206 | 因?yàn)闀r間戳無效導(dǎo)致簽名校驗(yàn)失敗 |
207 | 重放請求 |
301 | 辭典查詢失敗 |
302 | 小語種查詢失敗 |
303 | 服務(wù)端的其它異常 |
401 | 賬戶已經(jīng)欠費(fèi)停 |
411 | 訪問頻率受限,請稍后訪問 |
412 | 大圖片請求過于頻繁,請稍后訪問 |
29001 | inputType 類型不對 |
29002 | needTypo 類型不對 |
29003 | Q 超過限制長度 |
29004 | grade 類型不對 |
29005 | 文件為空 |
29006 | 圖片過大 |
29007 | 作文批改的文本內(nèi)容為空 |
29103 | 含不合時宜詞匯 |
29301 | 作文批改識別失敗 |
29302 | 作文批改請求失敗 |
返回結(jié)果參數(shù)
參數(shù)名稱 | 描述 |
---|
RequestId | 請求Id |
errorCode | 錯誤碼 |
Result | 返回結(jié)果(詳見result項(xiàng)) |
Result內(nèi)容:
名稱 | 類型 | 描述 |
---|
orgContent | String | 原始的作文內(nèi)容 |
correctedContent | List of CorrectedSent | content 詳細(xì)的糾正信息(詳見CorrectedSent項(xiàng)) |
scoreCollection | ScoreCollection | 所有的評分信息(詳見ScoreCollection項(xiàng)) |
commentCollection | CommentCollection | 所有的評價信息(詳見commentCollection項(xiàng)) |
detailedEvaluation | DetailedEvaluation | 從句子、詞語角度給出詳細(xì)的評價(詳見detailedEvaluation項(xiàng)) |
CorrectedSent內(nèi)容:
名稱 | 類型 | 描述 |
---|
paraId | Integer | 段落ID |
sentId | Integer | 句子ID |
orgSent | String | 原始句子 |
corSent | String | 修正后的句子 |
orgSentStart | Integer | 原始句子的起始位置(相對于請求中的 content、包含了空格空行等) |
errorInfos | List of ErrorInfo | 針對當(dāng)前句子的錯誤信息(詳見ErrorInfo項(xiàng)) |
ErrorInfo內(nèi)容:
名稱 | 類型 | 描述 |
---|
orgChunk | String | 原始片段 |
corChunk | String | 正確片段 |
orgChunkStart | Integer | 原始片段的起始位置(相對于 orgSent、包含了空格等) |
errorType | String | 錯誤類型,可選項(xiàng)見ErrorType可選項(xiàng) |
ErrorType可選項(xiàng)
ErrorType可選項(xiàng) | 名稱 | 解釋 |
---|
spell | 拼寫錯誤 | 拼寫錯誤包括了同音字錯誤等 |
space | 空格錯誤 | 與空格相關(guān)的各種錯誤 |
punct | 標(biāo)點(diǎn)錯誤 | 與標(biāo)點(diǎn)符號相關(guān)的各種錯誤 |
grammar | 語法錯誤 | 上述錯誤之外的錯誤,會被劃分為語法錯誤 |
CommentCollection
detailedEvaluation
名稱 | 類型 | 描述 |
---|
sentenceEvaluation | List of SentenceEvaluation | 針對句子的評價,比如是不是好句子 |
phraseEvalution | List of PhraseEvaluation | 針對詞語的評價,比如成語 |
SentenceEvaluation (位置信息是左閉右開的區(qū)間)
名稱 | 類型 | 描述 |
---|
type | String | 目前有可選項(xiàng)“good”,用來表明是好句子 |
start | Integer | 句子的起始位置(相對于請求中的 content)(unicode) |
end | Integer | 句子的結(jié)束位置(相對于請求中的 content)(unicode) |
PhraseEvaluation (位置信息是左閉右開的區(qū)間)
名稱 | 類型 | 描述 |
---|
type | String | 目前有可選項(xiàng)“idiom”,用來表明是成語 |
start | Integer | 句子的起始位置(相對于請求中的 content)(unicode) |
end | Integer | 句子的結(jié)束位置(相對于請求中的 content)(unicode) |
explanation | String | 成語解釋,當(dāng) type==“idiom”的時候,這個字段有效 |
ScoreCollection內(nèi)容:
名稱 | 類型 | 限制條件 | 描述 |
---|
score | Integer | 0<=score<=100 | 整體得分 |
perspectiveScore | PerspectiveScore | 見下面的 PerspectiveScore | 從不同的角度,對作文進(jìn)行打分 |
PerspectiveScore(詳見評分規(guī)則)
名稱 | 類型 | 限制條件 | 描述 |
---|
themeExplicit | Integer | 0<=分?jǐn)?shù)<=5 | 主題明確,需要傳入requirement,title才是有效分?jǐn)?shù) |
satisfyRequirement | Integer | 0<=分?jǐn)?shù)<=5 | 符合題意 ,需要傳入requirement才是有效分?jǐn)?shù) |
sentimentSincerity | Integer | 0<=分?jǐn)?shù)<=5 | 感情真摯 |
structureStrict | Integer | 0<=分?jǐn)?shù)<=5 | 結(jié)構(gòu)嚴(yán)謹(jǐn) |
essayFluence | Integer | 0<=分?jǐn)?shù)<=5 | 語言流暢 |
goodSent | Integer | 0<=分?jǐn)?shù)<=5 | 好詞好句 |
評分規(guī)則
評價的方面 | 得分或者限制 | 對應(yīng)的評語 |
---|
satisfyRequirement | 0 |
satisfyRequirement | 1 | 對題意的理解不夠充分,有偏題的嫌疑。 |
satisfyRequirement | 2 | 能理解題目要求,文章基本符合題意。 |
satisfyRequirement | 3 | 能較好地把握題目要求,文章符合題意。 |
satisfyRequirement | 4 | 能正確理解題目要求,文章符合題意。 |
satisfyRequirement | 5 | 能準(zhǔn)確理解題目要求,文章切合題意。 |
themeExplicit | 0 | 中心不夠明確,立意不夠清晰。 |
themeExplicit | 1 | 中心不夠明確,立意不夠清晰。 |
themeExplicit | 2 | 雖有中心主題,但表達(dá)不夠充分有力,文章略顯空洞。 |
themeExplicit | 3 | 主題基本明確。 |
themeExplicit | 4 | 主題較明確。 |
themeExplicit | 5 | 主題明確,立意鮮明。 |
goodSent | 0 |
goodSent | 1 | 用詞過于平淡,缺乏文采。 |
goodSent | 2 | 偶爾使用好詞好句,語言平淡質(zhì)樸。 |
goodSent | 3 | 能夠適當(dāng)運(yùn)用好詞好句,語言生動活潑。 |
goodSent | 4 | 遣詞造句優(yōu)美,文章富有文采。 |
goodSent | 5 | 本文語言極其優(yōu)美,文章極富文學(xué)氣息。 |
sentimentSincerity | 0 | 感受不深刻,缺乏感染力。 |
sentimentSincerity | 1 | 情感缺乏深度。 |
sentimentSincerity | 2 | 語言簡樸,感情平淡,情意不夠深切。 |
sentimentSincerity | 3 | 感情真實(shí),發(fā)自肺腑。 |
sentimentSincerity | 4 | 情感飽滿,情真意切,能深深打動讀者。 |
sentimentSincerity | 5 | 感情真摯動人,情感豐沛,極富感染力。 |
structureStrict | 0 | 條理不清,結(jié)構(gòu)混亂。 |
structureStrict | 1 | 層次不清,結(jié)構(gòu)較亂。 |
structureStrict | 2 | 層次欠清楚,結(jié)構(gòu)較合理。 |
structureStrict | 3 | 層次較分明,結(jié)構(gòu)完整。 |
structureStrict | 4 | 層次清晰,結(jié)構(gòu)完整。 |
structureStrict | 5 | 層次清晰,結(jié)構(gòu)嚴(yán)謹(jǐn)。 |
essayFluence | 0 | 語句不通順,表述不清晰,令人費(fèi)解。 |
essayFluence | 1 | 語句欠通,缺乏連貫性。 |
essayFluence | 2 | 語句基本通順,偶有不暢。 |
essayFluence | 3 | 語句通順流暢。 |
essayFluence | 4 | 語句流暢連貫,自然通達(dá)。 |
essayFluence | 5 | 語言平滑曉暢,可讀性強(qiáng)。 |
比喻手法 | > 3 | 比喻生動形象貼切,本體與喻體形神相似,文章的趣味性與說服力都大大增強(qiáng)了。 |
排比手法 | > 2 | 運(yùn)用排比的手法,既增強(qiáng)語勢,又給讀者留下了十分深刻的印象。 |
其他 | words < 20 or paragraphs < 2 | 您輸入的作文句子、段落數(shù)量較少。 |
- 當(dāng)有額外的
比喻手法
、排比手法
出現(xiàn)的時候,會用此外,
進(jìn)行銜接 - 當(dāng)符合
其他
的情況的時候,會直接返回對應(yīng)的評語
常用語言 Demo
請參考英文作文批改服務(wù)示例demo