帮助与文档 > 产品文档 > 文字识别OCR > Android_SDK文档 > 通用OCR服务
通用OCR服务

通用OCR Android SDK 简介

(1) 概念解释

文字识别OCR:将自然场景下图片上的文字内容,通过定位和检测,智能识别为可编辑的文本信息

(2) 说明

Hi,您好,欢迎使用有道智云文字识别OCR Android SDK。

本文档主要针对需要集成文字识别OCR Android SDK 的开发工程师,详细描述有道智云OCR能力及集成过程。

如果您想快速体验服务,建议您前往 文字识别体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。

如果您有与我们商务合作的需求,可以通过以下方式联系我们:

商务邮箱: AIcloud_Business@corp.youdao.com

如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:

客服QQ:1906538062

智云翻译技术交流QQ 1群: 652880659(已满)

智云翻译技术交流QQ 2群: 669384425

智云OCR技术交流QQ 1群: 654064748(已满)

智云OCR技术交流QQ 2群: 471638046

智云语音技术交流QQ群:861723255

联系邮箱: zhiyun@corp.youdao.com

温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建API应用,并绑定实例;如果您还没有,请按照 新手指南 操作。
平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 通用OCR服务报价

功能介绍

文字识别OCR SDK是有道在线 OCR 接口服务进行封装,支持在线文本识别。提供快速的接入方式;同时提供数据统计能力,方便了解用户使用情况。

兼容性

支持设备:运行了 Android 4.0.3以及以上系统的 Android 设备

文字识别OCR Android SDK集成指南

集成前提

开始集成SDK之前开发者需要登录 有道智云平台,创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用文字识别OCR服务。

集成步骤

(1) SDK包导入

请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建),并将YoudaoBase.jar和YoudaoTranslateOnline.jar拷贝到 libs 目录下,并将以下代码添加到app的build.gradle中:

