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