通用文字識(shí)別 Android SDK 簡(jiǎn)介

(1) 概念解釋

通用文字識(shí)別：將自然場(chǎng)景下圖片上的文字內(nèi)容，通過(guò)定位和檢測(cè)，智能識(shí)別為可編輯的文本信息

(2) 說(shuō)明

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

本文檔主要針對(duì)需要集成通用文字識(shí)別 Android SDK 的開(kāi)發(fā)工程師，詳細(xì)描述有道智云OCR能力及集成過(guò)程。

如果您想快速體驗(yàn)服務(wù)，建議您前往 體驗(yàn)中心 或者在體驗(yàn)中心右下側(cè)找到小程序二維碼，掃描進(jìn)行體驗(yàn)。

如果您有與我們商務(wù)合作的需求，可以通過(guò)以下方式聯(lián)系我們：

商務(wù)郵箱： AIcloud_Business@corp.youdao.com

如果您對(duì)文檔內(nèi)容有任何疑問(wèn)，可以通過(guò)以下幾種方式聯(lián)系我們：

客服QQ：1906538062

智云OCR技術(shù)交流QQ 1群: 654064748

智云OCR技術(shù)交流QQ 2群: 471638046

智云語(yǔ)音技術(shù)交流QQ群：861723255

聯(lián)系郵箱： zhiyun@corp.youdao.com

溫馨提示：
本文檔主要針對(duì)開(kāi)發(fā)人員，接入測(cè)試前需要在后臺(tái)創(chuàng)建API應(yīng)用，并綁定實(shí)例；如果您還沒(méi)有，請(qǐng)按照 新手指南 操作。
平臺(tái)向每個(gè)賬戶贈(zèng)送50元的體驗(yàn)金，供用戶集成前測(cè)試所用，具體資費(fèi)規(guī)則詳見(jiàn) 通用文字識(shí)別服務(wù)報(bào)價(jià) 。

功能介紹

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

兼容性

支持設(shè)備：運(yùn)行了 Android 4.0.3以及以上系統(tǒng)的 Android 設(shè)備

通用文字識(shí)別 Android SDK集成指南

集成前提

開(kāi)始集成SDK之前開(kāi)發(fā)者需要登錄 有道智云平臺(tái)，創(chuàng)建應(yīng)用獲取應(yīng)用ID（或者通過(guò)運(yùn)營(yíng)人員獲取應(yīng)用ID），以便使用通用文字識(shí)別服務(wù)。

集成步驟

(1) SDK包導(dǎo)入

請(qǐng)?jiān)诠こ涛募夸浵聞?chuàng)建一個(gè)名為 libs 的子目錄(有的話則不需要?jiǎng)?chuàng)建)，并將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狀態(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" />

<!-- 讀取手機(jī)狀態(tài) phone group -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />

<!-- 往SDCard讀寫(xiě)數(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/YoudaoOCROnline_v2.0.0.jar
-keep class com.youdao.sdk.ydtranslate.** { ;} -keep class com.youdao.ocr.online.* { *;}

(4) SDK初始化

使用圖片翻譯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)參考 demo 中 OcrDemoActivity 的使用

(1) 參數(shù)說(shuō)明

type：識(shí)別類(lèi)型，目前僅支持10012，表示按行識(shí)別

lanType：支持"zh-en"和"en"，其中"zh-en"為中英識(shí)別，"en"參數(shù)表示只識(shí)別英文。若為純英文識(shí)別，"zh-en"的識(shí)別效果不如"en"，請(qǐng)妥善選擇

source：設(shè)置為app對(duì)應(yīng)的名稱(chēng)（英文字符串）

timeout：表示超時(shí)時(shí)間

注意：輸入圖片數(shù)據(jù)需要轉(zhuǎn)換為Base64編碼。

(2) 構(gòu)造OCR識(shí)別參數(shù)對(duì)象

//OCR識(shí)別
OCRParameters tps = new OCRParameters.Builder()
                              .source("youdaoocr")
                              .timeout(100000)
                              .langType("zh-en")
                              .build();

(3) 設(shè)置回調(diào)和開(kāi)始識(shí)別

通過(guò)ImageOCRecognizer，設(shè)置上一步構(gòu)造的參數(shù)對(duì)象，調(diào)用recognize方法傳入圖片base64編碼的數(shù)據(jù)和回調(diào)接口開(kāi)始查詢

識(shí)別回調(diào)接口包含兩個(gè)方法：onResult表示識(shí)別成功，相關(guān)結(jié)果存儲(chǔ)在result參數(shù)中，onError表示失敗，失敗信息放在OcrErrorCode中。可參見(jiàn) 錯(cuò)誤代碼列表 。

注意：整個(gè)識(shí)別是異步的，回調(diào)在子線程進(jìn)行，若涉及到界面操作，請(qǐng)切回主線程。

//OCR識(shí)別
ImageOCRecognizer.getInstance(tps).recognize(base64,
                              new OCRListener() {

                                  @Override
                                  public void onResult(OCRResult result,
                                          String input) {
                                      //識(shí)別成功
                                  }

                                  @Override
                                  public void onError(OcrErrorCode error) {
                                      //識(shí)別失敗
                                  }
                              });

通用文字識(shí)別結(jié)果說(shuō)明

對(duì)于中英在線 OCR，查詢結(jié)果比較詳細(xì)，服務(wù)器返回?cái)?shù)據(jù)如下所示：

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

服務(wù)器是按照區(qū)域，行，字的格式返回的，即，一張圖片，會(huì)識(shí)別出圖片對(duì)應(yīng)的 OCRResult，其上可能有多個(gè)有效區(qū)域 Region ，每個(gè)區(qū)域會(huì)包含一行或幾行 Line ，每個(gè)行又包含一個(gè)或多個(gè)字 Word ，每個(gè)區(qū)域和行或者字符，都通過(guò) boundingBox 字段返回坐標(biāo)和大小 Rect。

sdk將上述 json 值封裝成 OCRResutlt 對(duì)象，其數(shù)據(jù)結(jié)構(gòu)如下：

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

支持語(yǔ)言

auto支持所有語(yǔ)種的自動(dòng)識(shí)別

錯(cuò)誤代碼列表

常見(jiàn)問(wèn)題及注意事項(xiàng)

1.運(yùn)行程序崩潰？
檢查下是否對(duì)應(yīng)的 so 是否放到當(dāng)前工程目錄下。

2.識(shí)別沒(méi)結(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)用過(guò)程中出現(xiàn)這個(gè)錯(cuò)誤，HTTP_REQUEST_ERROR("Http requesterror.",1) ,請(qǐng)檢查是否是在主線程中調(diào)用的翻譯識(shí)別方法，請(qǐng)確保在主線程調(diào)用。

版本更新記錄