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