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

有道智云文本翻译 Android SDK 文档

有道智云文本翻译 SDK 简介

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

通过SDK接入优势:

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

集成前提

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

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

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

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

SDK 集成步骤

1. 添加相应 jar 包和 so 文件

在工程目录下,创建一个名为libs的子目录,将相应包拷贝到此目录下。

对于 Android Studio 工程,请参照下面的步骤添加 JAR 包:

  1. 右击你的工程并选择“Open Module Settings”
  2. 在左侧面板中选择你的app
  3. 在主窗口中选择“Dependencies”页签
  4. 点击“+”按钮
  5. 选择”File Depndency”
  6. 选择您拷贝到libs 目录下的jar
  7. 添加so文件:在模块的配置文件中增加jni配置

    `sourceSets.main.jniLibs.srcDirs = ['libs']`
  8. 添加代码混淆文件,避免 jar 的二次混淆

代码混淆文件proguard-project.txt,添加如下内容:

-ignorewarnings
-libraryjars libs/ YoudaoBase.jar
-libraryjars libs/ YoudaoCnDictOffline.jar
-libraryjars libs/ YoudaoTranslateOnline.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.** { *;}

2. 权限添加

<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. 功能集成说明

3.1 离线汉语词典查词功能

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

使用的jar:

YoudaoBase.jarYoudaoCnDictOffline.jar

代码添加:

//注册应用ID ,建议在应用启动时,初始化,所有功能的使用都需要该初始化,调用一次即可,demo中在MainActivity类中
YouDaoApplication.init(this, appkey);


//查词对象初始化
/*
 * 可以查词之前设置离线词库路径,则采用默认路径Environment
 *   .getExternalStorageDirectory().getPath() + "/yuwen/backup/"
 * 请确保设置的路径或者默认路径下包含汉语词典的离线包
 */
chDictor = new ChDictor();
//chDictor = new ChDictor(dictFilePath); //表示Environment.getExternalStorageDirectory().getAbsolutePath() + dictFilePath路径下存在离线库


//开始查询
//注意,每次查询之前都需要初始化
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 在设置的路径或者默认路径下

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

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

使用的jar:

YoudaoBase.jarYoudaoTranslateOnline.jar

代码添加:

//注册应用ID ,建议在应用启动时,初始化,所有功能的使用都需要该初始化,调用一次即可,demo中在TranslateActivity类中
YouDaoApplication.init(this, appkey);


//查词对象初始化,请设置source参数为app对应的名称(英文字符串)
Language langFrom = LanguageUtils.getLangByName("中文");
//若设置为自动,则查询自动识别源语言,自动识别不能保证完全正确,最好传源语言类型
//Language langFrom = LanguageUtils.getLangByName("自动");
Language langTo = LanguageUtils.getLangByName("英文");

TranslateParameters tps = new TranslateParameters.Builder()
       .source("ydtranslate-demo")
       .from(langFrom).to(langTo).build();

translator = Translator.getInstance(tps);


//查询,返回两种情况,一种是成功,相关结果存储在result参数中,另外一种是失败,失败信息放在TranslateErrorCode中,TranslateErrorCode是一个枚举类,整个查询是异步的,为了简化操作,回调都是在主线程发生。

translator.lookup(input, "requestId", new TranslateListener() {

        @Override
        public void onResult(Translate result, String input) {//查询成功

        }

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

        }
});

3.3 离线查词、句子翻译

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

使用的jar:
YoudaoBase.jarYoudaoTranslateOffline.jar

代码添加:

1.注册应用ID ,建议在应用启动时,初始化,所有功能的使用都需要该初始化,调用一次即可,demo中在TranslateActivity类中

YouDaoApplication.init(this, appkey);

2.查词对象初始化

translatorOffline = new TranslatorOffline();

3.初始化词库和句子库,其中:
(1)若使用离线查词,请通过方式一、方式二或者方式三初始化词库,三种方式只能选择一种;
(2)若使用离线句子查询,请初始化离线句子库;
(3)若查词和查句子都初始化了,则每次查询,先去词库中找,若找不到去句子库中查询

初始化词库方式一,词库在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){

            }
        });

