有道智云 OCR Android SDK 文档

有道智云 OCR SDK 简介

有道 OCR SDK 是有道智云开放平台提供的云服务之一，是有道在线 OCR 接口的一种实现，支持在线文本识别。

通过SDK接入优势：

1. 接入简单，不用实现整个OCR协议
2. 方便进行数据统计，了解用户OCR使用情况

集成前提

开始集成SDK之前开发者需要登录有道开放平台（http://ai.youdao.com），创建应用获取应用ID（或者通过运营人员获取应用ID），以便使用翻译服务。

OCR SDK 如下几个 SDK 组成，用户可根据需要组合使用：

1. YoudaoBase.jar：OCR相关sdk基础库、跟翻译基础库相同（必选）
2. YoudaoOCROnline.jar：在线OCRsdk（可选，使用在线OCR时使用）
3. yd-ocr-demo：sdk使用demo

SDK 集成步骤

1. 添加相应jar包

在工程目录下，创建一个名为libs的子目录，将相应包拷贝到此目录下。

对于Android Studio 工程，请参照下面的步骤添加JAR 包：

1. 右击你的工程并选择“Open Module Settings”
2. 在左侧面板中选择你的app
3. 在主窗口中选择“Dependencies”页签
4. 点击“+”按钮
5. 选择“File Depndency”
6. 选择您拷贝到 libs 目录下的 jar
7. 添加so文件：在模块的配置文件中增加jni配置 sourceSets.main.jniLibs.srcDirs = ['libs']
8. 添加代码混淆文件，避免jar的二次混淆
9. 代码混淆文件proguard-project.txt，添加如下内容：

-ignorewarnings
-libraryjars libs/ YoudaoBase.jar
-libraryjars libs/ YoudaoOCROnline.jar
-keep class com.youdao.sdk.ydtranslate.** { ;} -keep class com.youdao.ocr.online.* { *;}

2. 权限添加

<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. 功能集成说明

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

1. 使用的jar: YoudaoBase.jar 和 YoudaoOCROnline.jar
2. 代码添加：

//注册应用ID ，建议在应用启动时，初始化，所有功能的使用都需要该初始化，调用一次即可，demo中在MainActivity类中
YouDaoApplication.init(this, appkey);


//OCR识别
OCRParameters tps = new OCRParameters.Builder()
                              .source("youdaoocr").timeout(100000)
                              .type("10011").langType("zh-en ").build();
// type识别类型，目前仅支持10011，表示片段识别
// lanType支持"zh-en"和"en"，其中"zh-en"为中英识别，"en"参数表示只识别英文。
// 若为纯英文识别，"zh-en"的识别效果不如"en"，请妥善选择

ImageOCRecognizer.getInstance(tps).recognize(base64,
                              new OCRListener() {

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

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

识别结果说明

对于中英在线 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;
}

支持语言

中英识别， 英文识别

常见问题及注意事项

1. 参数错误 108
   appKey无效，注册账号， 登录后台创建应用和实例并完成绑定， 可获得应用ID和密钥等信息，其中应用ID就是appKey（ 注意不是应用密钥）
2. 在确保有网情况下，若调用过程中出现这个错误，HTTP_REQUEST_ERROR("Http requesterror.",1) ,请检查是否是在主线程中调用 ocr 识别方法，请确保在主线程调用。

错误代码列表

版本更新记录