帮助与文档 > 产品文档 > 自然语言翻译 > iOS SDK 文档

有道智云翻译 iOS SDK 文档

有道智云翻译 SDK 简介

有道翻译SDK是有道开放平台提供的云服务之一,是有道在线翻译接口的一种实现,同时,支持离线中英查词。有道翻译SDK支持中文和日文、英文、韩文、法文、俄文、葡萄牙文、西班牙文之间的互译。

通过SDK接入优势:

  1. 可以使用离线翻译,不联网也可以翻译
  2. 接入简单,不用实现整个翻译协议
  3. 方便进行数据统计,了解用户翻译使用情况

集成前提

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

翻译sdk由如下几个sdk组成,用户可根据需要组合使用:

文件说明
FanYiSDK.h头文件(必选)
libbase.a翻译相关sdk基础库(必选)
libhanyucidianoffline.a汉语词典翻译sdk(可选,使用汉语词典功能时使用)
libonline.a在线翻译sdk(可选,包含英汉互译,以及小语种翻译,在线查询)
libwordoffline.a离线查词sdk(可选,中英单词的离线查询)
libsencentenceoffline.a离线句子sdk(可选,中英句子的离线查询)
fanyidemosdk使用demo
StaticResourceStaticResource文件夹下的文件用于离线查词和汉语词典翻译,如果不使用离线功能,不需要StaticResource文件。

文件目录如下图所示:

说明:无论使用何种功能,都需要加入 FanYiSDK.hlibbase.a ,和相应功能的sdk,各sdk可组合使用。

SDK集成步骤

1. 头文件及SDK库引入

1. 添加头文件和库文件:将 translateSDK 添加到工程中,包括 FanYiSDK.h 头文件和 libFanYiSDK.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中添加libFanYiSDK.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 离线汉语词典查词功能

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

1. 使用的库文件:头文件、libbase.a、libhanyucidianoffline.a,以及离线词库文件hh,离线词库可以下载或者放入工程中,开发者根据需求自行决定:若下载则需要提供下载url,先下载再初始化;若放入工程中则可提词库路径直接初始化。

2. 构造查询器

offlinetranslate = [YDHanyucidianOfflineTranslate request];

3. 初始化离线词库

-(void)offLineInit {
  // 执行此初始化方法之后,确保hh文件在指定路径中存在(hh文件可压缩成zip文件后供用户下载,客户端使用之前解压即可)
  if([offlinetranslate initOfflineWithPath:[XUtil getDownloadPath]]){
      [HUDUtil show:self.view text:@"离线查词初始化成功"];
  }else{
      [HUDUtil show:self.view text:@"离线查词初始化失败"];
  }
}

注意: initOffline 方法是 YDHanyucidianOfflineTranslate 的实例方法,当 YDHanyucidianOfflineTranslate 被重新初始化之后,若想使用离线查词,必须调用 initOffline 方法。

4. 执行查词过程。

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

[offlinetranslate lookup:textField.text WithCompletionHandler:^(YDHanyucidianOfflineTranslate *request, NSArray *transltes, NSError *error) {
      if (error) {
          NSString *des = [error.userInfo objectForKey:NSLocalizedDescriptionKey];
          NSLog(@"================> %ld%@", (long)error.code,des);

      }
      [self showTrans:transltes];
}];

2.3 在线查词和翻译功能(支持小语种)

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

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

2. 构造查询器

translateRequest  = [YDTranslateRequest request];

3. 设置查词所需要的附加信息

YDTranslateParameters *parameters = [YDTranslateParameters targeting];
parameters.source = @"youdaosw";
parameters.from = YDLanguageTypeChinese;
parameters.to = YDLanguageTypeEnglish;
translateRequest.translateParameters = parameters;

4. 执行查词过程

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

[translateRequest lookup:[_translate objectForKey:@"content"] WithCompletionHandler:^(YDTranslateRequest *request, YDTranslate *response, NSError *error) {
      if (error) {
          //查询失败
      } else {
         //查询成功
      }
}];

2.4 离线汉英单词互译功能

说明:请参考 demo 中 OfflineTranslatesViewController 的使用, StaticResource 中文件夹中包含离线查词的库。

1. 使用的库文件:头文件、libbase.a、libwordoffline.a、以及离线词库,离线词库可以下载或者放入工程中,开发者根据需求自行决定:若下载则需要提供下载url,先下载再初始化;若放入工程中则可提词库路径直接初始化。

2. 构造查询器

offlinetranslate  = [YDWordOfflineTranslate request];

3. 初始化离线词库

离线查词包含2个库,dicta 和 dictb,区别是 dicta 词库包含的词比较多,文件较大,dictb 只包含常见词汇。开发者可根据实际情况,选择一个词库使用即可。下面以 dictb 词库为例,介绍如何使用离线查词功能。

