API文档
IOS_SDK文档
SDK隐私政策
(1) 概念解释 精品题库:基于文字识别技术,结合组段和渲染技术,满足用户的需求。
(2) 说明 Hi,您好,欢迎使用有道智云精品题库 Android SDK。如果您想快速体验服务,建议您前往 精品题库体验中心 或者在体验中心页面的右下角找到小程序二维码,扫描进行体验。
本文档主要针对需要集成精品题库服务 Android SDK的开发工程师,详细描述有道智云精品题库能力及集成过程。
如果您有与我们商务合作的需求,可以通过一下方式联系我们:
商务邮箱: AIcloud_Business@corp.youdao.com
如果您对文档内容有任何疑问,可以通过以下几种方式联系我们:
客服QQ:1906538062
智云精品题库交流QQ群:685832941
联系邮箱: zhiyun@corp.youdao.com
温馨提示:
本文档主要针对开发人员,接入测试前需要在后台创建Android应用,并绑定精品题库应用;如果您还没有,请按照 新手指南 操作。 平台向每个账户赠送50元的体验金,供用户集成前测试所用,具体资费规则详见 精品题库服务报价 。
有道精品题库 SDK 是有道智云开放平台提供的云服务之一,是有道在线精品题库接口的一种实现。
支持设备:运行了 Android 4.0.3及以上系统的 Android 设备
开始集成SDK之前开发者需要登录 有道智云平台 , 创建应用获取应用ID(或者通过运营人员获取应用ID),以便使用精品题库服务。 图片支持: 格式支持:jpg/png/bmp 尺寸限制:1MB以下
1. SDK 包导入
请在工程文件根目录下创建一个名为 libs 的子目录(有的话则不需要创建),并将YoudaoBase.jar和Youdao.jar拷贝到 libs 目录下,并将以下代码添加到app的build.gradle中:
android {
sourceSets.main.jniLibs.srcDirs = ['libs']
...
}
dependencies {
implementation files('libs/YoudaoBase_v2.0.0.jar')
implementation files('libs/YoudaoOCRQuestionOnline_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/YoudaoOCRQuestionOnline_v2.0.0.jar
-keep class com.youdao.sdk.ydtranslate.** { *;}
-keep class com.youdao.ocr.question.** { *;}
4 .SDK初始化
使用精品题库请在程序的Application中调用SDK初始化代码,可以参考demo中DemoApplication
YouDaoApplication.init(this, appkey);
1 .构造识别输入对象
请设置 packageName 参数为对应的包名
OCRParameters tps = new OCRParameters.Builder().timeout(100000).packageName("com.youdao.com").build();
2 .将图片转化成base64编码
String base64 = EncryptHelper.getBase64(datas);
3 .设置回调,开始搜索
设置回调接口包含两个方法:onResult表示识别成功,相关结果存储在result参数中,onError表示失败,失败信息放在OcrErrorCode是一个枚举类中。
注意:整个识别是异步的,回调在子线程进行,若涉及到界面操作,请切回主线程。
SearchingImageQuestion.getInstance(tps).startSearching(base64, new OCRListener() {
@Override
public void onError(final OcrErrorCode error) {
handler.post(new Runnable() {
@Override
public void run() {
Toast.makeText(MainActivity.this, error.toString(), Toast.LENGTH_LONG).show();
tip.setText("搜索完毕");
}
});
}
@Override
public void onResult(final String result) {
handler.post(new Runnable() {
@Override
public void run() {
tip.setText("搜索完毕");
ShowResultActivity.go(MainActivity.this, result);
}
});
}
});
响应结果是以json形式输出,包含字段如下表所示:
| 字段 | 含义 |
|---|---|
| errorCode | 识别结果错误码,一定存在。 详细信息可参见 错误代码列表 |
| data | 数据 |
| questions | 相关题目 |
| answer | 答案 |
| id | 答案 |
| analysis | 解析 |
| content | 题目内容 |
| knowledge | 知识点 |
| text | 图片题目OCR结果 |
对于在线题目检索,查询结果返回数据如下:
{
"data": {
"questions": [{
"answer": "D.<br />根据题意画出图形.<br /><img src=\"http://nos.netease.com/yd-searchq/d2c51ea9-0ce4-4e7c-810e-df62c67cc5e3.jpg\" /><br />∵BE平分∠ABC,ED⊥AB,∠C=90°,<br />∴DE=CE.<br />∵AC=AE+CE=6cm,CE=DE,<br />∴AE+DE=6cm.<br />故选D.",
"id": "922b5db8c01ab894c9ed81130e875a07",
"analysis": "",
"content": "在△ABC的中,∠C=90°,BE平分∠ABC,ED⊥AB于D,若AC=6cm,则AE+DE=()<br />A.3cm <br />B.4cm <br />C.5cm <br />D.6cm",
"knowledge": "角平分线上的点到两边的距离相等"
}, {
"answer": "D",
"id": "3f74f1b9db7fbdb9ef4f3be1e640174d",
"analysis": "∵BE平分∠ABC,ED⊥AB,EC⊥BC∴DE=CE<br />∴AE+DE=AE+EC=AC=6cm.<br />故选D.",
"content": "如图所示,在△ABC中,∠C=90°,BE平分∠ABC,ED⊥AB于点D,若AC=6cm,则AE+DE=( )<br/>A. 3cm<br/>B. 4cm<br/>C. 5cm<br/>D. 6cm<br /><img width=\"190\" height=\"110\" src=\"http://nos.netease.com/yd-searchq/bd8adeb1-db1a-48fd-a4ef-07897640ddb6.gif\" />",
"knowledge": ""
}, {
"answer": "<p>D</p>",
"id": "49b8fa87db38bf6004e205050eb9c548",
"analysis": "",
"content": "<p>如图,在 ABC中, ∠C=90°, BE平分∠ABC, ED⊥AB于点D.若AC=6cm,则AE+DE等于( )</p><p>A3cm </p><p>B.4cm </p><p>C.5cm </p><p>D.6 cm</p><p><img src=\"http://nos.netease.com/yd-searchq/6c868298-235a-4eb6-bc3b-06ec5ecd937c.png\" title=\"1530979476605.png\" alt=\"2.png\"/></p>",
"knowledge": ""
}],
"text": "如-3-9所示, , 在 ABC中,∠C=90^ ,BE平分∠ABC,ED ABFD, , , 若AC=6cm,则AHE+DE= ADB -3-9"
},
"errorCode": "0"
}
1.运行程序崩溃?
检查下是否对应的 so 是否放到当前工程目录下。
2.如何获得应用ID 注册账号, 登录后台创建应用和实例并完成绑定, 可获得应用ID和应用密钥等信息。
| 错误码 | 含义 |
|---|---|
| 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 | 不支持的识别图片类型 |
| 13001 | 不支持的角度类型 |
| 13002 | 不支持的文件类型 |
| 13003 | 表格识别图片过大 |
| 13004 | 文件为空 |
| 13301 | 表格识别失败 |
| 17001 | 需要图片 |
| 17002 | 图片过大(1M) |
| 17003 | 识别类型未找到 |
| 17004 | 不支持的识别类型 |
| 17005 | 服务调用失败 |
| -1000 | 未知错误 |
| -2000 | 查询输入为空 |
http://ydschool-online.nos.netease.com/15338062758120238_12000960102.jpg
http://ydschool-online.nos.netease.com/1542701989646test.png
http://ydschool-online.nos.netease.com/1542703851482WX20181120-165038%402x.png
http://ydschool-online.nos.netease.com/15427039802392.png
http://ydschool-online.nos.netease.com/154270403620010.png
http://ydschool-online.nos.netease.com/15427040781763.png
http://ydschool-online.nos.netease.com/1543828384827WechatIMG112.png
| 上线日期 | 版本号 | 更新内容 |
|---|---|---|
| 2019.02.20 | v1.0.0 | 支持在线题目检索 |
| 题目检索9.11.05 | v2.0.0 | 兼容多个sdk共用 |