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

通用OCR SDK简介

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

通过SDK接入优势:

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

OCR识别SDK集成指南

集成前提

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

OCR SDK 由如下几个 SDK 组成,用户可根据需要组合使用:

1.OCRSDK.h:头文件(必选)
2.libbase.a:OCR相关sdk基础库(必选)
3.libocronline.a:在线OCR SDK(必选,使用在线OCR时使用)

集成步骤

1.头文件及SDK库引入(所有功能都需要这一步)

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

(2). 设置工程Other Linker Flags为-ObjC
(3). 修改工程中任意一个类后缀名为.mm,参见demo中ViewController.mm
(4). 在工程build Phases – Link Binary With Libraries中添加libbase.a, AdSupport.framework, libstc++.6.0.9.tbd, CoreTelephony.framework, SystemConfiguration, libz.tbd和libsqlite3.tbd。如下:

Alt

2.功能集成说明

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

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

2.2 在线 OCR 识别功能

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

1.使用的库文件:头文件、libbase.a、libocronline.a;

2.构造查询器

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 = @"10011"; //设置识别类型,10011位片段识别,目前只支持片段识别
request.param = param;

3.将图片转化为base64编码

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

4.执行识别过程

识别返回两种情况,一种是成功,相关结果存储在 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

支持语言

按字识别支持识别语言类型:

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

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

常见问题及注意事项

  1. 参数错误 108

appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)

错误代码列表

错误码含义
101缺少必填的参数,出现这个情况还可能是et的值和实际加密方式不对应
102不支持的语言类型
103翻译文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)
109batchLog格式不正确
110无相关服务的有效实例
111开发者账号异常
201解密失败,可能为DES,BASE64,URLDecode的错误
202签名检验失败
203访问IP地址不在可访问IP列表
301辞典查询失败
302小语种查询失败
303服务端的其它异常
401账户已经欠费停
1001无效的OCR类型
1002不支持的OCR image类型
1003不支持的OCR Language类型
1004识别图片过大
1201图片base64解密失败
1301OCR段落识别失败
1411访问频率受限
1412超过最大识别字节数
-1000未知错误
-2000查询输入为空

版本更新记录

上线日期版本号更新内容
2017.07.11v1.2.0有道智云 OCR iOS SDK上线,支持中英文在线文字识别
2017.07.24v1.3.0修复已知 bug
2017.08.16v1.4.0修复已知 bug
2018.11.07v1.5.0增加按行识别10012