dependencies {
    compile files('libs/YoudaoBase.jar')
    compile files('YoudaoOCROnline.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" />

<!-- 读取手机状态 phone group -->
<uses-permission android:name="android.permission.READ_PHONE_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.jar
-libraryjars libs/ YoudaoOCROnline.jar
-keep class com.youdao.sdk.ydtranslate.** { ;} -keep class com.youdao.ocr.online.* { *;}

(4) SDK初始化

使用图片翻译SDK,请在程序的Application中调用SDK初始化代码,可以参考demo中DemoApplication。
注:appkey即应用ID。

//appkey即应用ID
YouDaoApplication.init(this, appkey);

功能集成

说明:请参考 demo 中 OcrDemoActivity 的使用

(1) 参数说明

type:识别类型,目前仅支持10012,表示按行识别

lanType:支持"zh-en"和"en",其中"zh-en"为中英识别,"en"参数表示只识别英文。若为纯英文识别,"zh-en"的识别效果不如"en",请妥善选择

source:设置为app对应的名称(英文字符串)

timeout:表示超时时间

注意:输入图片数据需要转换为Base64编码。

(2) 构造OCR识别参数对象

//OCR识别
OCRParameters tps = new OCRParameters.Builder()
                              .source("youdaoocr")
                              .timeout(100000)
                              .langType("zh-en")
                              .build();

(3) 设置回调和开始识别

通过ImageOCRecognizer,设置上一步构造的参数对象,调用recognize方法传入图片base64编码的数据和回调接口开始查询

识别回调接口包含两个方法:onResult表示识别成功,相关结果存储在result参数中,onError表示失败,失败信息放在OcrErrorCode中。可参见 错误代码列表

注意:整个识别是异步的,回调在子线程进行,若涉及到界面操作,请切回主线程。

//OCR识别
ImageOCRecognizer.getInstance(tps).recognize(base64,
                              new OCRListener() {

                                  @Override
                                  public void onResult(OCRResult result,
                                          String input) {
                                      //识别成功
                                  }

                                  @Override
                                  public void onError(OcrErrorCode error) {
                                      //识别失败
                                  }
                              });

文字识别OCR结果说明

对于中英在线 OCR,查询结果比较详细,服务器返回数据如下所示:

{
   "errorCode": "0",
   "Result": {
       "orientation": "Up",//方向
       "regions": [
           {
               "boundingBox": "28,257,4086,150",
               "lines": [
                   {
                       "boundingBox": "31,257,4083,73",
                       "words": [
                           {
                               "boundingBox": "354,257,347,50",
                               "text": "translation"
                           }
                       ]
                   },
       ],
       "textAngle": 0,//偏移量
       "language": "en"
   }

服务器是按照区域,行,字的格式返回的,即,一张图片,会识别出图片对应的 OCRResult,其上可能有多个有效区域 Region ,每个区域会包含一行或几行 Line ,每个行又包含一个或多个字 Word ,每个区域和行或者字符,都通过 boundingBox 字段返回坐标和大小 Rect

sdk将上述 json 值封装成 OCRResutlt 对象,其数据结构如下:

public class OCRResult {

   private String json;

   private int errorCode;

   private String language;

   private int textAngle;

   private String orientation;

   private List<Region> regions;
}

public class Region {

   private Rect boundingBox;

   private List<Line> lines = new ArrayList<Line>();
}

public class Rect {

   private int left;

   private int top;

   private int width;

   private int height;
}

public class Line {

   private Rect boundingBox;

   private List<Word> words = new ArrayList<Word>();
}

public class Word {

   private String text;

   private Rect boundingBox;
}

支持语言

语言语言代码
简体中文zh-CHS
繁体中文zh-CHT
英文en
日文ja
韩文ko
法文fr
西班牙文es
葡萄牙文pt
俄文ru
德文de
意大利文it
印度尼西亚文id
越南文vi
罗马尼亚文ro
波兰文pl
荷兰文nl
挪威文no
丹麦文da
印地文hi
拉丁文la
土耳其文tr
孟加拉文bn
蒙古文mn
尼泊尔文ne
马来文ms
阿拉伯文ar
自动识别auto

错误代码列表

错误码含义
101缺少必填的参数
102不支持的语言类型
103翻译文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108应用ID无效,注册账号,登录后台创建应用和实例并完成绑定,可获得应用ID和应用密钥等信息
109batchLog格式不正确
110无相关服务的有效实例
111开发者账号无效
113q不能为空
114不支持的图片传输方式
201解密失败,可能为DES,BASE64,URLDecode的错误
202签名检验失败
203访问IP地址不在可访问IP列表
205请求的接口与应用的平台类型不一致,如有疑问请参考入门指南
206因为时间戳无效导致签名校验失败
207重放请求
301辞典查询失败
302翻译查询失败
303服务端的其它异常
304会话闲置太久超时
401账户已经欠费停
402offlinesdk不可用
411访问频率受限,请稍后访问
412长请求过于频繁,请稍后访问
1001无效的OCR类型
1002不支持的OCR image类型
1003不支持的OCR Language类型
1004识别图片过大
1201图片base64解密失败
1301OCR段落识别失败
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解密失败
5301OCR段落识别失败
5411访问频率受限
5412超过最大识别流量
9001不支持的语音格式
9002不支持的语音采样率
9003不支持的语音声道
9004不支持的语音上传类型
9005不支持的语音识别 Language类型
9301ASR识别失败
9303服务器内部错误
9411访问频率受限(超过最大调用次数)
9412超过最大处理语音长度
10001无效的OCR类型
10002不支持的OCR image类型
10004识别图片过大
10201图片base64解密失败
10301OCR段落识别失败
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) ,请检查是否是在主线程中调用的翻译识别方法,请确保在主线程调用。

版本更新记录

上线日期版本号更新内容
2017.06.30v1.2.0有道智云 OCR Android SDK上线,支持中英文在线文字识别
2017.07.24v1.3.0修复已知 bug
2017.08.16v1.4.01. 修复已知 bug
2. 提供多版本的 so 文件
2017.11.16v1.5.0支持非主线程调用