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