表格OCR Android SDK 簡(jiǎn)介
概述
(1) 概念解釋
表格識(shí)別:基于深度學(xué)習(xí)技術(shù),自動(dòng)定位并識(shí)別圖片中表格的位置、結(jié)構(gòu)及文字內(nèi)容,結(jié)構(gòu)化返回可編輯的表格結(jié)果。支持用戶上傳報(bào)表、帶有表格的圖片等。
(2) 說(shuō)明
Hi,您好,歡迎使用有道智云表格識(shí)別OCR Android SDK。
如果您想快速體驗(yàn)服務(wù),建議您前往有道智云平臺(tái) 體驗(yàn)中心 或者在體驗(yàn)中心右下側(cè)找到小程序二維碼,掃描進(jìn)行體驗(yàn)。
本文檔主要針對(duì)需要集成表格識(shí)別服務(wù)OCR Android SDK的開發(fā)工程師,詳細(xì)描述有道表格識(shí)別能力及集成過程。
如果您有與我們商務(wù)合作的需求,可以通過以下方式聯(lián)系我們:
商務(wù)郵箱: AIcloud_Business@corp.youdao.com
如果您對(duì)文檔內(nèi)容有任何疑問,可以通過以下幾種方式聯(lián)系我們:
客服QQ:1906538062
智云OCR技術(shù)交流QQ 1群: 654064748
智云OCR技術(shù)交流QQ 2群: 471638046
聯(lián)系郵箱: zhiyun@corp.youdao.com
溫馨提示:
本文檔主要針對(duì)開發(fā)人員,接入測(cè)試前需要在后臺(tái)創(chuàng)建Android應(yīng)用,并綁定實(shí)例;如果您還沒有,請(qǐng)按照 新手指南 操作。
平臺(tái)向每個(gè)賬戶贈(zèng)送50元的體驗(yàn)金,供用戶集成前測(cè)試所用,具體資費(fèi)規(guī)則詳見 表格OCR服務(wù)報(bào)價(jià) 。
功能介紹
表格識(shí)別OCR SDK是有道在線表格識(shí)別OCR 接口服務(wù)進(jìn)行封裝,支持在線表格識(shí)別。提供快速的接入方式;同時(shí)提供數(shù)據(jù)統(tǒng)計(jì)能力,方便了解用戶使用情況。
兼容性
支持設(shè)備:運(yùn)行了 Android 4.0.3以及以上系統(tǒng)的 Android 設(shè)備
表格識(shí)別OCR Android SDK集成指南
集成前提
開始集成SDK之前開發(fā)者需要登錄 有道智云平臺(tái) ,創(chuàng)建應(yīng)用獲取應(yīng)用ID(或者通過運(yùn)營(yíng)人員獲取應(yīng)用ID),以便使用表格識(shí)別OCR服務(wù)。
集成步驟
(1) SDK包導(dǎo)入
請(qǐng)?jiān)诠こ涛募夸浵聞?chuàng)建一個(gè)名為 libs 的子目錄(有的話則不需要?jiǎng)?chuàng)建),并將YoudaoBase.jar so包和YoudaoTableRecognize.jar拷貝到 libs 目錄下,并將以下代碼添加到app的build.gradle中:
android {
    sourceSets.main.jniLibs.srcDirs = ['libs']
    ...
}
dependencies {
    compile files('libs/YoudaoBase_v2.0.0.jar')
    compile files('libs/YoudaoTableRecognize_v2.0.0.jar')
}
(2) AndroidManifest配置
<uses-permission android:name="android.permission.INTERNET" />
<!-- 獲取WiFi狀態(tài) -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<!-- 獲取網(wǎng)絡(luò)信息狀態(tài),如當(dāng)前的網(wǎng)絡(luò)連接是否有效 -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!-- 往SDCard讀寫數(shù)據(jù)權(quán)限   storage group -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
(3) 代碼混淆配置
代碼混淆文件proguard-project.txt,添加如下內(nèi)容:
-ignorewarnings
-libraryjars libs/YoudaoBase_v2.0.0.jar
-libraryjars libs/YoudaoTableRecognize_v2.0.0.jar
-keep class com.youdao.sdk.ydtranslate.** { ;} 
-keep class com.youdao.yd_table_recognize.* { *;}
(4) SDK初始化
使用之前請(qǐng)?jiān)诔绦虻腁pplication中調(diào)用SDK初始化代碼,可以參考demo中DemoApplication。
注:appkey即應(yīng)用ID。
//appkey即應(yīng)用ID。
YouDaoApplication.init(this, appkey);
功能集成
說(shuō)明:請(qǐng)參考 yd_table_recognize_demo 中 TableDemoActivity 的使用
(1) 參數(shù)說(shuō)明
type:上傳類型, 僅支持base64上傳(1)和文件上傳(2),請(qǐng)按需填寫
docType:服務(wù)器響應(yīng)類型,可選字段,默認(rèn)為json。目前只支持json和excel
angle:是否檢測(cè)圖片角度,可選字段,默認(rèn)檢測(cè)。0表示不檢測(cè);1表示檢測(cè)
輸入圖片格式支持:jpg/png
輸入圖片尺寸限制:2MB以下
輸入圖片數(shù)據(jù):需要轉(zhuǎn)換為Base64編碼。
(2) 構(gòu)造表格OCR識(shí)別參數(shù)對(duì)象
//表格OCR識(shí)別
TableRecognizeParameters tps = new TableRecognizeParameters.Builder()
                .type(TableRecognizeParameters.TYPE_BASE64)
                .build())
