API文档
产品定价
(1) 概念解释
短语音识别:将一段不超过15秒的语音转换成文本,将音频文件中的文字信息识别出来,代替传统输入场景。
(2) 说明
Hi,您好,欢迎使用有道智云短语音识别Android SDK。
如果您想快速体验服务,建议您前往 语音识别体验中心 或者在体验中心右下侧找到小程序二维码,扫描进行体验。
本文档主要针对需要集成短语音识别服务Android SDK的开发工程师,详细描述有道智云短语音识别能力及集成过程。
如果您有与我们商务合作的需求,可以通过以下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云语音技术交流QQ群:861723255
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建 Android 应用,并绑定实例;如果您还没有,请按照 新手指南 操作。 平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 短语音识别服务报价 。
有道短语音识别sdk是对有道的短语音识别服务的封装。提供识别类SpeechTranslate,您只需要通过调用sdk接口,传入待识别的音频文件和格式,即可进行语音的识别。
支持设备:运行了 Android 4.0.3以及以上系统的 Android 设备
开始集成SDK之前开发者需要登录 有道智云平台 ,创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用短语音识别服务。
语音识别sdk由如下sdk组成:
| 文件 | 说明 |
|---|---|
| YoudaoBase_v2.0.0.jar | 有道智云相关sdk基础库(必选) |
| YoudaoVoiceRecognize_v2.0.0.jar | 在线语音识别sdk(必选) |
| yd-voicerecognize-demo | sdk语音识别使用demo |
(1) SDK包导入
请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建),并将YoudaoBase_v2.0.0.jar so包和YoudaoVoiceRecognize_v2.0.0.jar拷贝到 libs 目录下,并将以下代码添加到app的build.gradle中:
android {
sourceSets.main.jniLibs.srcDirs = ['libs']
...
}
dependencies {
compile files('libs/YoudaoBase_v2.0.0.jar')
compile files('libs/YoudaoVoiceRecognize_v2.0.0.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/YoudaoVoiceRecognize_v2.0.0.jar
-keep class com.youdao.sdk.ydtranslate.** { *;}
-keep class com.youdao.voicerecognize.online.** { *;}
(4) SDK初始化
使用短语音识别SDK,请在程序的Application中调用SDK初始化代码,可以参考demo中DemoApplication。
YouDaoApplication.init(this, appkey);
说明:请参考 demo 中 RecognizeDemoActivity 的使用
(1) 参数说明
格式支持:wav(不压缩,pcm编码,采样率:推荐16k ,编码:16bit位深的单声道),aac,mp3
source:设置为app对应的名称(英文字符串)
注意:输入语音数据需要转换为Base64编码。
(2) 构造短语音识别输入对象
//输入音频为WAV格式
ASRParameters tps = new ASRParameters.Builder()
.source("youdaoocr")
.timeout(100000)
.lanType(Language.ENGLISH.getCode())//langType支持中文和英文
.rate(Constants.RATE_8000)
.build();
(3) 设置回调和开始识别
通过SpeechTranslate,设置上一步构造的查词对象,调用lookup方法传入语音base64编码的数据和回调接口开始查询,方法中最后一个参数"requestId",SDK并未使用,在回调中会再返回给开发者,用于区分每次调用,开发者可传null或者任意字符串。
识别回调接口包含两个方法:onResult表示识别成功,相关结果存储在result参数中,onError表示失败,失败信息可根据错误码通过 错误代码列表 查看。
注意:整个识别是异步的,回调在子线程进行,若涉及到界面操作,请切回主线程。
SpeechTranslate.getInstance(tps).recognize(bases64,"requestId"
new ASRListener() {
@Override
public void onResult(final ASRResult result, String input, String requestid) {
handler.post(new Runnable() {
@Override
public void run() {
if(result.getResult() != null && result.getResult().size() > 0){
resultText.setText("识别完成:" +result.getResult().get(0));
}else{
resultText.setText("未知错误");
}
}
});
}
@Override
public void onError(final ASRErrorCode error, String requestid) {
handler.post(new Runnable() {
@Override
public void run() {
resultText.setText("识别失败" + error.toString());
}
});
}
}, "requestid");
对于在线语音识别,服务器查询结果返回数据如下:
{
"result": [
"今天天气不错" //识别结果
],
"errorCode": "0", //错误码。一定存在
}
| 字段 | 含义 |
|---|---|
| result | 识别结果发音地址,识别成功一定存在 |
| errorCode | 识别结果错误码,一定存在。详见 错误代码列表 |
| 英文名 | 中文名 | 代码 |
|---|---|---|
| Arabic | 阿拉伯语 | ar |
| Bahasa (Indonesia) | 巴哈萨语(印度尼西亚) | in |
| Cantonese | 粤语 | yue |
| Catalan | 加泰隆语 | ca |
| Czech | 捷克语 | cs |
| Danish | 丹麦语 | da |
| Dutch | 荷兰语 | nl |
| Dutch (Belgium) | 荷兰语(比利时) | nl-BEL |
| English (Australia) | 英语(澳大利亚) | en-AUS |
| English (GB) | 英语(英国) | en-GBR |
| English (India) | 英语(印度) | en-IND |
| English (Ireland) | 英语(爱尔兰) | en-IRL |
| English (Scotland) | 英语(苏格兰) | en-SCT |
| English (South Africa) | 英语(南非) | en-ZAF |
| English (US) | 英语(美国) | en |
| Finnish | 芬兰语 | fi |
| French | 法语 | fr |
| French (Canada) | 法语(加拿大) | fr-CAN |
| German | 德语 | de |
| Greek | 希腊语 | el |
| Hebrew | 希伯来语 | he |
| Hindi | 印地语 | hi |
| Hungarian | 匈牙利语 | hu |
| Italian | 意大利语 | it |
| Japanese | 日语 | ja |
| Korean | 韩语 | ko |
| Mandarin (China) | 普通话(中国) | zh-CHS |
| Mandarin (Taiwan) | 普通话(中国台湾) | zh-TWN |
| Norwegian | 挪威语 | no |
| Polish | 波兰语 | pl |
| Portuguese (Brazil) | 葡萄牙语(巴西) | pt-BRA |
| Portuguese (Portugal) | 葡萄牙语(葡萄牙) | pt |
| Romanian | 罗马尼亚语 | ro |
| Russian | 俄语 | ru |
| Slovak | 斯洛伐克语 | sk |
| Spanish (Castilian) | 西班牙语(卡斯蒂利亚) | es-ESP |
| Spanish (Columbia) | 西班牙语(哥伦比亚) | es-COL |
| Spanish (Mexico) | 西班牙语(墨西哥) | es-MEX |
| Swedish | 瑞典语 | sv |
| Thai | 泰语 | th |
| Turkish | 土耳其语 | tr |
| Valencian | 巴伦西亚语 | spa-ESP |
| 错误码 | 含义 |
|---|---|
| 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 | 超过最大请求时长 |
| 4414 | 音频格式转换失败 |
| 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) ,请检查是否是在主线程中调用的翻译识别方法,请确保在主线程调用。
| 上线日期 | 版本号 | 更新内容 |
|---|---|---|
| 2018.03.28 | v1.0.0 | 支持在线语音语音识别 |
| 2019.11.05 | v2.0.0 | 兼容多个sdk冲突问题 |