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