初始化离线句子库

        translatorOffline.initLineDict(Environment.getExternalStorageDirectory().getAbsolutePath() + "/Youdao/Translator/transdata/data/ce2");

获取词库是否初始化成功

//        translatorOffline.isLineInited();
//        translatorOffline.isWordInited();

4.执行查询

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
            }
        });
    }
});

注意:
离线查词功能,词库支持放在assets目录下,此时需要将词库localdict.datx解压到对应目录下(解压得到三个文件),若是sd卡路径,开发者可以直接放置解压前或者解压后的文件。使用离线句子翻译前,请确定"离线句子ce"文件夹下的2个文件夹,e2c和c2e在设置的离线路径中或者默认路径下是存在的。
useAutoConvertWord和useAutoConvertLine参数是指定是否自动识别中英文,若设置为true,则查询时自动忽略from和to参数,根据实际输入查询,若设置为false,则严格按照from和to参数返回查询结果

若想查询不常见的变形词,如,countries,请使用扩展词库。将wordlib.zip中的文件解压到中英词库同级目录。wordlib下的文件跟localdict.datx在同一级目录,不需要wordlib文件夹。当离线查询countries有查询结果时,说明扩展词库生效。

3.4 deeplink 的使用

说明:请参考 demo 中 TranslateDetailActivityHanyuActivity 查看更多功能的使用

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

代码使用:

translate.openMore(context);

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

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

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

常见问题及注意事项

  1. 运行程序崩溃?
    检查下是否对应的 so 是否放到当前工程目录下。
  2. 翻译没结果?
    检查下翻译接口回调的错误信息,保证申请的 appKey 是有效且提前绑定了。
  3. 如何获得 appKey
    注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)。
  4. 在确保有网情况下,若调用过程中出现这个错误,HTTP_REQUEST_ERROR("Http requesterror.",1) ,请检查是否是在主线程中调用的翻译识别方法,请确保在主线程调用。

支持语言

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

错误代码列表

错误码含义
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账户已经欠费

版本更新记录

上线日期版本号更新内容
2017.05.08v1.0.0有道智云翻译 Android SDK上线,支持在线离线翻译
2017.06.07v1.1.01. 拆分翻译 SDK,SDK 拆分为多个文件,用户可根据需要引用
2. 修复已知 bug
2017.06.30v1.2.0修复已知 bug
2017.07.24v1.3.01. 修复 deeplink 相关 bug
2. demo 开发环境更改为 Android Studio
2017.08.16v1.4.01. 修复已知 bug
2. 提供多版本的 so 文件
2017.11.16v1.5.01. 合并离线查词和句子翻译
2. 统一路径设置和结果回调
3. 支持非主线程调用
4. 离线查词和汉语词典,支持词库放在安装包
5. bug修复
2018.02.09v1.7.01. 新增每种词库不同路径初始化
2. 支持在线语音翻译

有道智云语音翻译 Android SDK 文档

有道智云语音翻译 SDK 简介

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

通过SDK接入优势:

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

集成前提

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

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

文件说明
YoudaoBase.jar翻译相关sdk基础库(必选)
YoudaoTranslateOnline.jar(必选),同在线翻译sdk)
YoudaotranslateDemosdk使用demo

SDK 集成步骤

1. 添加相应 jar 包和 so 文件

在工程目录下,创建一个名为libs的子目录,将相应包拷贝到此目录下。

对于 Android Studio 工程,请参照下面的步骤添加 JAR 包:

  1. 右击你的工程并选择“Open Module Settings”
  2. 在左侧面板中选择你的app
  3. 在主窗口中选择“Dependencies”页签
  4. 点击“+”按钮
  5. 选择”File Depndency”
  6. 选择您拷贝到libs 目录下的jar
  7. 添加so文件:在模块的配置文件中增加jni配置

    `sourceSets.main.jniLibs.srcDirs = ['libs']`
  8. 添加代码混淆文件,避免 jar 的二次混淆

代码混淆文件proguard-project.txt,添加如下内容:

-ignorewarnings
-libraryjars libs/ YoudaoBase.jar
-libraryjars libs/ YoudaoTranslateOnline.jar

