图片翻译 IOS SDK 简介
概述
(1) 概念解释
图片翻译:基于文字识别与文本翻译技术,结合组段和渲染技术,满足用户翻译图片文字的需求,提升输入效率
(2) 说明
Hi,您好,欢迎使用有道智云图片翻译iOS SDK。
如果您想快速体验服务,建议您前往官网体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。
本文档主要针对需要集成图片翻译服务iOS SDK的开发工程师,详细描述有道智云图片翻译能力及集成过程。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云翻译技术交流QQ 1群: 652880659
智云翻译技术交流QQ 2群: 669384425
智云翻译技术交流QQ 3群: 807539209
智云翻译技术交流QQ 4群: 936752411
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建iOS应用,并绑定图片翻译实例;如果您还没有,请按照新手指南 操作。
平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见图片翻译服务报价 。
功能介绍
有道图片翻译 SDK 是有道智云开放平台提供的云服务之一,是有道在线图片翻译接口的一种实现,支持在线图片翻译。
兼容性
支持设备:运行了iOS 8.0及以上系统的 iOS 设备
图片翻译SDK集成指南
集成前提
开始集成SDK之前开发者需要登录有道智云平台 ,创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用翻译服务。
集成步骤
SDK包导入
翻译SDK由如下几个SDK组成,用户可根据需要组合使用:
文件 | 说明 |
---|---|
FanYiSDK.h | 头文件(必选) |
libbase.a | 图片翻译相关sdk基础库(必选) |
libocrtrans.a | 在线图片翻译 SDK(必选,使用在线图片翻译时使用) |
- 添加头文件和库文件:将 translateSDK 添加到工程中,包括 FanYiSDK.h 头文件和 libFanYiSDK.a 文件。可以直接将 translateSDK 文件夹拖动到工程中,也可以选择File “Add files to ‘Project Name’…”
- 设置工程 Other Linker Flags 为 -ObjC
- 若使用离线功能,修改工程中任意一个类后缀名为
.mm
,参见 demo 中 ViewController.mm,Xcode 10.0之前的版本需要添加libstc++.6.0.9.tbd,Xcode 10.0及以上版本需要设置C++ Standard Library为libc++;若未使用离线功能可跳过此步骤;
- 在工程build Phases – Link Binary With Libraries中添加libFanYiSDK.a, AdSupport.framework, CoreTelephony.framework, SystemConfiguration, libz.tbd和libsqlite3.tbd。如下:
SDK初始化
说明:所有的查询都需要初始化appKey(应用ID),只执行初始化一次即可。
注:appKey即应用ID
//初始化appKey(应用ID)
YDTranslateInstance *yd = [YDTranslateInstance sharedInstance];
yd.appKey = @"your appkey";
功能集成
说明:请参考 demo 中 OCRTransController 的使用
- 构造查询器
YDOCRTransRequest *request = [YDOCRTransRequest request];
YDOCRTransParameter *param = [YDOCRTransParameter param];
param.from = @"en"; //设置源语言
param.to = @"zh-CHS"; //设置目标语言
param.serverRenderImage = YES; //设置服务端渲染
request.param = param;
- 将图片转化为base64编码
NSString *base64Str = [self image2DataURL:self.imgView.image];
- 执行翻译过程
识别返回两种情况,一种是成功,相关结果存储在 result
参数中,另外一种是失败,失败信息放在 error
,可根据 错误代码列表 查询。整个识别是异步的。
request lookup:base64Str WithCompletionHandler:^(YDOCRTransRequest *request, NSDictionary *info, NSError *error) {
if (error) {
//失败
NSLog(@"error:%@", error);
[HUDUtil show:self.view text:@"识别失败"];
}else {
//成功
YDOCRTransResult *result = [YDOCRTransResult mj_objectWithKeyValues:info];
NSLog(@"%@", result);
[HUDUtil show:self.view text:@"识别成功"];
[self handleOCRTransReuslt:result];
}
}];
翻译结果说明
对于在线图片翻译,服务器查询结果返回数据如下:
{
"orientation": "Up",
"lanFrom": "en",
"textAngle": "0.0",
"errorCode": "0",
"lanTo": "zh-CHS",
"render_image": "...."
"resRegions": [{
"boundingBox": "134,0,1066,249",
"linesCount": 7,
"lineheight": 28,
"context": " There are two ways to cope with the problem in government. One (dis cussed in the preceding chapter) is to supply the service or product in a marketlike environment. Shift the burden of evaluation off the shoulders of professional evaluators and onto the shoulders of clients and customers, and let the latter vote with their feet. The \"client\" in these cases can be individual citizens or government agencies; what is important is that the client be able to choose from among rival suppliers.",
"linespace": 7,
"tranContent": "有两种方法可以在政府应对的问题。一个(在前一章讨论)是提供的服务或产品marketlike环境。肩上的负担,转变评价专业评估和客户的肩膀上,并让后者用脚投票。“客户”在这些情况下可以公民个人或政府机构;重要的是客户端可以选择从竞争对手的供应商。"
}, {
"boundingBox": "116,253,1100,354",
"linesCount": 10,
"lineheight": 28,
"context": " But some public services cannot be supplied, or arc never going to be sup plied, by a market. We can imagine allowing parents to choose among schools but we cannot imagine letting them choose (at least for most purposes) among police departments or armies. In that case one should adopt the second way of evaluating a public service: carry out a demonstration project or conduct a field experiment. (I will use the two ideas interchangeably, though some schol ars distinguish between them.7) An experiment is a planned alteration in a state of affairs designed to measure the effect of the intervention. It involves asking the question, \"If I change X, what will happen to Y, having first made certain that everything else stays the same?\" It sounds easy, but it is not.",
"linespace": 5,
"tranContent": "但是一些公共服务不能提供,或弧永远不会一口招摇撞骗,由一个市场。我们可以想象允许父母选择在学校但是我们无法想象让他们选择(至少在大多数情况下)在警察部门或军队。在这种情况下应该采用第二种方法评价公共服务:开展示范项目或进行现场试验。(我将使用两个概念互换,尽管有些schol ars区分them.7)一个实验计划变更的状态设计测量干预的效果。它涉及到问这个问题:“如果我改变X,Y,会发生什么在第一次确信一切保持不变吗?”这听起来容易,但事实并非如此。"
}, {
"boundingBox": "101,609,1141,152",
"linesCount": 4,
"lineheight": 28,
"context": " A good experiment (bad ones are worse than no experiment at all) requires that one do the following: First, identify a course of action to be test ed; call it the treatment. A \"treatment\" can be a police tactic, a school cur riculum, or a welfare program. Second, decide what impact the treatment is",
"linespace": 5,
"tranContent": "一个好的实验(坏的比任何实验)要求执行以下操作:首先,确定一个测试ed的行动;叫它治疗。“治疗”可以是一个警察战术,一个学校cur riculum,或福利计划。第二,决定什么是影响治疗"
}]
}
render_image 是服务端渲染过的翻译图片
服务器是按照区域,行,字的格式返回的,即一张图片会识别出图片对应的 Result,其上可能有多个区域 Region,每个区域会包含一行或多行 Line,boundingBox 字段返回坐标和大小。 SDK 对上述 json 数据解析封装为 YDOCRTransResult 对象,如下:
@interface YDOCRTransResult : NSObject
/* 错误码 */
@property (nonatomic, copy) NSString *errorCode;
/* ocr所识别出来认为的图片中的语言 */
@property (nonatomic, copy) NSString *lanFrom;
/* 目标语言 */
@property (nonatomic, copy) NSString *lanTo;
/* 图片所对应的方向 */
@property (nonatomic, copy) NSString *orientation;
/* 图片翻译的具体内容 */
@property (nonatomic, strong) NSArray *resRegions;
/* 图片的倾斜角度 */
@property (nonatomic, copy) NSString *textAngle;
/* 原始数据 */
@property (nonatomic, strong) NSDictionary *info;
+ (instancetype)initWithDict:(NSDictionary *)info;
@end
@interface YDOCRTransRegion : NSObject
/* 区域范围,四个值:左上角的x值,左上角的y值,区域的的宽,区域的高,例如:134,0,1066,249 */
@property (nonatomic, copy) NSString *boundingBox;
/* 该区域的原文 */
@property (nonatomic, copy) NSString *context;
/* 行高 */
@property (nonatomic, copy) NSString *lineheight;
/* 行数(用于前端排版) */
@property (nonatomic, copy) NSString *linesCount;
/* 翻译结果 */
@property (nonatomic, copy) NSString *tranContent;
/* 行间距 */
@property (nonatomic, copy) NSString *linespace;
+ (instancetype)initWithDict:(NSDictionary *)info;
@end
支持语言
语言 | 代码 |
---|---|
中文 | zh-CHS |
日文 | ja |
英文 | en |
韩文 | ko |
法文 | fr |
俄文 | ru |
葡萄牙文 | pt |
西班牙文 | es |
越南文 | vi |
德文 | de |
阿拉伯文 | ar |
印尼文 | id |
自动识别 | auto |
错误代码列表
错误码 | 含义 |
---|---|
101 | 缺少必填的参数 |
102 | 不支持的语言类型 |
103 | 翻译文本过长 |
104 | 不支持的API类型 |
105 | 不支持的签名类型 |
106 | 不支持的响应类型 |
107 | 不支持的传输加密类型 |
108 | 应用ID无效,注册账号,登录后台创建应用和实例并完成绑定,可获得应用ID和应用密钥等信息 |
109 | batchLog格式不正确 |
110 | 无相关服务的有效实例 |
111 | 开发者账号无效 |
113 | q不能为空 |
114 | 不支持的图片传输方式 |
201 | 解密失败,可能为DES,BASE64,URLDecode的错误 |
202 | 签名检验失败 |
203 | 访问IP地址不在可访问IP列表 |
205 | 请求的接口与应用的平台类型不一致,如有疑问请参考入门指南 |
206 | 因为时间戳无效导致签名校验失败 |
207 | 重放请求 |
301 | 辞典查询失败 |
302 | 翻译查询失败 |
303 | 服务端的其它异常 |
304 | 会话闲置太久超时 |
401 | 账户已经欠费停 |
402 | offlinesdk不可用 |
411 | 访问频率受限,请稍后访问 |
412 | 长请求过于频繁,请稍后访问 |
1001 | 无效的OCR类型 |
1002 | 不支持的OCR image类型 |
1003 | 不支持的OCR Language类型 |
1004 | 识别图片过大 |
1201 | 图片base64解密失败 |
1301 | OCR段落识别失败 |
1411 | 访问频率受限 |
1412 | 超过最大识别字节数 |
2003 | 不支持的语音声道 |
2004 | 不支持的语音上传类型 |
2005 | 不支持的语言类型 |
2006 | 不支持的识别类型 |
2201 | 识别音频文件过大 |
2301 | 识别音频时长过长 |
2411 | 不支持的音频文件类型 |
2412 | 不支持的发音类型 |
3001 | 不支持的语音格式 |
3002 | 不支持的语音采样率 |
3003 | 不支持的语音声道 |
3004 | 不支持的语音上传类型 |
3005 | 不支持的语言类型 |
3006 | 不支持的识别类型 |
3007 | 识别音频文件过大 |
3008 | 识别音频时长过长 |
3009 | 不支持的音频文件类型 |
3010 | 不支持的发音类型 |
3201 | 解密失败 |
3301 | 语音识别失败 |
3302 | 语音翻译失败 |
3303 | 服务的异常 |
3411 | 访问频率受限,请稍后访问 |
3412 | 超过最大请求字符数 |
5001 | 无效的OCR类型 |
5002 | 不支持的OCR image类型 |
5003 | 不支持的语言类型 |
5004 | 识别图片过大 |
5005 | 不支持的图片类型 |
5006 | 文件为空 |
5201 | 解密错误,图片base64解密失败 |
5301 | OCR段落识别失败 |
5411 | 访问频率受限 |
5412 | 超过最大识别流量 |
9001 | 不支持的语音格式 |
9002 | 不支持的语音采样率 |
9003 | 不支持的语音声道 |
9004 | 不支持的语音上传类型 |
9005 | 不支持的语音识别 Language类型 |
9301 | ASR识别失败 |
9303 | 服务器内部错误 |
9411 | 访问频率受限(超过最大调用次数) |
9412 | 超过最大处理语音长度 |
10001 | 无效的OCR类型 |
10002 | 不支持的OCR image类型 |
10004 | 识别图片过大 |
10201 | 图片base64解密失败 |
10301 | OCR段落识别失败 |
10411 | 访问频率受限 |
10412 | 超过最大识别流量 |
13001 | 不支持的角度类型 |
13002 | 不支持的文件类型 |
13003 | 表格识别图片过大 |
13004 | 文件为空 |
13301 | 表格识别失败 |
17001 | 需要图片 |
17002 | 图片过大(1M) |
17003 | 识别类型未找到 |
17004 | 不支持的识别类型 |
17005 | 服务调用失败 |
-1000 | 未知错误 |
-2000 | 查询输入为空 |
常见问题及注意事项
1.运行程序崩溃?
检查下是否对应的 SDK静态库包
是否放到当前工程目录下。
2.翻译没结果?
检查下翻译接口回调的错误信息,保证申请的应用ID是有效且提前绑定了。
3.添加翻译 SDK 之后审核没有通过?
翻译 SDK 使用了 AdSupport 框架获取设备 IDFA 信息用以统计计费,提交审核时对应用是否有广告选项请选择“是”。
版本更新记录
上线日期 | 版本号 | 更新内容 |
---|---|---|
2017.05.08 | v1.0.0 | 有道智云翻译 iOS SDK上线,支持在线离线翻译 |
2017.06.07 | v1.1.0 | 1. 拆分翻译 SDK,SDK 拆分为多个文件,用户可根据需要引用 2. 修复已知 bug |
2017.06.30 | v1.2.0 | 修复已知 bug |
2017.07.24 | v1.3.0 | 1. 修复 deeplink 相关 bug |
2017.08.16 | v1.4.0 | 1. 修复已知 bug |
2018.02.09 | v1.7.0 | 支持在线语音翻译 |
2018.05.16 | v1.7.2 | 支持在线图片翻译 |