通用文字識別 Android SDK 簡介

(1) 概念解釋

通用文字識別：將自然場景下圖片上的文字內容，通過定位和檢測，智能識別為可編輯的文本信息

(2) 說明

Hi，您好，歡迎使用有道智云通用文字識別 Android SDK。

本文檔主要針對需要集成通用文字識別 Android SDK 的開發工程師，詳細描述有道智云OCR能力及集成過程。

如果您想快速體驗服務，建議您前往 體驗中心 或者在體驗中心右下側找到小程序二維碼，掃描進行體驗。

如果您有與我們商務合作的需求，可以通過以下方式聯系我們：

商務郵箱： AIcloud_Business@corp.youdao.com

如果您對文檔內容有任何疑問，可以通過以下幾種方式聯系我們：

客服QQ：1906538062

智云OCR技術交流QQ 1群: 654064748

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

智云語音技術交流QQ群：861723255

聯系郵箱： zhiyun@corp.youdao.com

溫馨提示： 本文檔主要針對開發人員，接入測試前需要在后臺創建API應用，并綁定實例；如果您還沒有，請按照 新手指南 操作。 平臺向每個賬戶贈送50元的體驗金，供用戶集成前測試所用，具體資費規則詳見 通用文字識別服務報價 。

功能介紹

通用文字識別服務 SDK是有道在線 OCR 接口服務進行封裝，支持在線文本識別。提供快速的接入方式；同時提供數據統計能力，方便了解用戶使用情況。

兼容性

支持設備：運行了 Android 4.0.3以及以上系統的 Android 設備

通用文字識別 Android SDK集成指南

集成前提

開始集成SDK之前開發者需要登錄 有道智云平臺，創建應用獲取應用ID（或者通過運營人員獲取應用ID），以便使用通用文字識別服務。

集成步驟

(1) SDK包導入

請在工程文件根目錄下創建一個名為 libs 的子目錄(有的話則不需要創建)，并將YoudaoBase.jar，so包和YoudaoTranslateOnline.jar拷貝到 libs 目錄下，并將以下代碼添加到app的build.gradle中：

android {
    sourceSets.main.jniLibs.srcDirs = ['libs']
    ...
}
    
dependencies {
    compile files('libs/YoudaoBase_v2.0.0.jar')
    compile files('libs/YoudaoOCROnline_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" />

<!-- 讀取手機狀態 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_v2.0.0.jar
-libraryjars libs/YoudaoOCROnline_v2.0.0.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，查詢結果比較詳細，服務器返回數據如下所示：

{
   "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;
}

支持語言

auto支持所有語種的自動識別

錯誤代碼列表

常見問題及注意事項

1.運行程序崩潰？ 檢查下是否對應的 so 是否放到當前工程目錄下。

2.識別沒結果？ 檢查下識別接口回調的錯誤信息，保證申請的應用ID是有效且提前綁定了。

3.如何獲得應用ID 注冊賬號， 登錄后臺創建應用和實例并完成綁定， 可獲得應用ID和應用密鑰等信息。

4.出現錯誤HTTP_REQUEST_ERROR("Http requesterror.",1) 在確保有網情況下，若調用過程中出現這個錯誤，HTTP_REQUEST_ERROR("Http requesterror.",1) ,請檢查是否是在主線程中調用的翻譯識別方法，請確保在主線程調用。

版本更新記錄