通用文字識別 SDK簡介
概述
(1) 概念解釋
通用文字識別:將自然場景下圖片上的文字內(nèi)容,通過定位和檢測,智能識別為可編輯的文本信息
(2) 說明
Hi,您好,歡迎使用有道智云OCR iOS SDK。
如果您想快速體驗服務(wù),建議您前往 體驗中心 或者搜索小程序(有道智云體驗中心)進行試用。
本文檔主要針對需要集成OCR識別服務(wù)iOS SDK的開發(fā)工程師,詳細描述有道智云OCR識別能力及集成過程。
如果您有與我們商務(wù)合作的需求,可以通過以下方式聯(lián)系我們:
商務(wù)郵箱: AIcloud_Business@corp.youdao.com
如果您對文檔內(nèi)容有任何疑問,可以通過以下幾種方式聯(lián)系我們:
客服QQ:1906538062
智云OCR技術(shù)交流QQ 1群: 654064748
智云OCR技術(shù)交流QQ 2群: 471638046
聯(lián)系郵箱: zhiyun@corp.youdao.com
溫馨提示:
本文檔主要針對開發(fā)人員,接入測試前需要在后臺創(chuàng)建iOS應(yīng)用,并綁定OCR識別實例;如果您還沒有,請按照 新手指南 操作。
平臺向每個賬戶贈送50元的體驗金,供用戶集成前測試所用,具體資費規(guī)則詳見 通用文字識別服務(wù)報價。
功能介紹
有道通用文字識別 SDK 是有道智云開放平臺提供的云服務(wù)之一,是有道在線 OCR 接口的一種實現(xiàn),支持在線文本識別。
兼容性
支持設(shè)備:運行了iOS 8.0及以上系統(tǒng)的 iOS 設(shè)備
通用文字識別 SDK集成指南
集成前提
開始集成SDK之前開發(fā)者需要登錄 有道智云平臺 ,創(chuàng)建應(yīng)用獲取應(yīng)用ID(或者通過運營人員獲取應(yīng)用ID),以便使用OCR服務(wù)。
集成步驟
SDK包導(dǎo)入
OCR SDK 由如下幾個 SDK 組成,OCRSDK.h、libbase.a、libocronline.a
(1). 添加頭文件和庫文件:將 OCR SDK 添加到工程中,包括 OCRSDK.h頭文件、libbase.a和libocronline.a文件。可以直接將translateSDK文件夾拖動到工程中,也可以選擇File “Add files to ‘Project Name’…”
(2). 設(shè)置工程Other Linker Flags為-ObjC
(3). 在工程build Phases – Link Binary With Libraries中添加libbase.a, AdSupport.framework, CoreTelephony.framework, SystemConfiguration, libz.tbd和libsqlite3.tbd。
SDK初始化
說明:所有的查詢都需要初始化key,只執(zhí)行初始化一次即可。
//初始化key
YDTranslateInstance *yd = [YDTranslateInstance sharedInstance];
yd.appKey = @"your appkey";
功能集成
說明:請參考 demo 中 OCROnlineController 的使用
構(gòu)造查詢器
YDOCRRequest *request = [YDOCRRequest request];
YDOCRParameter *param = [YDOCRParameter param];
param.langType = @"en"; //設(shè)置識別語言為英文,langType支持"zh-en"和"en",其中"zh-en"為中英識別,"en"參數(shù)表示只識別英文。若為 純英文識別,"zh-en"的識別效果不如"en",請妥善選擇
param.source = @"youdaoocr"; //設(shè)置源
param.detectType = @"10012"; //設(shè)置識別類型,按行識別:10012
request.param = param;
將圖片轉(zhuǎn)化為base64編碼
NSString *base64Str = [self image2DataURL:self.imgView.image];
執(zhí)行識別過程
識別返回兩種情況,一種是成功,相關(guān)結(jié)果存儲在 result 參數(shù)中,另外一種是失敗,失敗信息放在 error,是一個枚舉類,整個識別是異步的。
[request lookup:base64Str WithCompletionHandler:^(YDOCRRequest *request, YDOCRResult *result, NSError *error) {
if (error) {
//失敗
NSLog(@"error:%@", error);
}else {
//成功
[self handleOCRReuslt:result];
}
}];
識別結(jié)果說明
對于在線OCR,服務(wù)器查詢結(jié)果返回數(shù)據(jù)如下:
{
"errorCode": "0",
"Result": {
"orientation": "Up",
"regions": [{
"boundingBox": "81,325,552,64",
"lines": [{
"boundingBox": "81,325,552,64",
"text":"NetEase YouDao"
"words": [{
"boundingBox": "81,329,259,59",
"word": "NetEase"
}, {
"boundingBox": "364,325,270,62",
"word": "YouDao"
}]
}]
}],
"textAngle": 1.07417,
"language": "en"
}
}
服務(wù)器是按照區(qū)域,行,字的格式返回的,即一張圖片會識別出圖片對應(yīng)的 Result,其上可能有多個區(qū)域 Region,每個區(qū)域會包含一行或多行 Line,每行又包括一個或多個字 Word,每個區(qū)域、行或者字符,都會通過 boundingBox 字段返回坐標(biāo)和大小。 SDK 對上述 json 數(shù)據(jù)解析封裝為 YDOCRResult 對象,如下:
@interface YDOCRResult : NSObject
@property (nonatomic, copy) NSString *orientation;
@property (nonatomic, copy) NSString *textAngle;
@property (nonatomic, copy) NSString *language;
@property (nonatomic, strong) NSArray *regions; //YDOCRRegion數(shù)組
+ (instancetype)initWithDict:(NSDictionary *)info;
@end
@interface YDOCRRegion : NSObject
@property (nonatomic, copy) NSString *boundingBox;
@property (nonatomic, strong) NSArray *lines;//YDOCRLine數(shù)組
+ (instancetype)initWithDict:(NSDictionary *)info;
@end
@interface YDOCRLine : NSObject
@property (nonatomic, copy) NSString *boundingBox;
@property (nonatomic, copy) NSString *text;
@property (nonatomic, strong) NSArray *words;//YDOCRWord數(shù)組
+ (instancetype)initWithDict:(NSDictionary *)info;
@end
@interface YDOCRWord : NSObject
@property (nonatomic, copy) NSString *boundingBox;
@property (nonatomic, copy) NSString *word;
+ (instancetype)initWithDict:(NSDictionary *)info;
@end
支持語言
| 語言 |
代碼 |
| sq |
阿爾巴尼亞語 |
| az |
阿塞拜疆語 |
| eu |
巴斯克語 |
| be |
白俄羅斯語 |
| bs |
波斯尼亞文(拉丁文) |
| bg |
保加利亞文 |
| ca |
加泰羅尼亞文(加泰隆語) |
| ceb |
宿務(wù)語 |
| ny |
齊切瓦語 |
| zh-CHS |
中文 |
| zh-CHT |
中文(繁體) |
| co |
科西嘉語 |
| hr |
克羅地亞文 |
| cs |
捷克文 |
| da |
丹麥文 |
| nl |
荷蘭文 |
| en |
英文 |
| eo |
世界語 |
| et |
愛沙尼亞文 |
| fi |
芬蘭文 |
| fr |
法文 |
| gd |
蘇格蘭蓋爾語 |
| gl |
加利西亞語 |
| de |
德文 |
| ht |
海地文 |
| ha |
豪薩語 |
| haw |
夏威夷語 |
| hi |
印地文 |
| hu |
匈牙利文 |
| is |
冰島語 |
| ig |
伊博語 |
| id |
印度尼西亞文 |
| ga |
愛爾蘭語 |
| it |
意大利文 |
| ja |
日文 |
| jw |
印尼爪哇語 |
| ko |
韓文 |
| ku |
庫爾德語 |
| la |
拉丁語 |
| lv |
拉脫維亞文 |
| lt |
立陶宛文 |
| lb |
盧森堡語 |
| mk |
馬其頓語 |
| mg |
馬爾加什語 |
| ms |
馬來文 |
| mt |
馬耳他文 |
| mi |
毛利語 |
| mr |
馬拉地語 |
| mn |
蒙古語 |
| ne |
尼泊爾語 |
| no |
挪威文 |
| pl |
波蘭文 |
| pt |
葡萄牙文 |
| ro |
羅馬尼亞文 |
| ru |
俄文 |
| sm |
薩摩亞語 |
| sr-Latn |
塞爾維亞文(拉丁文) |
| sn |
修納語 |
| sk |
斯洛伐克文 |
| sl |
斯洛文尼亞文 |
| so |
索馬里語 |
| st |
塞索托語 |
| es |
西班牙文 |
| su |
印尼巽他語 |
| sw |
斯瓦希里文 |
| sv |
瑞典文 |
| tl |
菲律賓語 |
| tg |
塔吉克語 |
| tr |
土耳其文 |
| uk |
烏克蘭文 |
| uz |
烏茲別克語 |
| vi |
越南文 |
| cy |
威爾士文 |
| fy |
弗里斯蘭語 |
| yo |
約魯巴語 |
| zu |
南非祖魯語 |
| hmn |
苗族語 |
| xh |
班圖 |
| af |
南非荷蘭 |
| auto |
自動識別 |
auto支持所有語種的自動識別
錯誤代碼列表
| 錯誤碼 |
含義 |
| 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 |
不支持的識別圖片類型 |
| 12006 |
圖片無匹配結(jié)果 |
| 13001 |
不支持的角度類型 |
| 13002 |
不支持的文件類型 |
| 13003 |
表格識別圖片過大 |
| 13004 |
文件為空 |
| 13301 |
表格識別失敗 |
| 15001 |
需要圖片 |
| 15002 |
圖片過大(1M) |
| 15003 |
服務(wù)調(diào)用失敗 |
| 17001 |
需要圖片 |
| 17002 |
圖片過大(1M) |
| 17003 |
識別類型未找到 |
| 17004 |
不支持的識別類型 |
| 17005 |
服務(wù)調(diào)用失敗 |
| -1000 |
未知錯誤 |
| -2000 |
查詢輸入為空 |
常見問題及注意事項
1.運行程序崩潰?
檢查下是否對應(yīng)的 SDK靜態(tài)庫包 是否放到當(dāng)前工程目錄下。
2.OCR識別沒結(jié)果?
檢查下OCR識別接口回調(diào)的錯誤信息,保證申請的應(yīng)用ID是有效且提前綁定了。
3.如何獲得應(yīng)用ID
注冊賬號,登錄后臺創(chuàng)建應(yīng)用和實例并完成綁定, 可獲得應(yīng)用ID和應(yīng)用密鑰等信息。
版本更新記錄
| 上線日期 |
版本號 |
更新內(nèi)容 |
| 2017.07.11 |
v1.2.0 |
有道智云 OCR iOS SDK上線,支持中英文在線文字識別 |
| 2017.07.24 |
v1.3.0 |
修復(fù)已知 bug |
| 2017.08.16 |
v1.4.0 |
修復(fù)已知 bug |
| 2018.11.07 |
v1.5.0 |
增加按行識別10012 |