帮助与文档 > 产品文档 > 文字识别OCR > iOS SDK 文档

有道智云 OCR iOS SDK 文档

有道智云 OCR SDK简介

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

通过SDK接入优势:

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

集成前提

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

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

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

SDK 集成步骤

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。如下:

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",
                               "words": [{
                                       "boundingBox": "81,329,259,59",
                                       "text": "NetEase"
                               }, {
                                       "boundingBox": "364,325,270,62",
                                       "text": "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, strong) NSArray *words;//YDOCRWord数组
+ (instancetype)initWithDict:(NSDictionary *)info;
@end

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

支持语种

语言语言代码
简体中文zh-CHS
繁体中文zh-CHT
英文en
日文ja
韩文ko
法文fr
西班牙文es
葡萄牙文pt
俄文ru
德文de
意大利文it
印度尼西亚文id
越南文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

有道智云 表格识别 SDK简介

概述

说明

Hi,您好,欢迎使用有道智云表格识别 iOS SDK。如果您想快速体验服务,建议您前往官网体验中心或者搜索小程序(有道智云体验中心)进行试用。

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

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

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

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

客服QQ:1906538062

智云OCR技术交流QQ 1群: 654064748(已满)

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

联系邮箱: zyservice@corp.youdao.com

温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建iOS应用,并绑定表格识别实例;如果您还没有,请按照新手指南操作。

平台向每个账户赠送100元的体验金,供用户集成前测试所用,具体资费规则详见表格识别服务报价

功能介绍

有道 表格识别 SDK 是基于深度学习技术,自动定位并识别图片中表格的位置、结构及文字内容,结构化返回可编辑的表格结果。支持用户上传报表、带有表格的图片等。

兼容性

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

集成前提

开始集成SDK之前开发者需要登录有道开放平台,创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用表格识别服务。

集成步骤

SDK包导入

表格识别 SDK 由如下几个 SDK 组成,YDOCRTable.h、libbase.a、libocrtable.a

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

(2). 设置工程Other Linker Flags为-ObjC。如图:

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

SDK初始化

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

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

功能集成

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

构造查询器

YDOCRTableRequest *request = [YDOCRTableRequest request];
YDOCRTableParam *param = [YDOCRTableParam param];
param.docType = @"json";
request.param = param;

将图片转化为base64编码

NSData *data = [self compressImage];
NSString *input = [data base64EncodedStringWithOptions:0];

执行识别过程

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

[request lookup:input completionHandler:^(YDOCRTableRequest *request, NSDictionary *result, NSError *error) {
        if (error) {
            //失败
            NSLog(@"%@", error.localizedDescription);
        } else {
            //成功
            [self handleResponse:result];
        }
}];

识别结果说明

输出字段介绍

响应结果是以json形式输出,包含字段如下表所示:

字段含义
Result识别结果,如果docType是excel则返回excel的base64字符串
errorCode识别结果错误码,一定存在
-tables返回的表格,如果一张图像中有多个表格,返回多个
-orientation图片方向
--rowRange单元格行号的范围,如果当前行存在单元格合并情况,两个值不同
--lines单元格中的每一行
--lang文字种类 zh为中文
--dir单元格方向:h水平 v竖直
--colRange单元格列号的范围,如果当前列存在单元格合并情况,两个值不同
--cells表格中的单元格
--boundingBox单元格文字的坐标
---words字级别组
---text识别的行文字
---boundingBox行的坐标
----word识别的文字
----boundingBox字的坐标

输出字段示例

  1. docType为json时的结果:
{
       "errorCode":"0",   #返回状态 如果成功, 返回0
       "Result":"   {        #如果没有错误,返回识别的内容
          "orientation":"UP",#图片方向
          "tables":[         #返回的表格,如果一张图像中有多个表格,返回多个
                {"cells":[      #表格中的单元格
                   {
                      "rowRange":"0,0", #单元格行号的范围,如果当前行存在单元格合并情况,两个值不同
                      "colRange":"0,0", #单元格列号的范围,如果当前列存在单元格合并情况,两个值不同
                      "boundingBox":"225,209,379,209,379,240,225,240", #单元格文字的bounding box
                      "dir":"h",   #方向 h水平 v竖直
                      "lang":"zh", #文字种类 zh为中文
                      "lines":[    #单元格中的每一行
                         {
                            "boundingBox":"225,212,379,209,379,237,225,240", #行的坐标
                            "text":"工程项目合同名称", #行文字
                            "words":[               #每个文字
                               {
                                  "word":"工",
                                  "boundingBox":"231,212,238,212,238,240,231,240" #每个字的包围框
                               },
                               {
                                  "word":"程",
                                  "boundingBox":"245,212,258,211,258,239,245,240"
                               },
                               ......
                            ]
                         }
                      ]
                   },
                   {
                      "rowRange":"0,0",#单元格行号的范围,如果当前行存在单元格合并情况,两个值不同
                      "colRange":"1,1",#单元格列号的范围,如果当前列存在单元格合并情况,两个值不同
                      "boundingBox":"441,206,536,206,536,234,441,234",
                      "dir":"h",
                      "lang":"zh",
                      "lines":[
                         {
                            "boundingBox":"441,206,536,206,536,234,441,234",
                            "text":"金额",
                            "words":[
                               {
                                  "word":"金",
                                  "boundingBox":"454,206,461,206,..."
                                        ......
                                        }
                                    ]
                                }]
                            }
                        }
                        .....
  1. docType为excel时的结果:
{
       "errorCode":"0",   #返回状态 如果成功, 返回0
       "Result":"{
                    "orientation":"UP",#图片方向
                    "tables":["UEsDBBQ ... ... AsAxQIAAOQ1AAA=="]# 表格excel,使用base64编码后的结果
                 }"
}

图片支持

格式支持:jpg/png

尺寸限制:2MB以下

错误代码列表

错误码含义
101缺少必填的参数
102不支持的语言类型
103请求文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108appKey无效,注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)
109batchLog格式不正确
110无相关服务的有效实例
111开发者账号异常
112请求服务无效
113请求文本不能为空
114不支持的图片传输方式
201解密失败
202签名检验失败
203访问IP地址不在可访问IP列表
205请求的接口与应用的平台类型不一致
206时间戳无效
207重放请求
301词典查询失败
302小语种查询失败
303服务端的其它异常
401账户已经欠费停
411访问频率受限,请稍后访问
412超过最大请求字符数
13001不支持的角度类型
13002不支持的文件类型
13003表格识别图片过大
13004文件为空
13301表格识别失败

常见问题及注意事项

(1). 运行程序崩溃?

检查下是否对应的 SDK静态库包 是否放到当前工程目录下。

(2). 表格识别没结果?

检查下表格识别接口回调的错误信息,保证申请的 appKey 是有效且提前绑定了。

(3). 如何获得 appKey

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

版本更新记录

上线日期版本号更新内容
2019.03.25v1.0.0有道智云 表格识别 iOS SDK上线

有道智云整题识别(含公式) iOS SDK 文档

有道智云 整题识别(含公式) SDK简介

一.概述

1.概念解释

整题识别(含公式)服务:基于有道机器学习团队业界领先的深度学习技术,将自然场景下图片上的题目文字、数字及公式信息,通过定位和检测,智能识别为可编辑的文本信息,轻松实现题目电子化。

2.说明

Hi,您好,欢迎使用有道智云整题识别(含公式) iOS SDK。如果您想快速体验服务,建议您前往官网体验中心或者搜索小程序(有道智云体验中心)进行试用。

本文档主要针对需要集成整题识别(含公式)服务iOS SDK的开发工程师,详细描述有道智云整题识别(含公式)能力及集成过程。

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

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

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

客服QQ:1906538062

智云OCR技术交流QQ群: 471638046

联系邮箱: zyservice@corp.youdao.com

温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建iOS应用,并绑定整题识别(含公式)实例;如果您还没有,请按照新手指南操作。

平台向每个账户赠送100元的体验金,供用户集成前测试所用,具体资费规则详见公式服务报价

二.功能介绍

有道整题识别(含公式) SDK 是有道智云开放平台提供的云服务之一,是有道在线整题识别(含公式) 接口的一种实现,支持在线整题识别(含公式)。

三.兼容性

支持设备:运行了iOS 9.0及以上系统的 iOS 设备

整题识别(含公式)SDK集成指南

集成前提

开始集成SDK之前开发者需要登录有道开放平台,创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用公式服务。

集成步骤

1.SDK包导入

整题识别(含公式) SDK 由如下几个 SDK 组成,FanYiSDK.h、libbase.a、libFormula.a

(1). 添加头文件和库文件:将FormulaSDK 添加到工程中,包括 FanYiSDK.h头文件、libbase.a和libFormula.a文件。可以直接将FormulaSDK文件夹拖动到工程中,也可以选择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。

2.SDK初始化

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

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

功能集成

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

1.构造查询器

YDFormulaRequest *request = [YDFormulaRequest request];
YDFormulaParameter *param = [YDFormulaParameter param];
param.source = @"youdaoformula"; //设置源
param.detectType = @"10011"; //设置识别类型
request.param = param;

2.将图片转化为base64编码

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

3.执行识别过程

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

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

识别结果说明

对于在线整题识别(含公式),服务器查询结果返回数据如下:

{
    "errorCode": "0",
    "Result": {
    "orientation": "",
        "regions": [{
        "boundingBox": "13,16,584,16,584,82,13,82",
        "dir": "h",
        "lang": "",
        "lines": [
            [{
                "boundingBox": "13,22,110,22,110,76,13,76",
                "text_height": 53,
                "words": [{
                "boundingBox": "13,23,74,22,74,75,13,76",
                "word": "13."
            }, {
                "boundingBox": "86,22,110,22,110,75,86,75",
                "word": "若"
                }],
                "text": "13.若",
                "type": "text"
            }, {
                "boundingBox": "111,16,326,16,326,82,111,82",
                "text_height": 66,
                "words": [{
                "boundingBox": "111,16,326,16,326,82,111,82",
                "word": " x = ( \\sqrt { 3 } { - 5 } ) ^ { 3 }"
                }],
                "text": "x = ( \\sqrt { 3 } { - 5 } ) ^ { 3 }",
                "type": "formula"
            }, {
                "boundingBox": "327,22,384,22,384,76,327,76",
                "text_height": 53,
                "words": [{
                "boundingBox": "327,22,338,23,338,76,327,75",
                "word": ","
                }, {
                "boundingBox": "350,23,384,23,384,76,350,76",
                "word": "则"
                }],
                "text": ",则",
                "type": "text"
            }, {
                "boundingBox": "385,16,584,16,584,82,385,82",
                "text_height": 66,
                "words": [{
                "boundingBox": "385,16,584,16,584,82,385,82",
                "word": " \\sqrt { - x - 1 } ="
                }],
                "text": "\\sqrt { - x - 1 } =",
                "type": "formula"
            }]
        ]
        }],
    "exif": "UP"
    }
}

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

@interface YDFormulaResult : NSObject
@property (nonatomic, copy) NSString *orientation;
@property (nonatomic, copy) NSString *angle;
@property (nonatomic, copy) NSString *exif;
@property (nonatomic, strong) NSArray *regions;
+ (instancetype)initWithDict:(NSDictionary *)info;
@end


@interface YDFormulaRegion : NSObject
@property (nonatomic, copy) NSString *boundingBox;
@property (nonatomic, copy) NSString *dir;
@property (nonatomic, strong) NSArray *lines;
+ (instancetype)initWithDict:(NSDictionary *)info;
@end

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

支持语言

语言代码
中文zh-CHS
日文ja
英文EN
韩文ko
法文fr
俄文ru
葡萄牙文pt
西班牙文es

错误代码列表

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

常见问题及注意事项

(1). 运行程序崩溃?

检查下是否对应的 SDK静态库包 是否放到当前工程目录下。

(2). 整题识别(含公式)没结果?

检查下整题识别(含公式)接口回调的错误信息,保证申请的 appKey 是有效且提前绑定了。

(3). 如何获得 appKey

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

版本更新记录

上线日期版本号更新内容
2019.05.28v1.0.0有道智云整题识别(含公式) iOS SDK上线
文档是否有帮助解决问题?

如有其它疑问,可在此提交意见和反馈
详细描述(选填)
联系邮箱(选填)
留下您的合作信息,专业顾问将联系您提供免费的咨询
是否为渠道商:
服务类型:
详细分类:
所属地区:
所属行业:
公司名称:
业务简介:
使用场景:
使用量级:
联系人姓名:
联系人电话:
联系人邮箱:
联系人职务:
来源渠道:
verificatiton pics
验证码:
联系方式
合作咨询
联系电话:010-8255-8901
商务合作:
投诉反馈:
地       址:北京市海淀区西北旺东路10号院 中关村软件园二期西区7号 网易(北京)公司
微信公众号
微信小程序
 
 
©2019 网易公司 京ICP证080268号