帮助与文档 > 产品文档 > 自然语言翻译服务 > Android_SDK文档 > 文本翻译
文本翻译

文本翻译 Android SDK 简介

概述

(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 设备

文本翻译 Android SDK集成指南

集成前提

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

集成步骤

(1) SDK包导入

请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建),并将以下jar包拷贝到 libs 目录下:

文件说明
YoudaoBase_v20230803.jar翻译相关sdk基础库(必选)
online_auth.jar翻译相关sdk基础库(必选)
zhiyun_offline_common.jar翻译相关sdk基础库(必选)
YoudaoCnDictOffline.jar汉语词典翻译sdk(可选,使用汉语词典功能时使用)
YoudaoTranslateOnline_v2.0.1.jar在线翻译sdk(可选,包含英汉互译,以及小语种翻译,在线查询)
YoudaoTranslateOffline.jar离线查词/翻译sdk(可选,中英单词和句子的离线查询)

将以下代码添加到app的build.gradle中:

android {
    sourceSets.main.jniLibs.srcDirs = ['libs']
    ...
}
dependencies {
    compile files('libs/YoudaoBase_v20230803.jar')
    compile files('libs/online_auth.jar')
    compile files('libs/zhiyun_offline_common.jar')
    compile files('libs/YoudaoTranslateOnline_v2.0.1.jar')
    compile files('libs/YoudaoCnDictOffline.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_v20230803.jar
-libraryjars libs/ YoudaoCnDictOffline.jar
-libraryjars libs/ YoudaoTranslateOnline_v2.0.1.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,appSecret);

功能集成

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, String requestId) {//查询成功

        }

        @Override
        public void onError(TranslateErrorCode error, String requestId) {//查询失败

        }

        @Override
        public void onResult(List<Translate> results, List<String> input, List<TranslateErrorCode> errors, String requestId) {//查询成功

        }
});

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 中 TranslateDetailActivityHanyuActivity 查看更多功能的使用

SDK中查询结果 Translate(英语单词、句子在线、离线查询返回结果类)和 ChDictTranslate(汉语词典查询结果类)中提供了 openMore(Context context)方法来实现查看更多的跳转,若用户安装词典则打开词典 app,否则打开词典移动 web 页面。

代码使用:

translate.openMore(context);

注意:若上面跳转逻辑不能满足开发需求,可调用

translate.getDictWebUrl() 方法得到对应的查词 web 页面地址

translate.openDict(context) 方法跳转到词典,若跳转成功,返回 true,否则返回 false

支持语言

下表为各语言对应代码:

英文名中文名代码
Arabic阿拉伯语ar
German德语de
English英语en
Spanish西班牙语es
French法语fr
Hindi印地语hi
Indonesian印度尼西亚语id
Italian意大利语it
Japanese日语ja
Korean韩语ko
Dutch荷兰语nl
Portuguese葡萄牙语pt
Russian俄语ru
hai泰语th
Vietnamese越南语vi
Chinese简体中文zh-CHS
Chinese繁体中文zh-CHT
Afrikaans南非荷兰语af
Amharic阿姆哈拉语am
Azeerbaijani阿塞拜疆语az
Belarusian白俄罗斯语be
Bulgarian保加利亚语bg
Bangla孟加拉语bn
Bosnian (Latin)波斯尼亚语bs
Catalan加泰隆语ca
Cebuano宿务语ceb
Corsican科西嘉语co
Czech捷克语cs
Welsh威尔士语cy
Danish丹麦语da
Greek希腊语el
Esperanto世界语eo
Estonian爱沙尼亚语et
Basque巴斯克语eu
Persian波斯语fa
Finnish芬兰语fi
Fijian斐济语fj
Frisian弗里西语fy
Irish爱尔兰语ga
Scots苏格兰盖尔语gd
Galician加利西亚语gl
Gujarati古吉拉特语gu
Hausa豪萨语ha
Hawaiian夏威夷语haw
Hebrew希伯来语he
Hindi印地语hi
Croatian克罗地亚语hr
Haitian海地克里奥尔语ht
Hungarian匈牙利语hu
Armenian亚美尼亚语hy
Igbo伊博语ig
Icelandic冰岛语is
Javanese爪哇语jw
Georgian格鲁吉亚语ka
Kazakh哈萨克语kk
Khmer高棉语km
Kannada卡纳达语kn
Kurdish库尔德语ku
Kyrgyz柯尔克孜语ky
Latin拉丁语la
Luxembourgish卢森堡语lb
Lao老挝语lo
Lithuanian立陶宛语lt
Latvian拉脱维亚语lv
Malagasy马尔加什语mg
Maori毛利语mi
Macedonian马其顿语mk
Malayalam马拉雅拉姆语ml
Mongolian蒙古语mn
Marathi马拉地语mr
Malay马来语ms
Maltese马耳他语mt
Hmong白苗语mww
Myanmar (Burmese)缅甸语my
Nepali尼泊尔语ne
Dutch荷兰语nl
Norwegian挪威语no
Nyanja (Chichewa)齐切瓦语ny
Querétaro Otomi克雷塔罗奥托米语otq
Punjabi旁遮普语pa
Polish波兰语pl
Pashto普什图语ps
Romanian罗马尼亚语ro
Sindhi信德语sd
Sinhala (Sinhalese)僧伽罗语si
Slovak斯洛伐克语sk
Slovenian斯洛文尼亚语sl
Samoan萨摩亚语sm
Shona修纳语sn
Somali索马里语so
Albanian阿尔巴尼亚语sq
Serbian (Cyrillic)塞尔维亚语(西里尔文)sr-Cyrl
Serbian (Latin)塞尔维亚语(拉丁文)sr-Latn
Sesotho塞索托语st
Sundanese巽他语su
Swedish瑞典语sv
Kiswahili斯瓦希里语sw
Tamil泰米尔语ta
Telugu泰卢固语te
Tajik塔吉克语tg
Filipino菲律宾语tl
Klingon克林贡语tlh
Tongan汤加语to
Turkish土耳其语tr
Tahitian塔希提语ty
Ukrainian乌克兰语uk
Urdu乌尔都语ur
Uzbek乌兹别克语uz
Xhosa南非科萨语xh
Yiddish意第绪语yi
Yoruba约鲁巴语yo
Yucatec尤卡坦玛雅语yua
Cantonese (Traditional)粤语yue
Zulu南非祖鲁语zu
自动识别auto

