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