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