图片翻译 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),以便使用翻译服务。
翻译 sdk 由如下几个 sdk 组成,用户可根据需要组合使用:
| 文件 | 说明 |
|---|---|
| YoudaoBase_v20230803.jar | 翻译相关 sdk 基础库(必选) |
| online_auth.jar | 翻译相关 sdk 基础库(必选) |
| zhiyun_offline_common.jar | 翻译相关 sdk 基础库(必选) |
| YoudaoTranslateOnline_v2.0.1.jar | 在线翻译 sdk(必选) |
| YoudaotranslateDemo | sdk 使用 demo |
说明:无论使用何种功能,都需要加入 YoudaoBase_v20230803.jar,so 包和相应功能的 sdk,可组合使用。
集成步骤
(1) SDK 包导入
请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建),并将 YoudaoBase_v20230803.jar,so 包和 YoudaoTranslateOnline_v2.0.1.jar 拷贝到 libs 目录下,并将以下代码添加到 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')
}
(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" />
<!-- 往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/ YoudaoTranslateOnline_v2.0.1.jar
-keep class com.youdao.sdk.ydtranslate.** { *;}
-keep class com.youdao.sdk.ydonlinetranslate.** { *;}
(4) SDK 初始化
使用图片翻译 SDK,请在程序的 Application 中调用 SDK 初始化代码,可以参考 demo 中 DemoApplication。 注:appKey 即应用 ID
//appKey即应用ID
YouDaoApplication.init(this, appkey);
功能集成
说明:请参考 demo 中 OcrTranslateActivity 的使用
(1) 参数说明
from:表示源语言
to:表示目标语言
source:设置为 app 对应的名称(英文字符串)
timeout:表示超时时间
注意:输入图片数据需要转换为 Base64 编码。
(2) 构造图片翻译查词对象
代码如下:
String from = languageSelectFrom.getText().toString();
String to = languageSelectTo.getText().toString();
LanguageOcrTranslate langFrom = LanguageUtils.getLangByName_OCRTranslate(from);
LanguageOcrTranslate langTo = LanguageUtils.getLangByName_OCRTranslate(to);
OcrTranslateParameters ocrP = new OcrTranslateParameters.Builder()
.timeout(6000)//超时时间
.from(langFrom)//源语言
.to(langTo)//目标语言,目标语言不可以为auto
.serverRender(true) //使用server的图片渲染,直接返回渲染图片
.build();
(3) 设置回调和开始翻译
通过 OcrTranslate,设置上一步构造的查词对象,调用 lookup 方法传入图片 base64 编码的数据和回调接口开始查询,方法中最后一个参数"requestId",SDK 并未使用,在回调中会再返回给开发者,用于区分每次调用,开发者可传 null 或者任意字符串。
识别回调接口包含两个方法:onResult 表示识别成功,相关结果存储在 result 参数中,onError 表示失败,失败信息放在 TranslateErrorCode 枚举类中。
注意:整个识别是异步的,回调在子线程进行,若涉及到界面操作,请切回主线程。
OcrTranslate.getInstance(ocrP).lookup(base64, "requestid", new OcrTranslateListener() {
@Override
public void onError(TranslateErrorCode error, String requestId) {
}
@Override
public void onResult(OCRTranslateResult result, String input, String requestId) {
}
});
注:OCRTranslateResult.getRenderImage() 为服务端渲染好的图片的 base64
支持语言
下表为各语言对应代码:
| 英文名 | 中文名 | 代码 |
|---|---|---|
| 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 |
| Thai | 泰语 | th |
| Vietnamese | 越南语 | vi |
| 中文 | zh-CHS | |
| 中文繁体 | zh-CHT | |
| Afrikaans | 南非荷兰语 | af |
| 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 |
| Frisian | 弗里西语 | fy |
| Irish | 爱尔兰语 | ga |
| Scots | 苏格兰盖尔语 | gd |
| Galician | 加利西亚语 | gl |
| Gujarati | 古吉拉特语 | gu |
| Hausa | 豪萨语 | ha |
| Hawaiian | 夏威夷语 | haw |
| Hebrew | 希伯来语 | he |
| 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 |
| Myanmar (Burmese) | 缅甸语 | my |
| Nepali | 尼泊尔语 | ne |
| Norwegian | 挪威语 | no |
| Nyanja (Chichewa) | 齐切瓦语 | ny |
| 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 |
| Turkish | 土耳其语 | tr |
| Ukrainian | 乌克兰语 | uk |
| Urdu | 乌尔都语 | ur |
| Uzbek | 乌兹别克语 | uz |
| Yiddish | 意第绪语 | yi |
| Yoruba | 约鲁巴语 | yo |
| Cantonese (Traditional) | 粤语 | yue |
| Zulu | 南非祖鲁语 | zu |
| 自动识别 | 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.运行程序崩溃?
检查下是否对应的 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. 修复已知 bug2. 提供多版本的 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.01 | v2.0.0 | 兼容多个 sdk |
| 2023.08.07 | v2.0.1 | 更新语言 |