通用文字识别 SDK简介

概述

(1) 概念解释

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

(2) 说明

Hi，您好，欢迎使用有道智云OCR iOS SDK。

如果您想快速体验服务，建议您前往 体验中心 或者搜索小程序（有道智云体验中心）进行试用。

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

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

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

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

客服QQ：1906538062

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

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

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

温馨提示：

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

功能介绍

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

兼容性

支持设备：运行了iOS 8.0及以上系统的 iOS 设备

通用文字识别 SDK集成指南

集成前提

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

集成步骤

SDK包导入

OCR SDK 由如下几个 SDK 组成，OCRSDK.h、libbase.a、libocronline.a

(1). 添加头文件和库文件：将 OCR SDK 添加到工程中，包括 OCRSDK.h头文件、libbase.a和libocronline.a文件。可以直接将translateSDK文件夹拖动到工程中，也可以选择File “Add files to ‘Project Name’…”

(2). 设置工程Other Linker Flags为-ObjC

(3). 在工程build Phases – Link Binary With Libraries中添加libbase.a, AdSupport.framework, CoreTelephony.framework, SystemConfiguration, libz.tbd和libsqlite3.tbd。

SDK初始化

说明：所有的查询都需要初始化key，只执行初始化一次即可。

//初始化key
YDTranslateInstance *yd = [YDTranslateInstance sharedInstance];
yd.appKey = @"your appkey";

功能集成

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

构造查询器

YDOCRRequest *request = [YDOCRRequest request];
YDOCRParameter *param = [YDOCRParameter param];
param.langType = @"en"; //设置识别语言为英文,langType支持"zh-en"和"en"，其中"zh-en"为中英识别，"en"参数表示只识别英文。若为 纯英文识别，"zh-en"的识别效果不如"en"，请妥善选择
param.source = @"youdaoocr"; //设置源
param.detectType = @"10012"; //设置识别类型，按行识别：10012
request.param = param;

将图片转化为base64编码

NSString *base64Str = [self image2DataURL:self.imgView.image];

执行识别过程

识别返回两种情况，一种是成功，相关结果存储在 result 参数中，另外一种是失败，失败信息放在 error，是一个枚举类，整个识别是异步的。

[request lookup:base64Str WithCompletionHandler:^(YDOCRRequest *request, YDOCRResult *result, NSError *error) {
    if (error) {
        //失败
        NSLog(@"error:%@", error);
    }else {
        //成功
        [self handleOCRReuslt:result];
    }
}];

识别结果说明

对于在线OCR，服务器查询结果返回数据如下：

{
       "errorCode": "0",
       "Result": {
               "orientation": "Up",
               "regions": [{
                       "boundingBox": "81,325,552,64",
                       "lines": [{
                               "boundingBox": "81,325,552,64",
                               "text":"NetEase YouDao"
                               "words": [{
                                       "boundingBox": "81,329,259,59",
                                       "word": "NetEase"
                               }, {
                                       "boundingBox": "364,325,270,62",
                                       "word": "YouDao"
                               }]
                       }]
               }],
               "textAngle": 1.07417,
               "language": "en"
       }
}

服务器是按照区域，行，字的格式返回的，即一张图片会识别出图片对应的 Result，其上可能有多个区域 Region，每个区域会包含一行或多行 Line，每行又包括一个或多个字 Word，每个区域、行或者字符，都会通过 boundingBox 字段返回坐标和大小。 SDK 对上述 json 数据解析封装为 YDOCRResult 对象，如下：

@interface YDOCRResult : NSObject
@property (nonatomic, copy) NSString *orientation;
@property (nonatomic, copy) NSString *textAngle;
@property (nonatomic, copy) NSString *language;
@property (nonatomic, strong) NSArray *regions; //YDOCRRegion数组
+ (instancetype)initWithDict:(NSDictionary *)info;
@end


@interface YDOCRRegion : NSObject
@property (nonatomic, copy) NSString *boundingBox;
@property (nonatomic, strong) NSArray *lines;//YDOCRLine数组
+ (instancetype)initWithDict:(NSDictionary *)info;
@end

@interface YDOCRLine : NSObject
@property (nonatomic, copy) NSString *boundingBox;
@property (nonatomic, copy) NSString *text;
@property (nonatomic, strong) NSArray *words;//YDOCRWord数组
+ (instancetype)initWithDict:(NSDictionary *)info;
@end

@interface YDOCRWord : NSObject
@property (nonatomic, copy) NSString *boundingBox;
@property (nonatomic, copy) NSString *word;
+ (instancetype)initWithDict:(NSDictionary *)info;
@end

支持语言

auto支持所有语种的自动识别

错误代码列表

常见问题及注意事项

1.运行程序崩溃？
检查下是否对应的 SDK静态库包 是否放到当前工程目录下。

2.OCR识别没结果？
检查下OCR识别接口回调的错误信息，保证申请的应用ID是有效且提前绑定了。

3.如何获得应用ID
注册账号，登录后台创建应用和实例并完成绑定， 可获得应用ID和应用密钥等信息。

版本更新记录