SDK隐私政策
(1) 概念解释
表格识别:基于深度学习技术,自动定位并识别图片中表格的位置、结构及文字内容,结构化返回可编辑的表格结果。支持用户上传报表、带有表格的图片等。
(2) 说明
Hi,您好,欢迎使用有道智云表格识别OCR Android SDK。
如果您想快速体验服务,建议您前往有道智云平台 体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。
本文档主要针对需要集成表格识别服务OCR Android SDK的开发工程师,详细描述有道表格识别能力及集成过程。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云OCR技术交流QQ 1群: 654064748
智云OCR技术交流QQ 2群: 471638046
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建Android应用,并绑定实例;如果您还没有,请按照 新手指南 操作。
平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 表格OCR服务报价 。
表格识别OCR SDK是有道在线表格识别OCR 接口服务进行封装,支持在线表格识别。提供快速的接入方式;同时提供数据统计能力,方便了解用户使用情况。
支持设备:运行了 Android 4.0.3以及以上系统的 Android 设备
开始集成SDK之前开发者需要登录 有道智云平台 ,创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用表格识别OCR服务。
(1) SDK包导入
请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建),并将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状态 -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<!-- 获取网络信息状态,如当前的网络连接是否有效 -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!-- 往SDCard读写数据权限 storage group -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
(3) 代码混淆配置
代码混淆文件proguard-project.txt,添加如下内容:
-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初始化
使用之前请在程序的Application中调用SDK初始化代码,可以参考demo中DemoApplication。 注:appkey即应用ID。
//appkey即应用ID。
YouDaoApplication.init(this, appkey);
说明:请参考 yd_table_recognize_demo 中 TableDemoActivity 的使用
(1) 参数说明
type:上传类型, 仅支持base64上传(1)和文件上传(2),请按需填写
docType:服务器响应类型,可选字段,默认为json。目前只支持json和excel
angle:是否检测图片角度,可选字段,默认检测。0表示不检测;1表示检测
输入图片格式支持:jpg/png
输入图片尺寸限制:2MB以下
输入图片数据:需要转换为Base64编码。
(2) 构造表格OCR识别参数对象
//表格OCR识别
TableRecognizeParameters tps = new TableRecognizeParameters.Builder()
.type(TableRecognizeParameters.TYPE_BASE64)
.build())
(3) 设置回调和开始识别
通过TableRecognize,设置上一步构造的参数对象,调用recognize方法传入图片base64编码的数据和回调接口开始查询
识别回调接口包含两个方法:onResult表示识别成功,结果json字符串形式给用户,onError表示失败,失败信息已错误码的形式给用户。
注意:整个识别是异步的,回调在子线程进行,若涉及到界面操作,请切回主线程。
//OCR表格识别
TableRecognize.getInstance(tps)
.recognize(base64, new TableRecognizeListener() {
@Override
public void onError(final int errorCode) {
handler.post(new Runnable() {
@Override
public void run() {
resultText.setText("识别失败 " + 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("识别完成");
YouDaoLog.w("TableRecognize onResult,result = " + resultJson + "\n" + ",input = " + input);
showResult(resultJson);
}
});
}
});
| 字段 | 含义 |
|---|---|
| -orientation | 图片方向 |
| -tables | 返回的表格,如果一张图像中有多个表格,返回多个 |
| --cells | 表格中的单元格 |
| --rowRange | 单元格行号的范围,如果当前行存在单元格合并情况,两个值不同 |
| --colRange | 单元格列号的范围,如果当前列存在单元格合并情况,两个值不同 |
| --boundingBox | 单元格文字的坐标 |
| --dir | 单元格方向:h水平 v竖直 |
| --lang | 文字种类 zh为中文 |
| --lines | 单元格中的每一行 |
| ---boundingBox | 行的坐标 |
| ---text | 识别的行文字 |
| ---words | 字级别组 |
| ----word | 识别的文字 |
| ----boundingBox | 字的坐标 |
查询结果以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": []
}
| 错误码 | 含义 |
|---|---|
| 101 | 缺少必填的参数 |
| 102 | 不支持的语言类型 |
| 103 | 翻译文本过长 |
| 104 | 不支持的API类型 |
| 105 | 不支持的签名类型 |
| 106 | 不支持的响应类型 |
| 107 | 不支持的传输加密类型 |
| 108 | 应用ID无效,注册账号,登录后台创建应用和实例并完成绑定,可获得应用ID和应用密钥等信息 |
| 109 | batchLog格式不正确 |
| 110 | 无相关服务的有效实例 |
| 111 | 开发者账号无效 |
| 113 | q不能为空 |
| 114 | 不支持的图片传输方式 |
| 201 | 解密失败,可能为DES,BASE64,URLDecode的错误 |
| 202 | 签名检验失败 |
| 203 | 访问IP地址不在可访问IP列表 |
| 205 | 请求的接口与应用的平台类型不一致,如有疑问请参考入门指南 |
| 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 | 不支持的语音声道 |
| 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 | 服务调用失败 |
| -1000 | 未知错误 |
| -2000 | 查询输入为空 |
1.运行程序崩溃?
检查下是否对应的 so 是否放到当前工程目录下。
2.识别没结果? 检查下识别接口回调的错误信息,保证申请的应用ID是有效且提前绑定了。
3.如何获得应用ID 注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和应用密钥等信息。
4.出现错误HTTP_REQUEST_ERROR("Http requesterror.",1)
在确保有网情况下,若调用过程中出现这个错误,HTTP_REQUEST_ERROR("Http requesterror.",1) ,请检查是否是在主线程中调用的翻译识别方法,请确保在主线程调用。
| 上线日期 | 版本号 | 更新内容 |
|---|---|---|
| 2019.04.01 | v1.0.0 | 有道智云表格识别OCR Android |
| 2019.11.07 | v2.0.0 | 兼容同时使用多个sdk问题 |