SDK隱私政策
圖像矯正
圖像矯正 API 簡介
概念解釋
圖像矯正服務，對圖片進行方向矯正、效果增強、去除卷曲等操作，對壓縮后的圖像還原清晰圖像，提升圖像的質量。可與圖像矯正、手寫文字識別、試卷手寫體擦除等服務搭配使用，提升文字內容辨識度和綜合識別效果。
說明
Hi，您好，歡迎使用有道智云圖像矯正 API接口服務。
如果您想快速體驗服務，建議您前往 體驗中心 或者在體驗中心右下側找到小程序二維碼，掃描進行體驗。
本文檔主要針對需要集成HTTP API的技術開發工程師，詳細描述OCR識別能力相關的技術內容。
如果您有與我們商務合作的需求，可以通過以下方式聯系我們：
商務郵箱： AIcloud_Business@corp.youdao.com
如果您對文檔內容有任何疑問，可以通過以下幾種方式聯系我們：
客服QQ：1906538062
智云OCR技術交流QQ 1群: 654064748
智云OCR技術交流QQ 2群: 471638046
聯系郵箱： zhiyun@corp.youdao.com
溫馨提示：
接口能力
有道智云圖像矯正 API接口提供OCR圖像矯正服務，您只需要通過調用有道智云OCR API，傳入經過Base64編碼的圖片，通過POST請求方式，就可以得到相應的圖像矯正結果。
有道智云圖像矯正 API HTTPS地址：
https://openapi.youdao.com/ocr_dewarp
協議須知
調用方在集成圖像矯正 API時，請遵循以下規則。
| 規則 | 描述 |
|---|---|
| 傳輸方式 | HTTPS |
| 請求方式 | POST |
| 字符編碼 | 統一使用UTF-8編碼 |
| 響應格式 | 統一采用application/x-www-form-urlencoded格式 |
接口調用參數
調用API需要向接口發送以下字段來訪問服務。
| 字段名 | 含義 | 備注 | 必填 |
|---|---|---|---|
| appKey | 應用標識（應用 ID） | 可在應用管理查看 | true |
| curtime | 時間戳 | 當前UTC時間戳（秒） | true |
| q | 圖片的 base64。編碼大小不超過 5MB | 建議不超過1M,避免對圖像質量壓縮產生影響 | true |
| salt | 隨機字符串 | 最好是UUID,和curtime一起防請求重放 | true |
| sign | 簽名信息：sha256(appKey+input+salt+curtime+密鑰) | 生成簽名可參考下方示例 | true |
| signType | 簽名類型 | v3 | true |
| angle | 是否進行360角度識別(開啟圖像增強預處理時有效) | 0：不開啟，1：開啟。默認不開啟（0） | false |
| enhance | 是否進行圖像增強預處理 | 0：不開啟，1：開啟。默認不開啟（0） | false |
| docDetect | 是否進行圖像檢測, | 0：不開啟，1：開啟。默認開啟（1）。放棄文檔檢測。服務返回結果將不包含文檔類型字段 | false |
| docDewarp | 是否進行圖像矯正,同時將自動跳過輪廓分割。返回結果中的 'dewarped' 字段中是未矯正的圖 | 0：不開啟，1：開啟。默認開啟（1），跳過矯正，同時將自動跳過輪廓分割。返回結果中的 'dewarped' 字段中是未矯正的圖 | false |
| dewarpHeight | 指定矯正圖的目標尺寸（高）,寬度存在時有效 | 0-6000 | false |
| dewarpWidth | 指定矯正圖的目標尺寸（寬）,高度存在時有效 | 0-6000 | false |
簽名生成方法如下： signType=v3； sign=sha256(應用ID+input+salt+curtime+應用密鑰)； 其中，input的計算方式為：input=q前10個字符 + q長度 + q后10個字符（當q長度大于20）或 input=q字符串（當q長度小于等于20）；
如果對簽名有疑問，可以參看文檔末尾各語言demo。
輸出結果
返回的結果是json格式，具體說明如下：
| 字段 | 類型 | 字段說明 |
|---|---|---|
| requestId | text | 請求Id |
| errorCode | text | 錯誤碼 |
| msg | text | 錯誤信息 |
| originalImg | text | base64編碼，原圖 |
| dewarpResults | jsonarray | 圖像處理結果List |
| +dewarped | text | base64編碼，矯正后的圖像 |
| +docType | text | 版面類型,取值范圍是{"A4", "A3_2", "A3_3"}，依次表示A4版面、A3雙欄、A3三欄 |
| +correctionSymbol | text | 內容完全等同于原王標版本的符號檢測的服務返回結果，詳見下述例子 |
| +isDewarped | text | 當前文檔是否被矯正，其取值范圍是{"true", "false"}。值為true表明當前圖是經過矯正的，值為false表明當前圖是被放棄矯正的（常見于A3版面中，由于矯正算法計算出的旋轉角過大，為避免誤矯正，遂放棄矯正） |
correctionSymbols 即為保存了該文檔中符號信息的字典，例如：
{'symbolRegions': [{'boundingBox': '0,231,66,231,66,304,0,304'}, {'boundingBox': '2,951,47,951,47,996,2,996'}, {'boundingBox': '373,119,431,119,431,185,373,185'}, {'boundingBox': '68,1025,118,1025,118,1091,68,1091'}]}
具體可參見下面的參考示例。
參考示例
識別的返回結果：
{
"errorCode": "0",
"msg": "SUCCESS",
"requestId": "534fb4c9-6490-41ce-9dd2-c416f68f579c",
"dewarpResults": [{
"dewarped": "/9j/4AAQSkZJRgABAQA==......", //圖片base64
"docType": "A3_3",
"correctionSymbol": "{\"symbolRegions\":[],\"symbolLabels\":[]}",
"isDewarped": "true"
}],
"originalImg": "/9j/4AAQSkZJRgABAgA==......" //圖片base64
}
服務配置
| 支持圖片格式 | 每小時最大請求次數 | 圖片大小 |
|---|---|---|
| jpg\png\bmp | 3600 | 圖像編碼后大小必須小于5M，建議不要超過1M，會影響圖片質量 |
錯誤代碼列表
| 錯誤碼 | 含義 |
|---|---|
| 101 | 缺少必填的參數，首先確保必填參數齊全，然后，確認參數書寫是否正確。 |
| 102 | 不支持的語言類型 |
| 103 | 翻譯文本過長 |
| 104 | 不支持的API類型 |
| 105 | 不支持的簽名類型 |
| 106 | 不支持的響應類型 |
| 107 | 不支持的傳輸加密類型 |
| 108 | 應用ID無效，注冊賬號，登錄后臺創建應用并完成綁定，可獲得應用ID和應用密鑰等信息 |
| 109 | batchLog格式不正確 |
| 110 | 無相關服務的有效應用，應用沒有綁定。注：某些服務的結果發音需要tts服務，需要在控制臺創建語音合成實例綁定應用后方能使用。 |
| 111 | 開發者賬號無效 |
| 112 | 請求服務無效 |
| 113 | q不能為空 |
| 114 | 不支持的圖片傳輸方式 |
| 201 | 解密失敗，可能為DES,BASE64,URLDecode的錯誤 |
| 202 | 簽名檢驗失敗，如果確認應用ID和應用密鑰的正確性，仍返回202，一般是編碼問題。請確保 img 為 UTF-8 編碼. |
| 203 | 訪問IP地址不在可訪問IP列表 |
| 205 | 請求的接口與應用的平臺類型不一致，確保接入方式（Android SDK、IOS SDK、API）與創建的應用平臺類型一致。如有疑問請參考入門指南 |
| 206 | 因為時間戳無效導致簽名校驗失敗 |
| 207 | 重放請求 |
| 301 | 辭典查詢失敗 |
| 302 | 翻譯查詢失敗 |
| 303 | 服務端的其它異常 |
| 304 | 會話閑置太久超時 |
| 401 | 賬戶已經欠費停 |
| 402 | offlinesdk不可用 |
| 411 | 訪問頻率受限,請稍后訪問 |
| 412 | 長請求過于頻繁，請稍后訪問 |
| 46001 | 未接收到圖片 |
| 46002 | 圖片過大 |
| 46003 | 圖像處理失敗 |
| 46004 | 不支持angle類型 |
| 46005 | 不支持enhance類型 |
| 46008 | 不支持docDetect類型 |
| 46009 | 不支持docDewarp類型 |
| 46010 | 不支持dewarp尺寸類型 |
常用語言 Demo
Java 示例
Python3 示例
C#示例
PHP 示例
go 示例
常見問題
可參考圖像矯正服務常見問題查閱解決方案，若未能解決問題可聯系相關技術同學溝通。