注意:
其中auto可以识别中文、英文、日文、韩文、法文、西班牙文、葡萄牙文、俄文、越南文、德文、阿拉伯文、印尼文、意大利文,其他语种无法识别,为提高准确率,请指定语种。

错误代码列表

错误码含义
101缺少必填的参数
102不支持的语言类型
103翻译文本过长
104不支持的API类型
105不支持的签名类型
106不支持的响应类型
107不支持的传输加密类型
108应用ID无效,注册账号,登录后台创建应用和实例并完成绑定,可获得应用ID和应用密钥等信息
109batchLog格式不正确
110无相关服务的有效实例
111开发者账号无效
113q不能为空
114不支持的图片传输方式
201解密失败,可能为DES,BASE64,URLDecode的错误
202签名检验失败
203访问IP地址不在可访问IP列表
205请求的接口与应用的平台类型不一致,如有疑问请参考入门指南
206因为时间戳无效导致签名校验失败
207重放请求
301辞典查询失败
302翻译查询失败
303服务端的其它异常
304会话闲置太久超时
401账户已经欠费停
402offlinesdk不可用
411访问频率受限,请稍后访问
412长请求过于频繁,请稍后访问
1001无效的OCR类型
1002不支持的OCR image类型
1003不支持的OCR Language类型
1004识别图片过大
1201图片base64解密失败
1301OCR段落识别失败
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解密失败
5301OCR段落识别失败
5411访问频率受限
5412超过最大识别流量
9001不支持的语音格式
9002不支持的语音采样率
9003不支持的语音声道
9004不支持的语音上传类型
9005不支持的语音识别 Language类型
9301ASR识别失败
9303服务器内部错误
9411访问频率受限(超过最大调用次数)
9412超过最大处理语音长度
10001无效的OCR类型
10002不支持的OCR image类型
10004识别图片过大
10201图片base64解密失败
10301OCR段落识别失败
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.08v1.0.0有道智云翻译 Android SDK上线,支持在线离线翻译
2017.06.07v1.1.01. 拆分翻译 SDK,SDK 拆分为多个文件,用户可根据需要引用
  1. 修复已知 bug|
    |2017.06.30 |v1.2.0 |修复已知 bug|

|2017.07.24 |v1.3.0 |1. 修复 deeplink 相关 bug

  1. demo 开发环境更改为 Android Studio|
    |2017.08.16 |v1.4.0 |1. 修复已知 bug
  2. 提供多版本的 so 文件|
    |2017.11.16 |v1.5.0 |1. 合并离线查词和句子翻译
  3. 统一路径设置和结果回调
  4. 支持非主线程调用
  5. 离线查词和汉语词典,支持词库放在安装包
  6. bug修复|
    |2018.02.09 |v1.7.0 |1. 新增每种词库不同路径初始化
  7. 支持在线语音翻译|
    |2018.04.26 |v1.7.1 |1. 新增越南语和繁体中文
  8. 支持在线语音翻译
    3.修复查询结果from和to不对问题|

|2018.05.16 |v1.7.2 |支持在线图片翻译|
|2019.11.05 |v2.0.0 |兼容多个sdk同时使用|
|2023.08.07 |v2.0.0 |升级sdk|