-keep class com.youdao.sdk.ydtranslate.** { *;}
-keep class com.youdao.sdk.ydonlinetranslate.** { *;}

2. 权限添加

<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. 功能集成说明

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

使用的jar:

YoudaoBase.jarYoudaoTranslateOnline.jar

代码添加:

1.注册应用ID ,建议在应用启动时,初始化,所有功能的使用都需要该初始化,调用一次即可,demo中在TranslateActivity类中

YouDaoApplication.init(this, appkey);

2.查词对象初始化,请设置source参数为app对应的名称(英文字符串)

     SpeechTranslateParameters tps = new SpeechTranslateParameters.Builder().source("youdaovoicetranslate")
        .from(Language.CHINESE).to(Language.ENGLISH)
        .format(SpeechTranslateParameters.SOUND_INPUT_PCM)//输入音频格式,支持pcm和war
        .rate(SpeechTranslateParameters.RATE_8000)//输入音频码率,支持8000,16000
        .sound(SpeechTranslateParameters.SOUND_OUTPUT_MP3)//输出语音格式,支持wav
        .voice(SpeechTranslateParameters.VOICE_GIRL_US)//输出声音,支持美式女生、美式男生、英式女生、英式男生
        .timeout(100000)//超时时间
        .build();

3.执行查询,返回两种情况,一种是成功,相关结果存储在result参数中,另外一种是失败,失败信息放在TranslateErrorCode 中,TranslateErrorCode 是一个枚举类,整个查询是异步的,回调在子线程进行,若涉及到界面操作,请切回主线程

SpeechTranslate.getInstance(tps).lookup(bases64,
                new TranslateListener() {
                    @Override
                    public void onResult(final Translate result, String input, String requestId) {
                        handler.post(new Runnable() {
                            @Override
                            public void run() {
                                resultText.setText("翻译完成:" + result.getQuery());
                                tr = result;
                                toDetail.setVisibility(View.VISIBLE);
                            }
                        });
                    }

                    @Override
                    public void onError(final TranslateErrorCode error, String requestId) {
                        handler.post(new Runnable() {
                            @Override
                            public void run() {
                                tr = null;
                                resultText.setText("翻译失败" + error.toString());
                                toDetail.setVisibility(View.GONE);
                            }
                        });
                    }
                }, "requestId");

常见问题及注意事项

  1. 运行程序崩溃?
    检查下是否对应的 so 是否放到当前工程目录下。
  2. 翻译没结果?
    检查下翻译接口回调的错误信息,保证申请的 appKey 是有效且提前绑定了。
  3. 如何获得 appKey
    注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和密钥等信息,其中应用ID就是appKey( 注意不是应用密钥)。
  4. 在确保有网情况下,若调用过程中出现这个错误,HTTP_REQUEST_ERROR("Http requesterror.",1) ,请检查是否是在主线程中调用的翻译识别方法,请确保在主线程调用。

支持语言

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

错误代码列表

错误码含义
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账户已经欠费
402offlinesdk不可用
411访问频率受限,请稍后访问
412超过最大请求字符数
3001不支持的语音格式
3002不支持的语音采样率
3003不支持的语音声道
3004不支持的语音上传类型
3005不支持的语言类型
3006不支持的识别类型
3007识别音频文件过大
3008识别音频时长过长
3009不支持的音频文件类型
3010不支持的发音类型
3201解密失败
3301语音识别失败
3302语音翻译失败
3303服务的异常
3411访问频率受限,请稍后访问
3412超过最大请求字符数

版本更新记录

上线日期版本号更新内容
2018.01.03v1.7.0支持在线语音翻译
 
有道智云平台介绍
网易有道旗下一个为开发者、企业和政府机构等提供自然语言翻译、文字识别OCR等服务以及行业解决方案的云服务平台,致力于提供安全、可靠和高效的云服务。
联系方式
联系电话:010-8255-8901
商务合作:
投诉反馈:
地址:北京市海淀区西北旺东路10号院 中关村软件园二期西区7号 网易(北京)公司
微信公众号
 
 
 
©2017 网易公司 京ICP证080268号