文本潤(rùn)色 API 簡(jiǎn)介
說(shuō)明
Hi，您好，歡迎使用有道智云文本潤(rùn)色API接口服務(wù)。
本文檔主要針對(duì)需要集成HTTP API的技術(shù)開(kāi)發(fā)工程師，詳細(xì)描述文本潤(rùn)色能力相關(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群: 652880659
智云翻譯技術(shù)交流QQ 2群: 669384425
智云翻譯技術(shù)交流QQ 3群: 807539209
智云翻譯技術(shù)交流QQ 4群: 936752411
聯(lián)系郵箱： zhiyun@corp.youdao.com
溫馨提示：
- 本文檔主要針對(duì)開(kāi)發(fā)人員，接入測(cè)試前需要獲取
應(yīng)用ID 和 應(yīng)用密鑰；如果您還沒(méi)有，請(qǐng)按照新手指南 獲取。 - 平臺(tái)向每個(gè)賬戶(hù)贈(zèng)送50元的體驗(yàn)金，供用戶(hù)集成前測(cè)試所用，具體資費(fèi)規(guī)則詳見(jiàn) 文本潤(rùn)色服務(wù)報(bào)價(jià) 。
接口說(shuō)明
文本潤(rùn)色API接口是有道 AI 團(tuán)隊(duì)自研的基于深度學(xué)習(xí)網(wǎng)絡(luò)技術(shù)的文本潤(rùn)色技術(shù)。覆蓋學(xué)生學(xué)習(xí)全周期，提供高參考價(jià)值的智能潤(rùn)色功能，用戶(hù)只需要輸入一段英文，智能文本潤(rùn)色服務(wù)即可把文本分成句子，按句給出潤(rùn)色結(jié)果，并給出潤(rùn)色后句子與原句子之間的差異對(duì)比。
文本潤(rùn)色API HTTPS地址：
https://openapi.youdao.com/v2/polish
協(xié)議須知
調(diào)用方在集成網(wǎng)頁(yè)翻譯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)訪(fǎng)問(wèn)服務(wù)。
| 字段名 | 類(lèi)型 | 含義 | 必填 |
|---|
| appKey | 應(yīng)用標(biāo)識(shí)（應(yīng)用 ID） | 在應(yīng)用管理 查看 | true |
| curtime | 當(dāng)前UTC時(shí)間戳(秒) | 時(shí)間戳 | true |
| title | 潤(rùn)色文本標(biāo)題 | 標(biāo)識(shí)潤(rùn)色文本，0<標(biāo)題長(zhǎng)度<100 | false |
| rawEssay | 潤(rùn)色文本 | 僅支持英文，30 ≤ 文本長(zhǎng)度 ≤10000，有效單詞數(shù) ≥ 3 | true |
| salt | 隨機(jī)字符串 | 可以使用uuid作為唯一標(biāo)識(shí)符 | true |
| sign | 簽名信息 | sha256(應(yīng)用ID+input+salt+curtime+應(yīng)用密鑰) | true |
| signType | 簽名類(lèi)型 | v3 | true |
- 注意： 待潤(rùn)色文本不能為空，長(zhǎng)度必須小于等于10000，有效單詞數(shù)需大于等于3（空格分割單詞）
簽名生成方法如下：
signType=v3；
sign=sha256(應(yīng)用ID+input+salt+curtime+應(yīng)用密鑰)；
其中，input的計(jì)算方式為：input=rawEssay前10個(gè)字符 + rawEssay長(zhǎng)度 + rawEssay后10個(gè)字符（當(dāng)rawEssay長(zhǎng)度大于20）或 input=rawEssay字符串（當(dāng)rawEssay長(zhǎng)度小于等于20）；
注意：
- 接口salt+curtime來(lái)防重放（即一個(gè)請(qǐng)求不可以被請(qǐng)求2次），所以salt最好為UUID。
不同語(yǔ)言獲取時(shí)間戳，請(qǐng)參看此鏈接
如果對(duì)簽名有疑問(wèn)，可以參看各語(yǔ)言demo。
輸出結(jié)果
返回結(jié)果參數(shù)
| 參數(shù)名稱(chēng) | 描述 |
|---|
| requestId | 請(qǐng)求Id |
| code | 處理狀態(tài)碼 |
| msg | 報(bào)錯(cuò)信息 |
| data | 數(shù)據(jù)結(jié)果 |
data 內(nèi)容：
| 名稱(chēng) | 類(lèi)型 | 描述 |
|---|
| sentNum | Integer | 句子數(shù)量 |
| title | String | 文章標(biāo)題 |
| essayLangName | String | 文章語(yǔ)言 |
| sentList | List of SentParaphraseVO | 潤(rùn)色結(jié)果列表 |
SentParaphraseVO 內(nèi)容：
| 名稱(chēng) | 類(lèi)型 | 描述 |
|---|
| index | Integer | 句子索引 |
| code | Integer | 單句子返回結(jié)果狀態(tài)碼 |
| msg | String | 單句子返回結(jié)果狀態(tài)信息 |
| rawSent | String | 潤(rùn)色前原始句子 |
| sentList | List of SentDiffVO | 潤(rùn)色后句子列表 |
SentDiffVO 內(nèi)容：
| 名稱(chēng) | 類(lèi)型 | 描述 |
|---|
| ParaphrasedSent | String | 潤(rùn)色后的句子 |
| diff | List of Diff | 潤(rùn)色后句子與原句子之間的差異對(duì)比 |
Diff 內(nèi)容：
| 名稱(chēng) | 類(lèi)型 | 描述 |
|---|
| operation | String | 差異類(lèi)型：INSERT, DELETE or EQUAL |
| text | String | 差異文本片段 |
SentParaphraseVO code 字段取值說(shuō)明
| 取值 | 取值說(shuō)明 |
|---|
| 0 | 有潤(rùn)色結(jié)果 |
| 1010 | 無(wú)潤(rùn)色結(jié)果：句子過(guò)長(zhǎng)無(wú)法潤(rùn)色 |
| 1011 | 無(wú)潤(rùn)色結(jié)果：算法模型未返回結(jié)果 |
Diff operation 字段取值說(shuō)明：潤(rùn)色前原始句子，經(jīng)過(guò)Diff列表的順序操作后，可轉(zhuǎn)成潤(rùn)色后的句子
| 取值 | 取值說(shuō)明 |
|---|
| DELETE | 潤(rùn)色前原始句子，刪除此text片段，可轉(zhuǎn)成潤(rùn)色后的句子 |
| INSERT | 潤(rùn)色前原始句子，新增此text片段，可轉(zhuǎn)成潤(rùn)色后的句子 |
| EQUAL | 潤(rùn)色前原始句子，保留此text片段，可轉(zhuǎn)成潤(rùn)色后的句子 |
服務(wù)配置
| 潤(rùn)色文本單次字符數(shù) | 潤(rùn)色標(biāo)題字符數(shù) |
|---|
| 長(zhǎng)度必須小于等于10000，有效單詞數(shù)需大于等于3（空格分割單詞） | 0<標(biāo)題長(zhǎng)度<100 |
錯(cuò)誤代碼列表
| 錯(cuò)誤碼 | 含義 |
|---|
| 101 | 缺少必填的參數(shù),首先確保必填參數(shù)齊全，然后確認(rèn)參數(shù)書(shū)寫(xiě)是否正確。 |
| 102 | 不支持的語(yǔ)言類(lèi)型 |
| 103 | 翻譯文本過(guò)長(zhǎng) |
| 104 | 不支持的API類(lèi)型 |
| 105 | 不支持的簽名類(lèi)型 |
| 106 | 不支持的響應(yīng)類(lèi)型 |
| 107 | 不支持的傳輸加密類(lèi)型 |
| 108 | 應(yīng)用ID無(wú)效，注冊(cè)賬號(hào)，登錄后臺(tái)創(chuàng)建應(yīng)用并完成綁定，可獲得應(yīng)用ID和應(yīng)用密鑰等信息 |
| 109 | batchLog格式不正確 |
| 110 | 無(wú)相關(guān)服務(wù)的有效應(yīng)用,應(yīng)用沒(méi)有綁定服務(wù)應(yīng)用，可以新建服務(wù)應(yīng)用。注：某些服務(wù)的翻譯結(jié)果發(fā)音需要tts服務(wù)，需要在控制臺(tái)創(chuàng)建語(yǔ)音合成服務(wù)綁定應(yīng)用后方能使用。 |
| 111 | 開(kāi)發(fā)者賬號(hào)無(wú)效 |
| 112 | 請(qǐng)求服務(wù)無(wú)效 |
| 113 | q不能為空 |
| 114 | 不支持的圖片傳輸方式 |
| 116 | strict字段取值無(wú)效，請(qǐng)參考文檔填寫(xiě)正確參數(shù)值 |
| 199 | 鑒權(quán)時(shí)發(fā)生錯(cuò)誤 |
| 201 | 解密失敗，可能為DES,BASE64,URLDecode的錯(cuò)誤 |
| 202 | 簽名檢驗(yàn)失敗,如果確認(rèn)應(yīng)用ID和應(yīng)用密鑰的正確性，仍返回202，一般是編碼問(wèn)題。請(qǐng)確保翻譯文本 q 為UTF-8編碼. |
| 203 | 訪(fǎng)問(wèn)IP地址不在可訪(fǎng)問(wèn)IP列表 |
| 205 | 請(qǐng)求的接口與應(yīng)用的平臺(tái)類(lèi)型不一致，確保接入方式（Android SDK、IOS SDK、API）與創(chuàng)建的應(yīng)用平臺(tái)類(lèi)型一致。如有疑問(wèn)請(qǐng)參考入門(mén)指南 |
| 206 | 因?yàn)闀r(shí)間戳無(wú)效導(dǎo)致簽名校驗(yàn)失敗, 當(dāng)前UTC時(shí)間戳(秒). |
| 207 | 重放請(qǐng)求,接口salt+curtime來(lái)防重放（即一個(gè)請(qǐng)求不可以被請(qǐng)求2次），所以salt最好為UUID |
| 301 | 辭典查詢(xún)失敗 |
| 302 | 翻譯查詢(xún)失敗 |
| 303 | 服務(wù)端的其它異常 |
| 304 | 會(huì)話(huà)閑置太久超時(shí) |
| 401 | 賬戶(hù)已經(jīng)欠費(fèi)，請(qǐng)進(jìn)行賬戶(hù)充值 |
| 402 | offlinesdk不可用 |
| 405 | 鑒權(quán)失敗 |
| 500 | 翻譯失敗，請(qǐng)參考errorMessage |
| 411 | 訪(fǎng)問(wèn)頻率受限,請(qǐng)稍后訪(fǎng)問(wèn) |
| 412 | 長(zhǎng)請(qǐng)求過(guò)于頻繁，請(qǐng)稍后訪(fǎng)問(wèn) |
| 1001 | 潤(rùn)色文本為空 |
| 1002 | 單句話(huà)超長(zhǎng)錯(cuò)誤(潤(rùn)色文本少于3個(gè)詞) |
| 1003 | 參數(shù)為空或參數(shù)非法 |
| 1004 | 語(yǔ)種非法，請(qǐng)參考語(yǔ)種列表 |
| 1005 | 章長(zhǎng)度限制(30<潤(rùn)色文本字符數(shù)<10000) |
常用語(yǔ)言demo
Java 示例
文本潤(rùn)色 Java demo