使用离线查询功能, 涉及到4个包,ba160111.ydd,bb160111,dictWithSeg.dat,yddict.dat.其中 dictWithSeg.dat 和 yddict.idx 文件必须导入到工程中,并且已经添加到 Copy bundle Resource 中。如下:

ba160111.ydd 和 bb160111 支持两种路径。开发者可指定词库的位置,也可以打到安装包中,分别调用不同的初始化方法即可。

//可选方式一、指定离线词库(ba160111.ydd和bb160111.ydd文件的)路径。注意,调用前提是该位置下已经包含这两个文件,否则初始化失败。
[offlinetranslate initOfflineWithPath:[XUtil getDownloadPath]];//布尔型返回值,代表初始化成功或者失败

//可选方式二、离线词库在安装包中(需要将这2个文件导入到工程中,确保Copy bundle Resource中能找到这2个文件)
[offlinetranslate initOffline]; //布尔型返回值,代表初始化成功或者失败

注意:initOffline方法是YDWordOfflineTranslate的实例方法,当YDWordOfflineTranslate被重新初始化之后,若想使用离线查词,必须调用initOffline方法。

4. 执行查词过程

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

[offlinetranslate lookup:[_translate objectForKey:@"content"] WithCompletionHandler:^(YDWordOfflineTranslate *request, YDTranslate *translte, NSError *error) {
     if (error) {
        //查询失败
    } else {
       //查询成功
    }
}];

2.5 离线汉英句子互译功能

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

1. 使用的库文件:头文件、libbase.a、libsencentenceoffline.a,以及离线词库文件ce.zip,离线词库可以下载或者放入工程中,开发者根据需求自行决定:若下载则需要提供下载url,先下载再初始化;若放入工程中则可提词库路径直接初始化。

2. 构造查询器

offlinetranslate  = [YDSentenceOfflineTranslate request];

3. 初始化离线词库

-(void)offLineInit{
   //初始化之前先下载离线词库文件ce.zip(参见demo),每次查询均要先初始化离线翻译句子词库
   if([offlinetranslate initOfflineSenWithPath:[XUtil getDownloadPath]]){
       [HUDUtil show:self.view text:@"离线句子初始化成功"];
   }else{
       [HUDUtil show:self.view text:@"离线句子初始化失败"];
   }
}

注意: offLineInit 方法是 YDSentenceOfflineTranslate 的实例方法,当 YDSentenceOfflineTranslate 被重新初始化之后,若想使用离线查词,必须调用 offLineInit 方法。

4. 执行查词过程。

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

[offlinetranslate lookup:[_translate objectForKey:@"content"] WithCompletionHandler:^(YDSentenceOfflineTranslate *request, YDTranslate *translte, NSError *error) {
       if (error) {
           //查询失败
       } else {
           //查询成功
       }
}];

2.6 deeplink 跳转

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

点击查看更多,将进行deeplink跳转,若安装有道词典,则跳转到有道词典app里并显示所查单词的解释,若未安装有道词典,则跳转到Safari浏览器web界面并显示所查单词的解释;

- (void)toDict{
   //    //跳转到词典
   [_translate.ydTranslate openMore];
}

若在汉语词典界面点击查看更多,也会进行deeplink跳转;

- (void)toDict{
   //跳转到词典
   if (self.transltes.count) {
       YDChDictTranslate *translate = [self.transltes objectAtIndex:0];
       [translate openMore];
   }
}

常见问题及注意事项

1. 翻译没结果?

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

2. 离线查询无效?

确保离线库正确放置,离线初始化成功。

3. 添加翻译 SDK 之后审核没有通过?

翻译 SDK 使用了 AdSupport 框架获取设备 IDFA 信息用以统计计费,提交审核时对应用是否有广告选项请选择“是”。

支持语言

自动,中文, 日文, 英文, 韩文,法文, 俄文, 葡萄牙文, 西班牙文

错误码

错误码含义
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账户已经欠费停
-1000未知错误
-2000查询输入为空

版本更新记录

上线日期版本号更新内容
2017.05.08v1.0.0有道智云翻译 iOS SDK上线,支持在线离线翻译
2017.06.07v1.1.01. 拆分翻译 SDK,SDK 拆分为多个文件,用户可根据需要引用
2. 修复已知 bug
2017.06.30v1.2.0修复已知 bug
2017.07.24v1.3.0修复 deeplink 相关 bug
2017.08.16v1.4.0修复已知 bug
 
有道智云平台介绍
网易有道旗下一个为开发者、企业和政府机构等提供自然语言翻译、文字识别OCR等服务以及行业解决方案的云服务平台,致力于提供安全、可靠和高效的云服务。
联系方式
联系电话:010-8255-8901
商务合作:
投诉反馈:
地址:北京市海淀区西北旺东路10号院 中关村软件园二期西区7号 网易(北京)公司
微信公众号
 
 
 
©2017 网易公司 京ICP证080268号