中文作文指導（文本輸入） API 簡介
說明
Hi，您好，歡迎使用有道智云中文作文指導（文本輸入）API 接口服務。
本文檔主要針對需要集成 HTTP API 的技術(shù)開發(fā)工程師，詳細描述中文作文指導（文本輸入）能力相關(guān)的技術(shù)內(nèi)容。
如果您有與我們商務合作的需求，可以通過以下方式聯(lián)系我們：
商務郵箱： AIcloud_Business@corp.youdao.com
如果您對文檔內(nèi)容有任何疑問，可以通過以下幾種方式聯(lián)系我們：
客服 QQ：1906538062
智云作文批改技術(shù)交流 QQ 1 群: 1092639188
聯(lián)系郵箱： zhiyun@corp.youdao.com
溫馨提示：
- 本文檔主要針對開發(fā)人員，接入測試前需要獲取應用 ID 和應用密鑰；如果您還沒有，請按照 新手指南 獲取。
- 平臺向每個賬戶贈送 50 元的體驗金，供用戶集成前測試所用，具體資費規(guī)則詳見 中文作文指導服務報價 。
- 使用前請在控制臺開通中文作文批改(文本輸入)服務.
接口說明
有道 AI 團隊自研的基于深度學習網(wǎng)絡技術(shù)的自動作文指導技術(shù)。覆蓋學生學習全周期，提供高參考價值的智能批改功能，用戶只需要輸入中文作文題目要求，智能批改服務即可一鍵給出針對題目要求的多個維度的分析結(jié)果，從而向用戶提供針對性的作文指導意見。
中文作文指導（文本輸入） API HTTPS 地址：
請求方式：POST
https://openapi.youdao.com/correct_writing_cn_guide_text
協(xié)議須知
調(diào)用方在集成文本翻譯 API 時，請遵循以下規(guī)則。
| 規(guī)則 |
描述 |
| 傳輸方式 |
HTTPS |
| 請求方式 |
POST |
| 字符編碼 |
統(tǒng)一使用 UTF-8 編碼 |
| 請求格式 |
表單 |
| 響應格式 |
JSON |
接口調(diào)用參數(shù)
調(diào)用 API 需要向接口發(fā)送以下字段來訪問服務。
| 字段名 |
含義 |
備注 |
必填 |
| appKey |
應用標識（應用 ID） |
控制臺創(chuàng)建應用獲取 |
true |
| curtime |
當前UTC時間戳(秒) |
時間戳 |
true |
| salt |
隨機字符串 |
1658393284erw |
true |
| sign |
簽名信息：sha256(appKey+input+salt+密鑰) |
sha256(appKey+input+salt+密鑰) |
true |
| signType |
簽名類型 |
v3 |
true |
| requirement |
題目要求 |
長度[4 - 300] |
true |
服務配置
| 服務內(nèi)容 |
說明 |
| 文本輸入 |
最大支持 300字符 |
錯誤代碼列表
| 錯誤碼 |
含義 |
| 101 |
缺少必填的參數(shù)，首先確保必填參數(shù)齊全，然后，確認參數(shù)書寫是否正確。 |
| 102 |
不支持的語言類型 |
| 103 |
翻譯文本過長 |
| 104 |
不支持的 API 類型 |
| 105 |
不支持的簽名類型 |
| 106 |
不支持的響應類型 |
| 107 |
不支持的傳輸加密類型 |
| 108 |
appKey 無效，注冊賬號， 登錄后臺創(chuàng)建應用和實例并完成綁定， 可獲得應用 ID 和密鑰等信息，其中應用 ID 就是 appKey（ 注意不是應用密鑰） |
| 109 |
batchLog 格式不正確 |
| 110 |
無相關(guān)服務的有效實例，應用沒有綁定服務實例，可以新建服務實例，綁定服務實例。注：某些服務的翻譯結(jié)果發(fā)音需要 tts 實例，需要在控制臺創(chuàng)建語音合成實例綁定應用后方能使用。 |
| 111 |
開發(fā)者賬號異常 |
| 201 |
解密失敗，可能為 DES,BASE64,URLDecode 的錯誤 |
| 202 |
簽名檢驗失敗，如果確認應用 ID 和應用密鑰的正確性，仍返回 202，一般是編碼問題。請確保翻譯文本 q 為 UTF-8 編碼. |
| 203 |
訪問 IP 地址不在可訪問 IP 列表 |
| 205 |
請求的接口與應用的平臺類型不一致，確保接入方式（Android SDK、IOS SDK、API）與創(chuàng)建的應用平臺類型一致。 |
| 206 |
因為時間戳無效導致簽名校驗失敗 |
| 207 |
重放請求 |
| 301 |
辭典查詢失敗 |
| 302 |
小語種查詢失敗 |
| 303 |
服務端的其它異常 |
| 401 |
賬戶已經(jīng)欠費停 |
| 411 |
訪問頻率受限,請稍后訪問 |
| 412 |
大圖片請求過于頻繁，請稍后訪問 |
| 29001 |
inputType 類型不對 |
| 29002 |
needTypo 類型不對 |
| 29003 |
Q 超過限制長度 |
| 29004 |
grade 類型不對 |
| 29005 |
文件為空 |
| 29006 |
圖片過大 |
| 29007 |
作文批改的文本內(nèi)容為空 |
| 29100 |
作文指導底層服務異常 |
| 29101 |
作文指導 requirement 長度超出限制 |
| 29102 |
作文指導 requirement 語種不是中文 |
| 29103 |
不合時宜詞匯 |
| 29301 |
作文批改識別失敗 |
| 29302 |
作文批改請求失敗 |
返回結(jié)果參數(shù)
| 參數(shù)名稱 |
描述 |
| RequestId |
請求Id |
| errorCode |
錯誤碼 |
| msg |
錯誤信息 |
| data |
指導結(jié)果（詳見data項） |
data內(nèi)容：
| 名稱 |
類型 |
描述 |
| failedTypes |
List of Integer |
沒有結(jié)果的指導項 |
| guidance |
Guidance |
指導意見（詳見guidance項） |
guidance內(nèi)容：
| 名稱 |
類型 |
描述 |
| analysis |
Integer |
題目解析 |
| corePoint |
Integer |
核心觀點 |
| material |
String |
素材參考 |
| paraAlloc |
String |
段落分配 |
failedTypes 取值說明：
| 取值 |
取值說明 |
| 1 |
題?解析 |
| 2 |
素材參考 |
| 3 |
核?觀點 |
| 4 |
段落分配 |
