精品題庫 Android SDK 簡介
概述
(1) 概念解釋
精品題庫:基于文字識別技術(shù),結(jié)合組段和渲染技術(shù),滿足用戶的需求。
(2) 說明
Hi,您好,歡迎使用有道智云精品題庫 Android SDK。如果您想快速體驗服務(wù),建議您前往 精品題庫體驗中心 或者在體驗中心頁面的右下角找到小程序二維碼,掃描進(jìn)行體驗。
本文檔主要針對需要集成精品題庫服務(wù) Android SDK的開發(fā)工程師,詳細(xì)描述有道智云精品題庫能力及集成過程。
如果您有與我們商務(wù)合作的需求,可以通過一下方式聯(lián)系我們:
商務(wù)郵箱: AIcloud_Business@corp.youdao.com
如果您對文檔內(nèi)容有任何疑問,可以通過以下幾種方式聯(lián)系我們:
客服QQ:1906538062
智云精品題庫交流QQ群:685832941
聯(lián)系郵箱: zhiyun@corp.youdao.com
溫馨提示:
本文檔主要針對開發(fā)人員,接入測試前需要在后臺創(chuàng)建Android應(yīng)用,并綁定精品題庫應(yīng)用;如果您還沒有,請按照 新手指南 操作。
平臺向每個賬戶贈送50元的體驗金,供用戶集成前測試所用,具體資費規(guī)則詳見 精品題庫服務(wù)報價 。
功能介紹
有道精品題庫 SDK 是有道智云開放平臺提供的云服務(wù)之一,是有道在線精品題庫接口的一種實現(xiàn)。
兼容性
支持設(shè)備:運行了 Android 4.0.3及以上系統(tǒng)的 Android 設(shè)備
精品題庫 SDK 集成指南
集成前提
開始集成SDK之前開發(fā)者需要登錄 有道智云平臺 , 創(chuàng)建應(yīng)用獲取應(yīng)用ID(或者通過運營人員獲取應(yīng)用ID),以便使用精品題庫服務(wù)。
圖片支持:
格式支持:jpg/png/bmp
尺寸限制:1MB以下
集成步驟
1. SDK 包導(dǎo)入
請在工程文件根目錄下創(chuàng)建一個名為 libs 的子目錄(有的話則不需要創(chuàng)建),并將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配置
添加權(quán)限
<uses-permission android:name="android.permission.INTERNET" />
<!-- 獲取WiFi狀態(tài) -->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<!-- 獲取網(wǎng)絡(luò)信息狀態(tài),如當(dāng)前的網(wǎng)絡(luò)連接是否有效 -->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<!-- 讀取手機(jī)狀態(tài) phone group -->
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<!-- 往SDCard讀寫數(shù)據(jù)權(quán)限 storage group -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
3 .代碼混淆配置
代碼混淆文件proguard-project.txt,添加如下內(nèi)容
-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中調(diào)用SDK初始化代碼,可以參考demo中DemoApplication
YouDaoApplication.init(this, appkey);
功能集成
1 .構(gòu)造識別輸入對象
請設(shè)置 packageName 參數(shù)為對應(yīng)的包名
OCRParameters tps = new OCRParameters.Builder().timeout(100000).packageName("com.youdao.com").build();
2 .將圖片轉(zhuǎn)化成base64編碼
String base64 = EncryptHelper.getBase64(datas);
3 .設(shè)置回調(diào),開始搜索
設(shè)置回調(diào)接口包含兩個方法:onResult表示識別成功,相關(guān)結(jié)果存儲在result參數(shù)中,onError表示失敗,失敗信息放在OcrErrorCode是一個枚舉類中。
注意:整個識別是異步的,回調(diào)在子線程進(jìn)行,若涉及到界面操作,請切回主線程。
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);
}
});
}
});
搜題結(jié)果說明
響應(yīng)結(jié)果是以json形式輸出,包含字段如下表所示:
字段 | 含義 |
---|
errorCode | 識別結(jié)果錯誤碼,一定存在。 詳細(xì)信息可參見 錯誤代碼列表 |
data | 數(shù)據(jù) |
questions | 相關(guān)題目 |
answer | 答案 |
id | 答案 |
analysis | 解析 |
content | 題目內(nèi)容 |
knowledge | 知識點 |
text | 圖片題目OCR結(jié)果 |
對于在線題目檢索,查詢結(jié)果返回數(shù)據(jù)如下:
{
"data": {
"questions": [{
"answer": "D.<br />根據(jù)題意畫出圖形.<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.運行程序崩潰?
檢查下是否對應(yīng)的 so
是否放到當(dāng)前工程目錄下。
2.如何獲得應(yīng)用ID
注冊賬號, 登錄后臺創(chuàng)建應(yīng)用和實例并完成綁定, 可獲得應(yīng)用ID和應(yīng)用密鑰等信息。
錯誤代碼列表
錯誤碼 | 含義 |
---|
101 | 缺少必填的參數(shù) |
102 | 不支持的語言類型 |
103 | 翻譯文本過長 |
104 | 不支持的API類型 |
105 | 不支持的簽名類型 |
106 | 不支持的響應(yīng)類型 |
107 | 不支持的傳輸加密類型 |
108 | 應(yīng)用ID無效,注冊賬號,登錄后臺創(chuàng)建應(yīng)用,可獲得應(yīng)用ID和應(yīng)用密鑰等信息 |
109 | batchLog格式不正確 |
110 | 無相關(guān)服務(wù)的有效實例 |
111 | 開發(fā)者賬號無效 |
113 | q不能為空 |
114 | 不支持的圖片傳輸方式 |
201 | 解密失敗,可能為DES,BASE64,URLDecode的錯誤 |
202 | 簽名檢驗失敗 |
203 | 訪問IP地址不在可訪問IP列表 |
205 | 請求的接口與應(yīng)用的平臺類型不一致,如有疑問請參考入門指南 |
206 | 因為時間戳無效導(dǎo)致簽名校驗失敗 |
207 | 重放請求 |
301 | 辭典查詢失敗 |
302 | 翻譯查詢失敗 |
303 | 服務(wù)端的其它異常 |
304 | 會話閑置太久超時 |
401 | 賬戶已經(jīng)欠費停 |
402 | offlinesdk不可用 |
411 | 訪問頻率受限,請稍后訪問 |
412 | 長請求過于頻繁,請稍后訪問 |
1001 | 無效的OCR類型 |
1002 | 不支持的OCR image類型 |
1003 | 不支持的OCR Language類型 |
1004 | 識別圖片過大 |
1201 | 圖片base64解密失敗 |
1301 | OCR段落識別失敗 |
1411 | 訪問頻率受限 |
1412 | 超過最大識別字節(jié)數(shù) |
2003 | 不支持的語音聲道 |
2004 | 不支持的語音上傳類型 |
2005 | 不支持的語言類型 |
2006 | 不支持的識別類型 |
2201 | 識別音頻文件過大 |
2301 | 識別音頻時長過長 |
2411 | 不支持的音頻文件類型 |
2412 | 不支持的發(fā)音類型 |
3001 | 不支持的語音格式 |
3002 | 不支持的語音采樣率 |
3003 | 不支持的語音聲道 |
3004 | 不支持的語音上傳類型 |
3005 | 不支持的語言類型 |
3006 | 不支持的識別類型 |
3007 | 識別音頻文件過大 |
3008 | 識別音頻時長過長 |
3009 | 不支持的音頻文件類型 |
3010 | 不支持的發(fā)音類型 |
3201 | 解密失敗 |
3301 | 語音識別失敗 |
3302 | 語音翻譯失敗 |
3303 | 服務(wù)的異常 |
3411 | 訪問頻率受限,請稍后訪問 |
3412 | 超過最大請求字符數(shù) |
4001 | 不支持的語音識別格式 |
4002 | 不支持的語音識別采樣率 |
4003 | 不支持的語音識別聲道 |
4004 | 不支持的語音上傳類型 |
4005 | 不支持的語言類型 |
4006 | 識別音頻文件過大 |
4007 | 識別音頻時長過長 |
4201 | 解密失敗 |
4301 | 語音識別失敗 |
4303 | 服務(wù)的異常 |
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 | 服務(wù)器內(nèi)部錯誤 |
9411 | 訪問頻率受限(超過最大調(diào)用次數(shù)) |
9412 | 超過最大處理語音長度 |
10001 | 無效的OCR類型 |
10002 | 不支持的OCR image類型 |
10004 | 識別圖片過大 |
10201 | 圖片base64解密失敗 |
10301 | OCR段落識別失敗 |
10411 | 訪問頻率受限 |
10412 | 超過最大識別流量 |
11001 | 不支持的語音識別格式 |
11002 | 不支持的語音識別采樣率 |
11003 | 不支持的語音識別聲道 |
11004 | 不支持的語音上傳類型 |
11005 | 不支持的語言類型 |
11006 | 識別音頻文件過大 |
11007 | 識別音頻時長過長,最大支持30s |
11201 | 解密失敗 |
11301 | 語音識別失敗 |
11303 | 服務(wù)的異常 |
11411 | 訪問頻率受限,請稍后訪問 |
11412 | 超過最大請求時長 |
12001 | 圖片尺寸過大 |
12002 | 圖片base64解密失敗 |
12003 | 引擎服務(wù)器返回錯誤 |
12004 | 圖片為空 |
12005 | 不支持的識別圖片類型 |
13001 | 不支持的角度類型 |
13002 | 不支持的文件類型 |
13003 | 表格識別圖片過大 |
13004 | 文件為空 |
13301 | 表格識別失敗 |
17001 | 需要圖片 |
17002 | 圖片過大(1M) |
17003 | 識別類型未找到 |
17004 | 不支持的識別類型 |
17005 | 服務(wù)調(diào)用失敗 |
-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
版本更新記錄
上線日期 | 版本號 | 更新內(nèi)容 |
---|
2019.02.20 | v1.0.0 | 支持在線題目檢索 |
題目檢索9.11.05 | v2.0.0 | 兼容多個sdk共用 |