Hi,您好,歡迎使用有道智云切題API接口服務。
本文檔主要針對需要集成API的技術開發工程師,詳細描述切題能力相關的技術內容。
如果您有與我們商務合作的需求,可以通過以下方式聯系我們:
商務郵箱: AIcloud_Business@corp.youdao.com
如果您對文檔內容有任何疑問,可以通過以下幾種方式聯系我們:
客服QQ:1906538062
智云語音技術交流QQ群:861723255
智云拍照搜題交流QQ群:685832941
聯系郵箱: zhiyun@corp.youdao.com
溫馨提示:
本文檔主要針對開發人員,接入測試前需要在后臺創建API應用;如果您還沒有,請按照 新手指南 操作。 平臺向每個賬戶贈送50元的體驗金,供用戶集成前測試所用,具體資費規則詳見 切題服務報價 。
有道智云OCR API HTTPS地址:
https://openapi.youdao.com/cut_question
調用方在集成文字識別OCRAPI時,請遵循以下規則。
| 規則 | 描述 |
|---|---|
| 傳輸方式 | HTTPS |
| 請求方式 | POST |
| 字符編碼 | 統一使用UTF-8編碼 |
| 請求格式 | 表單 |
| 響應格式 | JSON |
調用API需要向接口發送以下字段來訪問服務。
| 字段名 | 類型 | 含義 | 必填 | 備注 |
|---|---|---|---|---|
| q | text | 要切題的圖片,需要Base64編碼 | True | 必須是Base64編碼 |
| imageType | text | 圖片類型,目前只支持Base64 | True | 目前只支持Base64。請將imageType的值固定為1 |
| appKey | text | 應用ID | True | 可在[應用管理][4]查看 |
| salt | text | UUID,和curtime一起防請求重放 | True | uuid,唯一通用識別碼 |
| docType | text | 服務器響應類型,目前只支持json | True | json |
| signType | text | 簽名類型 | True | v3 |
| curtime | text | 當前UTC時間戳(秒) | True | TimeStamp |
| sign | text | 簽名,sha256(應用ID+input+salt+curtime+應用密鑰) | True | 應用ID+img+salt+應用密鑰的MD5值 |
簽名
sign生成方法如下: signType=v3; sign=sha256(應用ID+input+salt+curtime+應用密鑰)。 其中,input的計算方式為:input=q前10個字符+q長度+q后10個字符(當q長度大于20)或input=q字符串(當q長度小于等于20)。
不同語言獲取時間戳,請參看[此鏈接][5]
如果對簽名有疑問,可以參看文檔末尾各語言demo。
返回的結果是json格式,具體說明如下
| 字段名 | 類型 | 字段說明 |
|---|---|---|
| errorCode | text | 錯誤碼,一定存在。詳細信息參見 錯誤代碼列表 |
| Result | text | 識別結果,查詢成功一定存在 |
| +regions | json array | 區域,查詢正確一定存在 |
| ++boundingBox | text | 題目區域位置信息 |
即識別結果主要在Result中,輸出結構為:regions->boundingBox。一張圖片可能有多個切題區域,即regions中存在多個結果,每個結果中有一個boundingBox。 boundingBox共八個值:分別是左上角坐標(x,y),右上角坐標(x,y),右下角坐標(x,y),左下角(x,y)。
識別的返回結果:
{
"errorCode": "0", //識別錯誤碼
"Result": { //識別結果
"regions": [ //題目
{
"boundingBox": "540,727,1041,727,1041,1138,540,1138" //題目區域位置信息
},
{
"boundingBox": "532,110,1019,110,1019,406,532,406"
},
{
"boundingBox": "56,695,522,695,522,992,56,992"
},
{
"boundingBox": "68,173,518,173,518,354,68,354"
}
]
}
}
| 支持圖片格式 | 每小時最大請求次數 | 圖片大小限制 |
|---|---|---|
| jpg\png\bmp | 3600 | 編碼后小于10M |
| 錯誤碼 | 含義 |
|---|---|
| 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,一般是編碼問題。請確保翻譯文本 q 為UTF-8編碼. |
| 203 | 訪問IP地址不在可訪問IP列表 |
| 205 | 請求的接口與應用的平臺類型不一致,確保接入方式(Android SDK、IOS SDK、API)與創建的應用平臺類型一致。如有疑問請參考入門指南 |
| 206 | 因為時間戳無效導致簽名校驗失敗 |
| 207 | 重放請求 |
| 301 | 辭典查詢失敗 |
| 302 | 翻譯查詢失敗 |
| 303 | 服務端的其它異常 |
| 304 | 會話閑置太久超時 |
| 401 | 賬戶已經欠費停 |
| 402 | offlinesdk不可用 |
| 411 | 訪問頻率受限,請稍后訪問 |
| 412 | 長請求過于頻繁,請稍后訪問 |
| 1001 | 無效的OCR類型 |
| 1002 | 不支持的OCR image類型 |
| 1003 | 不支持的OCR Language類型 |
| 1004 | 識別圖片過大 |
| 1201 | 圖片base64解密失敗 |
| 1301 | OCR段落識別失敗 |
| 1411 | 訪問頻率受限 |
| 1412 | 超過最大識別字節數 |
| 2003 | 不支持的語言識別Language類型 |
| 2004 | 合成字符過長 |
| 2005 | 不支持的音頻文件類型 |
| 2006 | 不支持的發音類型 |
| 2201 | 解密失敗 |
| 2301 | 服務的異常 |
| 2411 | 訪問頻率受限,請稍后訪問 |
| 2412 | 超過最大請求字符數 |
| 3001 | 不支持的語音格式 |
| 3002 | 不支持的語音采樣率 |
| 3003 | 不支持的語音聲道 |
| 3004 | 不支持的語音上傳類型 |
| 3005 | 不支持的語言類型 |
| 3006 | 不支持的識別類型 |
| 3007 | 識別音頻文件過大 |
| 3008 | 識別音頻時長過長 |
| 3009 | 不支持的音頻文件類型 |
| 3010 | 不支持的發音類型 |
| 3201 | 解密失敗 |
| 3301 | 語音識別失敗 |
| 3302 | 語音翻譯失敗 |
| 3303 | 服務的異常 |
| 3411 | 訪問頻率受限,請稍后訪問 |
| 3412 | 超過最大請求字符數 |
| 4001 | 不支持的語音識別格式 |
| 4002 | 不支持的語音識別采樣率 |
| 4003 | 不支持的語音識別聲道 |
| 4004 | 不支持的語音上傳類型 |
| 4005 | 不支持的語言類型 |
| 4006 | 識別音頻文件過大 |
| 4007 | 識別音頻時長過長 |
| 4201 | 解密失敗 |
| 4301 | 語音識別失敗 |
| 4303 | 服務的異常 |
| 4411 | 訪問頻率受限,請稍后訪問 |
| 4412 | 超過最大請求時長 |
| 5001 | 無效的OCR類型 |
| 5002 | 不支持的OCR image類型 |
| 5003 | 不支持的語言類型 |
| 5004 | 識別圖片過大 |
| 5005 | 不支持的圖片類型 |
| 5006 | 文件為空 |
| 5201 | 解密錯誤,圖片base64解密失敗 |
| 5301 | OCR段落識別失敗 |
| 5411 | 訪問頻率受限 |
| 5412 | 超過最大識別流量 |
| 9001 | 不支持的語音格式 |
| 9002 | 不支持的語音采樣率 |
| 9003 | 不支持的語音聲道 |
| 9004 | 不支持的語音上傳類型 |
| 9005 | 不支持的語音識別 Language類型 |
| 9301 | ASR識別失敗 |
| 9303 | 服務器內部錯誤 |
| 9411 | 訪問頻率受限(超過最大調用次數) |
| 9412 | 超過最大處理語音長度 |
| 10001 | 無效的OCR類型 |
| 10002 | 不支持的OCR image類型 |
| 10004 | 識別圖片過大 |
| 10201 | 圖片base64解密失敗 |
| 10301 | OCR段落識別失敗 |
| 10411 | 訪問頻率受限 |
| 10412 | 超過最大識別流量 |
| 11001 | 不支持的語音識別格式 |
| 11002 | 不支持的語音識別采樣率 |
| 11003 | 不支持的語音識別聲道 |
| 11004 | 不支持的語音上傳類型 |
| 11005 | 不支持的語言類型 |
| 11006 | 識別音頻文件過大 |
| 11007 | 識別音頻時長過長,最大支持30s |
| 11201 | 解密失敗 |
| 11301 | 語音識別失敗 |
| 11303 | 服務的異常 |
| 11411 | 訪問頻率受限,請稍后訪問 |
| 11412 | 超過最大請求時長 |
| 12001 | 圖片尺寸過大 |
| 12002 | 圖片base64解密失敗 |
| 12003 | 引擎服務器返回錯誤 |
| 12004 | 圖片為空 |
| 12005 | 不支持的識別圖片類型 |
| 12006 | 圖片無匹配結果 |
| 13001 | 不支持的角度類型 |
| 13002 | 不支持的文件類型 |
| 13003 | 表格識別圖片過大 |
| 13004 | 文件為空 |
| 13301 | 表格識別失敗 |
| 15001 | 需要圖片 |
| 15002 | 圖片過大(1M) |
| 15003 | 服務調用失敗 |
| 17001 | 需要圖片 |
| 17002 | 圖片過大(1M) |
| 17003 | 識別類型未找到 |
| 17004 | 不支持的識別類型 |
| 17005 | 服務調用失敗 |