(1) 概念解释
文本翻译:将一段源语言文本转换成目标语言文本,可根据语言参数的不同实现多国语音之间的互译
(2) 说明
Hi,您好,欢迎使用有道智云文本翻译Android SDK。如果您想快速体验服务,建议您前往 翻译体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。
本文档主要针对需要集成文本翻译服务Android SDK的开发工程师,详细描述有道文本翻译能力及集成过程。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云翻译技术交流QQ 1群: 652880659
智云翻译技术交流QQ 2群: 669384425
智云翻译技术交流QQ 3群: 807539209
智云翻译技术交流QQ 4群: 936752411
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建Android应用,并绑定文本翻译实例;如果您还没有,请按照 新手指南 操作。
平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 文本翻译服务报价 。
文本翻译SDK是有道在线文本翻译服务进行封装,同时支持离线中英查词。提供快速的接入方式;同时提供数据统计能力,方便了解用户翻译使用情况。
支持设备:运行了 Android 4.0.3以及以上系统的 Android 设备
开始集成SDK之前开发者需要登录 有道智云平台 ,创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用翻译服务。
(1) SDK包导入
请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建),并将以下jar包拷贝到 libs 目录下:
文件 | 说明 |
---|---|
YoudaoBase_v2.0.0.jar | 翻译相关sdk基础库(必选) |
YoudaoCnDictOffline.jar | 汉语词典翻译sdk(可选,使用汉语词典功能时使用) |
YoudaoTranslateOnline_v2.0.0.jar | 在线翻译sdk(可选,包含英汉互译,以及小语种翻译,在线查询) |
YoudaoTranslateOffline.jar | 离线查词/翻译sdk(可选,中英单词和句子的离线查询) |
将以下代码添加到app的build.gradle中:
android {
sourceSets.main.jniLibs.srcDirs = ['libs']
...
}
dependencies {
compile files('libs/YoudaoBase_v2.0.0.jar')
compile files('libs/YoudaoCnDictOffline.jar')
compile files('libs/YoudaoTranslateOnline_v2.0.0.jar')
compile files('libs/YoudaoTranslateOffline.jar')
}
(2) AndroidManifest配置
<uses-permission android:name="android.permission.INTERNET" />
<!-- 获取WiFi状态 -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<!-- 获取网络信息状态,如当前的网络连接是否有效 -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!-- 读取手机状态 phone group -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<!-- 往SDCard读写数据权限 storage group -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
(3) 代码混淆配置
代码混淆文件proguard-project.txt,添加如下内容:
-ignorewarnings
-libraryjars libs/ YoudaoBase_v2.0.0.jar
-libraryjars libs/ YoudaoCnDictOffline.jar
-libraryjars libs/ YoudaoTranslateOnline_v2.0.0.jar
-libraryjars libs/ YoudaoTranslateOffline.jar
-keep class com.youdao.sdk.ydtranslate.** { *;}
-keep class com.youdao.sdk.chdict.** { *;}
-keep class com.youdao.localtransengine.** { *;}
-keep class com.youdao.sdk.ydonlinetranslate.** { *;}
(4) SDK初始化
使用图片翻译SDK,请在程序的Application中调用SDK初始化代码,可以参考demo中DemoApplication。
注:appKey即应用ID
//appKey即应用ID
YouDaoApplication.init(this, appkey);
1.离线汉语词典翻译功能集成
(1) 构造查词对象
提供了两种初始化方法,如下所示:
/*
* 可以查词之前设置离线词库路径,则采用默认路径Environment
* .getExternalStorageDirectory().getPath() + "/yuwen/backup/"
* 请确保设置的路径或者默认路径下包含汉语词典的离线包
*/
chDictor = new ChDictor();
/*
*表*示Environment.getExternalStorageDirectory().getAbsolutePath()* + dictFilePath路径下存在离线库
*/
chDictor = new ChDictor(dictFilePath);
(2) 查词对象初始化和查询
//注意,每次查询之前都需要初始化
chDictor.init();
chDictor.lookup(text, new DictListener() {
@Override
public void onResult(final List<ChDictTranslate> chTs) {
//针对多音字的情况,可能返回多个ChDictTranslate对象,比如查询“会”
// 注意:回调是在子线程中进行,拿到查询结果之后若有更新UI操作,请切换到主线程执行
MainHandler.getInstance().post(new Runnable() {
@Override
public void run() {
}
});
}
@Override
public void onError(String q, String info) {
// TODO Auto-generated method stub
}
});
注意: 使用离线汉语词典前,请确认 最新汉语词库v1.1\最新汉语词库\hh
在设置的路径或者默认路径下
2.在线查词和翻译功能(支持小语种)功能集成
说明:请参考 demo 中 TranslateActivity
的使用
(1) 参数说明
from:表示源语言
to:表示目标语言
source:设置为app对应的名称(英文字符串)
注意:若from设置为自动,则查询自动识别源语言,自动识别不能保证完全正确,最好传源语言类型
(2) 构造查词参数对象
Language langFrom = LanguageUtils.getLangByName("中文");
Language langTo = LanguageUtils.getLangByName("英文");
TranslateParameters tps = new TranslateParameters.Builder()
.source("ydtranslate-demo")
.from(langFrom)
.to(langTo)
.build();
(3) 设置回调和开始翻译
通过Translator,设置上一步构造的查词对象,调用lookup方法传入文本数据和回调接口开始查询,方法中参数"requestId",SDK并未使用,在回调中会再返回给开发者,用于区分每次调用,开发者可传null或者任意字符串。
识别回调接口包含两个方法:onResult表示识别成功,相关结果存储在result参数中,onError表示失败,失败信息放在TranslateErrorCode枚举类中。
注意:整个识别是异步的,回调在子线程进行,若涉及到界面操作,请切回主线程。
Translator.getInstance(tps).lookup(input, "requestId", new TranslateListener() {
@Override
public void onResult(Translate result, String input) {//查询成功
}
@Override
public void onError(TranslateErrorCode error) {//查询失败
}
});
3.离线查词和离线句子翻译功能集成
说明:请参考 demo 中 TranslateOfflineActivity
的使用
(1) 查词对象初始化
translatorOffline = new TranslatorOffline();
(2) 初始化词库
若使用离线查词,请通过方式一、方式二或者方式三初始化词库,三种方式只能选择一种;
初始化词库方式一,词库在assets/dict目录下,不支持直接放在assets目录下
translatorOffline.initWordDict("dict", true, new EnWordTranslator.EnWordInitListener() {
@Override
public void success() {
}
public void fail(TranslateErrorCode errorCode){
Log.d("translatorOffline","init false");
}
});
初始化词库方式二,指定词库绝对路径,比如sd卡下:
translatorOffline.initWordDict(Environment.getExternalStorageDirectory().getAbsolutePath() + "/Youdao/localdict1/", false, new EnWordTranslator.EnWordInitListener() {
@Override
public void success() {
Log.d("translatorOffline", "init success");
long end = System.currentTimeMillis();
long time = end - start;
Log.i("1111111111111111", "111111111初始化时间" + time);
}
public void fail(TranslateErrorCode errorCode) {
Log.d("translatorOffline", "init false");
}
});
初始化词库方式三,分别指定每个词库的路径:
//初始化中日词库,若使用日中还需要初始化日中词库
translatorOffline.initWordDictWithWordConvert("dict", true, WordConvert.CH2JA, new EnWordTranslator.EnWordInitListener() {
@Override
public void success() {
}
public void fail(TranslateErrorCode errorCode){
}
});
//初始化韩中词库,若使用中韩,还需要初始化中韩词库
translatorOffline.initWordDictWithWordConvert(Environment.getExternalStorageDirectory().getAbsolutePath() + "/Youdao/localdict2/", false, WordConvert.KO2CH, new EnWordTranslator.EnWordInitListener() {
@Override
public void success() {
}
public void fail(TranslateErrorCode errorCode){
}
});
//初始化中英、英中词库
translatorOffline.initWordDictWithWordConvert("dict", true, WordConvert.EN2CH, new EnWordTranslator.EnWordInitListener() {
@Override
public void success() {
}
public void fail(TranslateErrorCode errorCode){
}
});
(3) 初始化离线句子库
translatorOffline.initLineDict(Environment.getExternalStorageDirectory().getAbsolutePath() + "/Youdao/Translator/transdata/data/ce2");
(4) 获取词库和句子库是否初始化成功
translatorOffline.isLineInited(); translatorOffline.isWordInited();
(5) 执行查询
String from = "中文";
String to = "英文";
Language langFrom = LanguageUtils.getLangByName(from);
Language langTo = LanguageUtils.getLangByName(to);
TranslateParameters parameters = new TranslateParameters.Builder().
from(langFrom).to(langTo).useAutoConvertWord(true).useAutoConvertLine(false).build();
translatorOffline.lookupNative(input, parameters, "requestId", new TranslateListener() {
@Override
public void onResult(final Translate result, String input, String requestId) {
handler.post(new Runnable() {
@Override
public void run() {
}
});
}
@Override
public void onError(final TranslateErrorCode error, String requestId) {
handler.post(new Runnable() {
@Override
public void run() {
T
}
});
}
});
注意:
1.若查词和查句子都初始化了,则每次查询,先去词库中找,若找不到去句子库中查询
2.离线查词功能,词库支持放在assets目录下,此时需要将词库localdict.datx解压到对应目录下(解压得到三个文件),若是sd卡路径,开发者可以直接放置解压前或者解压后的文件。使用离线句子翻译前,请确定"离线句子\ce"文件夹下的2个文件夹,e2c和c2e在设置的离线路径中或者默认路径下是存在的。
3.useAutoConvertWord和useAutoConvertLine参数是指定是否自动识别中英文,若设置为true,则查询时自动忽略from和to参数,根据实际输入查询,若设置为false,则严格按照from和to参数返回查询结果
4.若想查询不常见的变形词,如,countries,请使用扩展词库。将wordlib.zip中的文件解压到中英词库同级目录。wordlib下的文件跟localdict.datx在同一级目录,不需要wordlib文件夹。当离线查询countries有查询结果时,说明扩展词库生效。
4.deeplink功能
说明:请参考 demo 中 TranslateDetailActivity
、HanyuActivity
查看更多功能的使用
SDK中查询结果 Translate
(英语单词、句子在线、离线查询返回结果类)和 ChDictTranslate
(汉语词典查询结果类)中提供了 openMore(Context context)
方法来实现查看更多的跳转,若用户安装词典则打开词典 app,否则打开词典移动 web 页面。
代码使用:
translate.openMore(context);
注意:若上面跳转逻辑不能满足开发需求,可调用
translate.getDictWebUrl()
方法得到对应的查词 web 页面地址
translate.openDict(context)
方法跳转到词典,若跳转成功,返回 true
,否则返回 false
下表为各语言对应代码:
语言 | 代码 |
---|---|
中文 | zh-CHS |
英文 | en |
日文 | ja |
韩文 | ko |
法文 | fr |
西班牙文 | es |
葡萄牙文 | pt |
意大利文 | it |
俄文 | ru |
越南文 | vi |
德文 | de |
阿拉伯文 | ar |
印尼文 | id |
南非荷兰语 | af |
波斯尼亚语 | bs |
保加利亚语 | bg |
粤语 | yue |
加泰隆语 | ca |
克罗地亚语 | hr |
捷克语 | cs |
丹麦语 | da |
荷兰语 | nl |
爱沙尼亚语 | et |
斐济语 | fj |
芬兰语 | fi |
希腊语 | el |
海地克里奥尔语 | ht |
希伯来语 | he |
印地语 | hi |
白苗语 | mww |
匈牙利语 | hu |
斯瓦希里语 | sw |
克林贡语 | tlh |
拉脱维亚语 | lv |
立陶宛语 | lt |
马来语 | ms |
马耳他语 | mt |
挪威语 | no |
波斯语 | fa |
波兰语 | pl |
克雷塔罗奥托米语 | otq |
罗马尼亚语 | ro |
塞尔维亚语(西里尔文) | sr-Cyrl |
塞尔维亚语(拉丁文) | sr-Latn |
斯洛伐克语 | sk |
斯洛文尼亚语 | sl |
瑞典语 | sv |
塔希提语 | ty |
泰语 | th |
汤加语 | to |
土耳其语 | tr |
乌克兰语 | uk |
乌尔都语 | ur |
威尔士语 | cy |
尤卡坦玛雅语 | yua |
阿尔巴尼亚语 | sq |
阿姆哈拉语 | am |
亚美尼亚语 | hy |
阿塞拜疆语 | az |
孟加拉语 | bn |
巴斯克语 | eu |
白俄罗斯语 | be |
宿务语 | ceb |
科西嘉语 | co |
世界语 | eo |
菲律宾语 | tl |
弗里西语 | fy |
加利西亚语 | gl |
格鲁吉亚语 | ka |
古吉拉特语 | gu |
豪萨语 | ha |
夏威夷语 | haw |
冰岛语 | is |
伊博语 | ig |
爱尔兰语 | ga |
爪哇语 | jw |
卡纳达语 | kn |
哈萨克语 | kk |
高棉语 | km |
库尔德语 | ku |
柯尔克孜语 | ky |
老挝语 | lo |
拉丁语 | la |
卢森堡语 | lb |
马其顿语 | mk |
马尔加什语 | mg |
马拉雅拉姆语 | ml |
毛利语 | mi |
马拉地语 | mr |
蒙古语 | mn |
缅甸语 | my |
尼泊尔语 | ne |
齐切瓦语 | ny |
普什图语 | ps |
旁遮普语 | pa |
萨摩亚语 | sm |
苏格兰盖尔语 | gd |
塞索托语 | st |
修纳语 | sn |
信德语 | sd |
僧伽罗语 | si |
索马里语 | so |
巽他语 | su |
塔吉克语 | tg |
泰米尔语 | ta |
泰卢固语 | te |
乌兹别克语 | uz |
南非科萨语 | xh |
意第绪语 | yi |
约鲁巴语 | yo |
南非祖鲁语 | zu |
自动识别 | auto |
其中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 | 超过最大请求字符数 |
4001 | 不支持的语音识别格式 |
4002 | 不支持的语音识别采样率 |
4003 | 不支持的语音识别声道 |
4004 | 不支持的语音上传类型 |
4005 | 不支持的语言类型 |
4006 | 识别音频文件过大 |
4007 | 识别音频时长过长 |
4201 | 解密失败 |
4301 | 语音识别失败 |
4303 | 服务的异常 |
4411 | 访问频率受限,请稍后访问 |
4412 | 超过最大请求时长 |
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 | 超过最大识别流量 |
11001 | 不支持的语音识别格式 |
11002 | 不支持的语音识别采样率 |
11003 | 不支持的语音识别声道 |
11004 | 不支持的语音上传类型 |
11005 | 不支持的语言类型 |
11006 | 识别音频文件过大 |
11007 | 识别音频时长过长,最大支持30s |
11201 | 解密失败 |
11301 | 语音识别失败 |
11303 | 服务的异常 |
11411 | 访问频率受限,请稍后访问 |
11412 | 超过最大请求时长 |
12001 | 图片尺寸过大 |
12002 | 图片base64解密失败 |
12003 | 引擎服务器返回错误 |
12004 | 图片为空 |
12005 | 不支持的识别图片类型 |
12006 | 图片无匹配结果 |
13001 | 不支持的角度类型 |
13002 | 不支持的文件类型 |
13003 | 表格识别图片过大 |
13004 | 文件为空 |
13301 | 表格识别失败 |
15001 | 需要图片 |
15002 | 图片过大(1M) |
15003 | 服务调用失败 |
17001 | 需要图片 |
17002 | 图片过大(1M) |
17003 | 识别类型未找到 |
17004 | 不支持的识别类型 |
17005 | 服务调用失败 |
-1000 | 未知错误 |
-2000 | 查询输入为空 |
1.运行程序崩溃?
检查下是否对应的 so
是否放到当前工程目录下。
2.翻译没结果?
检查下翻译接口回调的错误信息,保证申请的应用ID是有效且提前绑定了。
3.如何获得应用ID
注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和应用密钥等信息。
4.出现错误HTTP_REQUEST_ERROR("Http requesterror.",1)
在确保有网情况下,若调用过程中出现这个错误,HTTP_REQUEST_ERROR("Http requesterror.",1)
,请检查是否是在主线程中调用的翻译识别方法,请确保在主线程调用。
上线日期 | 版本号 | 更新内容 |
---|---|---|
2017.05.08 | v1.0.0 | 有道智云翻译 Android 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 2. demo 开发环境更改为 Android Studio |
2017.08.16 | v1.4.0 | 1. 修复已知 bug 2. 提供多版本的 so 文件 |
2017.11.16 | v1.5.0 | 1. 合并离线查词和句子翻译 2. 统一路径设置和结果回调 3. 支持非主线程调用 4. 离线查词和汉语词典,支持词库放在安装包 5. bug修复 |
2018.02.09 | v1.7.0 | 1. 新增每种词库不同路径初始化 2. 支持在线语音翻译 |
2018.04.26 | v1.7.1 | 1. 新增越南语和繁体中文 2. 支持在线语音翻译 3.修复查询结果from和to不对问题 |
2018.05.16 | v1.7.2 | 支持在线图片翻译 |
2019.11.05 | v2.0.0 | 兼容多个sdk同时使用 |