(3) 設(shè)置回調(diào)和開始識(shí)別
通過TableRecognize,設(shè)置上一步構(gòu)造的參數(shù)對(duì)象,調(diào)用recognize方法傳入圖片base64編碼的數(shù)據(jù)和回調(diào)接口開始查詢
識(shí)別回調(diào)接口包含兩個(gè)方法:onResult表示識(shí)別成功,結(jié)果json字符串形式給用戶,onError表示失敗,失敗信息已錯(cuò)誤碼的形式給用戶。
注意:整個(gè)識(shí)別是異步的,回調(diào)在子線程進(jìn)行,若涉及到界面操作,請(qǐng)切回主線程。
//OCR表格識(shí)別
TableRecognize.getInstance(tps)
                .recognize(base64, new TableRecognizeListener() {
                    @Override
                    public void onError(final int errorCode) {
                        handler.post(new Runnable() {
                            @Override
                            public void run() {
                                resultText.setText("識(shí)別失敗 " + TableRecognizeErrorCode.getErrorString(errorCode));
                                YouDaoLog.w("TableRecognize onError,errorCode = " + errorCode);
                            }
                        });
                    }
                    @Override
                    public void onResult(final String resultJson, final String input) {
                        handler.post(new Runnable() {
                            @Override
                            public void run() {
                                resultText.setText("識(shí)別完成");
                                YouDaoLog.w("TableRecognize onResult,result = " + resultJson + "\n" + ",input = " + input);
                                showResult(resultJson);
                            }
                        });
                    }
                });
結(jié)果說(shuō)明
| 字段 | 含義 | 
| -orientation | 圖片方向 | 
| -tables | 返回的表格,如果一張圖像中有多個(gè)表格,返回多個(gè) | 
| --cells | 表格中的單元格 | 
| --rowRange | 單元格行號(hào)的范圍,如果當(dāng)前行存在單元格合并情況,兩個(gè)值不同 | 
| --colRange | 單元格列號(hào)的范圍,如果當(dāng)前列存在單元格合并情況,兩個(gè)值不同 | 
| --boundingBox | 單元格文字的坐標(biāo) | 
| --dir | 單元格方向:h水平 v豎直 | 
| --lang | 文字種類 zh為中文 | 
| --lines | 單元格中的每一行 | 
| ---boundingBox | 行的坐標(biāo) | 
| ---text | 識(shí)別的行文字 | 
| ---words | 字級(jí)別組 | 
| ----word | 識(shí)別的文字 | 
| ----boundingBox | 字的坐標(biāo) | 
查詢結(jié)果以json形式給用戶格式如下所示,表格渲染可參考demo中h5表格渲染方式。
{
		"orientation": "UP",
		"tables": [{
			"boundingBox": "2106,2076,3927,2107,3912,2997,2091,2966",
			"cells": [{
				"boundingBox": "2477,2264,2602,2266,2599,2407,2474,2405",
				"rowRange": "0,0",
				"colRange": "0,0",
				"dir": "h",
				"lang": "fr",
				"lines": [{
					"boundingBox": "2477,2264,2602,2266,2599,2407,2474,2405",
					"words": [{
						"boundingBox": "2508,2264,2602,2266,2599,2407,2505,2405",
						"word": "11"
					}],
					"text": "11"
				}]
			}, {
				"boundingBox": "3352,2252,3482,2254,3480,2400,3350,2398",
				"rowRange": "0,0",
				"colRange": "1,1",
				"dir": "h",
				"lang": "en",
				"lines": [{
					"boundingBox": "3352,2252,3482,2254,3480,2400,3350,2398",
					"words": [{
						"boundingBox": "3384,2253,3482,2254,3480,2400,3382,2399",
						"word": "12"
					}],
					"text": "12"
				}]
			}, {
				"boundingBox": "2432,2700,2594,2703,2592,2849,2430,2846",
				"rowRange": "1,1",
				"colRange": "0,0",
				"dir": "h",
				"lang": "en",
				"lines": [{
					"boundingBox": "2432,2700,2594,2703,2592,2849,2430,2846",
					"words": [{
						"boundingBox": "2464,2700,2594,2703,2592,2849,2462,2846",
						"word": "21"
					}],
					"text": "21"
				}]
			}, {
				"boundingBox": "3303,2656,3641,2661,3637,2926,3299,2920",
				"rowRange": "1,1",
				"colRange": "1,1",
				"dir": "h",
				"lang": "fr",
				"lines": [{
					"boundingBox": "3303,2656,3640,2754,3637,2926,3300,2827",
					"words": [{
						"boundingBox": "3345,2668,3640,2754,3637,2926,3342,2840",
						"word": "224"
					}],
					"text": "224"
				}]
			}],
			"rowNum": "2",
			"colNum": "2"
		}],
		"regions": []
}
錯(cuò)誤代碼列表
| 錯(cuò)誤碼 | 含義 | 
| 101 | 缺少必填的參數(shù) | 
| 102 | 不支持的語(yǔ)言類型 | 
| 103 | 翻譯文本過長(zhǎng) | 
| 104 | 不支持的API類型 | 
| 105 | 不支持的簽名類型 | 
| 106 | 不支持的響應(yīng)類型 | 
| 107 | 不支持的傳輸加密類型 | 
| 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í)例 | 
| 111 | 開發(fā)者賬號(hào)無(wú)效 | 
| 113 | q不能為空 | 
| 114 | 不支持的圖片傳輸方式 | 
| 201 | 解密失敗,可能為DES,BASE64,URLDecode的錯(cuò)誤 | 
| 202 | 簽名檢驗(yàn)失敗 | 
| 203 | 訪問IP地址不在可訪問IP列表 | 
| 205 | 請(qǐng)求的接口與應(yīng)用的平臺(tái)類型不一致,如有疑問請(qǐng)參考入門指南 | 
| 206 | 因?yàn)闀r(shí)間戳無(wú)效導(dǎo)致簽名校驗(yàn)失敗 | 
| 207 | 重放請(qǐng)求 | 
| 301 | 辭典查詢失敗 | 
| 302 | 翻譯查詢失敗 | 
| 303 | 服務(wù)端的其它異常 | 
| 304 | 會(huì)話閑置太久超時(shí) | 
| 401 | 賬戶已經(jīng)欠費(fèi)停 | 
| 402 | offlinesdk不可用 | 
| 411 | 訪問頻率受限,請(qǐng)稍后訪問 | 
| 412 | 長(zhǎng)請(qǐng)求過于頻繁,請(qǐng)稍后訪問 | 
| 1001 | 無(wú)效的OCR類型 | 
| 1002 | 不支持的OCR image類型 | 
| 1003 | 不支持的OCR Language類型 | 
| 1004 | 識(shí)別圖片過大 | 
| 1201 | 圖片base64解密失敗 | 
| 1301 | OCR段落識(shí)別失敗 | 
| 1411 | 訪問頻率受限 | 
| 1412 | 超過最大識(shí)別字節(jié)數(shù) | 
| 2003 | 不支持的語(yǔ)音聲道 | 
| 2004 | 不支持的語(yǔ)音上傳類型 | 
| 2005 | 不支持的語(yǔ)言類型 | 
| 2006 | 不支持的識(shí)別類型 | 
| 2201 | 識(shí)別音頻文件過大 | 
| 2301 | 識(shí)別音頻時(shí)長(zhǎng)過長(zhǎng) | 
| 2411 | 不支持的音頻文件類型 | 
| 2412 | 不支持的發(fā)音類型 | 
| 3001 | 不支持的語(yǔ)音格式 | 
| 3002 | 不支持的語(yǔ)音采樣率 | 
| 3003 | 不支持的語(yǔ)音聲道 | 
| 3004 | 不支持的語(yǔ)音上傳類型 | 
| 3005 | 不支持的語(yǔ)言類型 | 
| 3006 | 不支持的識(shí)別類型 | 
| 3007 | 識(shí)別音頻文件過大 | 
| 3008 | 識(shí)別音頻時(shí)長(zhǎng)過長(zhǎng) | 
| 3009 | 不支持的音頻文件類型 | 
| 3010 | 不支持的發(fā)音類型 | 
| 3201 | 解密失敗 | 
| 3301 | 語(yǔ)音識(shí)別失敗 | 
| 3302 | 語(yǔ)音翻譯失敗 | 
| 3303 | 服務(wù)的異常 | 
| 3411 | 訪問頻率受限,請(qǐng)稍后訪問 | 
| 3412 | 超過最大請(qǐng)求字符數(shù) | 
| 4001 | 不支持的語(yǔ)音識(shí)別格式 | 
| 4002 | 不支持的語(yǔ)音識(shí)別采樣率 | 
| 4003 | 不支持的語(yǔ)音識(shí)別聲道 | 
| 4004 | 不支持的語(yǔ)音上傳類型 | 
| 4005 | 不支持的語(yǔ)言類型 | 
| 4006 | 識(shí)別音頻文件過大 | 
| 4007 | 識(shí)別音頻時(shí)長(zhǎng)過長(zhǎng) | 
| 4201 | 解密失敗 | 
| 4301 | 語(yǔ)音識(shí)別失敗 | 
| 4303 | 服務(wù)的異常 | 
| 4411 | 訪問頻率受限,請(qǐng)稍后訪問 | 
| 4412 | 超過最大請(qǐng)求時(shí)長(zhǎng) | 
| 5001 | 無(wú)效的OCR類型 | 
| 5002 | 不支持的OCR image類型 | 
| 5003 | 不支持的語(yǔ)言類型 | 
| 5004 | 識(shí)別圖片過大 | 
| 5005 | 不支持的圖片類型 | 
| 5006 | 文件為空 | 
| 5201 | 解密錯(cuò)誤,圖片base64解密失敗 | 
| 5301 | OCR段落識(shí)別失敗 | 
| 5411 | 訪問頻率受限 | 
| 5412 | 超過最大識(shí)別流量 | 
| 9001 | 不支持的語(yǔ)音格式 | 
| 9002 | 不支持的語(yǔ)音采樣率 | 
| 9003 | 不支持的語(yǔ)音聲道 | 
| 9004 | 不支持的語(yǔ)音上傳類型 | 
| 9005 | 不支持的語(yǔ)音識(shí)別 Language類型 | 
| 9301 | ASR識(shí)別失敗 | 
| 9303 | 服務(wù)器內(nèi)部錯(cuò)誤 | 
| 9411 | 訪問頻率受限(超過最大調(diào)用次數(shù)) | 
| 9412 | 超過最大處理語(yǔ)音長(zhǎng)度 | 
| 10001 | 無(wú)效的OCR類型 | 
| 10002 | 不支持的OCR image類型 | 
| 10004 | 識(shí)別圖片過大 | 
| 10201 | 圖片base64解密失敗 | 
| 10301 | OCR段落識(shí)別失敗 | 
| 10411 | 訪問頻率受限 | 
| 10412 | 超過最大識(shí)別流量 | 
| 11001 | 不支持的語(yǔ)音識(shí)別格式 | 
| 11002 | 不支持的語(yǔ)音識(shí)別采樣率 | 
| 11003 | 不支持的語(yǔ)音識(shí)別聲道 | 
| 11004 | 不支持的語(yǔ)音上傳類型 | 
| 11005 | 不支持的語(yǔ)言類型 | 
| 11006 | 識(shí)別音頻文件過大 | 
| 11007 | 識(shí)別音頻時(shí)長(zhǎng)過長(zhǎng),最大支持30s | 
| 11201 | 解密失敗 | 
| 11301 | 語(yǔ)音識(shí)別失敗 | 
| 11303 | 服務(wù)的異常 | 
| 11411 | 訪問頻率受限,請(qǐng)稍后訪問 | 
| 11412 | 超過最大請(qǐng)求時(shí)長(zhǎng) | 
| 12001 | 圖片尺寸過大 | 
| 12002 | 圖片base64解密失敗 | 
| 12003 | 引擎服務(wù)器返回錯(cuò)誤 | 
| 12004 | 圖片為空 | 
| 12005 | 不支持的識(shí)別圖片類型 | 
| 12006 | 圖片無(wú)匹配結(jié)果 | 
| 13001 | 不支持的角度類型 | 
| 13002 | 不支持的文件類型 | 
| 13003 | 表格識(shí)別圖片過大 | 
| 13004 | 文件為空 | 
| 13301 | 表格識(shí)別失敗 | 
| 15001 | 需要圖片 | 
| 15002 | 圖片過大(1M) | 
| 15003 | 服務(wù)調(diào)用失敗 | 
| 17001 | 需要圖片 | 
| 17002 | 圖片過大(1M) | 
| 17003 | 識(shí)別類型未找到 | 
| 17004 | 不支持的識(shí)別類型 | 
| 17005 | 服務(wù)調(diào)用失敗 | 
| -1000 | 未知錯(cuò)誤 | 
| -2000 | 查詢輸入為空 | 
常見問題及注意事項(xiàng)
1.運(yùn)行程序崩潰?
檢查下是否對(duì)應(yīng)的 so 是否放到當(dāng)前工程目錄下。
2.識(shí)別沒結(jié)果?
檢查下識(shí)別接口回調(diào)的錯(cuò)誤信息,保證申請(qǐng)的應(yīng)用ID是有效且提前綁定了。
3.如何獲得應(yīng)用ID
注冊(cè)賬號(hào), 登錄后臺(tái)創(chuàng)建應(yīng)用和實(shí)例并完成綁定, 可獲得應(yīng)用ID和應(yīng)用密鑰等信息。
4.出現(xiàn)錯(cuò)誤HTTP_REQUEST_ERROR("Http requesterror.",1)
在確保有網(wǎng)情況下,若調(diào)用過程中出現(xiàn)這個(gè)錯(cuò)誤,HTTP_REQUEST_ERROR("Http requesterror.",1) ,請(qǐng)檢查是否是在主線程中調(diào)用的翻譯識(shí)別方法,請(qǐng)確保在主線程調(diào)用。
版本更新記錄
| 上線日期 | 版本號(hào) | 更新內(nèi)容 | 
| 2019.04.01 | v1.0.0 | 有道智云表格識(shí)別OCR Android | 
| 2019.11.07 | v2.0.0 | 兼容同時(shí)使用多個(gè)sdk問題 |