auth generalBasicOCR generalAccurateBasicOCR generalOCR generalAccurateOCR generalEnchancedOCR webImageOCR idcardOCROnlineFront idcardOCROnlineBack localIdcardOCROnlineFront localIdcardOCROnlineBack bankCardOCROnline drivingLicenseOCR vehicleLicenseOCR plateLicenseOCR businessLicenseOCR receiptOCR iOCR detectVinCode vatinvoiceOCR detectTaxiReceipt detectTrainTicket detectNumbers clearCache recNormalMachineInvoice recmedicaldetail reconlinetaxiitinerary
本插件封装了百度ocr 相关的 SDK,本插件自带UI,方便快速集成。
授权
auth({params})
ak:
sk:
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.auth({
ak: '',
sk: ''
});
iOS系统,Android系统
可提供的1.0.0及更高版本
通用文字识别(不含位置信息版)
generalBasicOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.generalBasicOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
通用文字识别,高精度,不带位置信息
generalAccurateBasicOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.generalAccurateBasicOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
通用文字识别(含位置信息)
generalOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.generalOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
通用文字识别,高精度,带位置信息
generalAccurateOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.generalAccurateOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
通用文字识别(含生僻字版)
generalEnchancedOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.generalEnchancedOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
网图识别
webImageOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.webImageOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
身份证正面拍照识别
idcardOCROnlineFront({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.idcardOCROnlineFront({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
身份证反面拍照识别
idcardOCROnlineBack({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.idcardOCROnlineBack({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
身份证正面(嵌入式质量控制+云端识别)
localIdcardOCROnlineFront({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.localIdcardOCROnlineFront({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
身份证反面(嵌入式质量控制+云端识别)
localIdcardOCROnlineBack({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.localIdcardOCROnlineBack({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
银行卡正面拍照识别
bankCardOCROnline(callback(ret,err))
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.bankCardOCROnline(function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
驾驶证识别
drivingLicenseOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.drivingLicenseOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
行驶证证识别
vehicleLicenseOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.vehicleLicenseOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
车牌证识别
plateLicenseOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.plateLicenseOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
营业执照识别
businessLicenseOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.businessLicenseOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
票据识别
receiptOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.receiptOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
自定义模板识别
iOCR({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.iOCR({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
VIN码识别
detectVinCode({params}, callback(ret,err))
options
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.detectVinCode({
options:{}
}, function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
增值税发票识别
vatinvoiceOCR(callback(ret,err))
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.vatinvoiceOCR( function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.0及更高版本
出租车票识别
detectTaxiReceipt(callback(ret,err))
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.detectTaxiReceipt( function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.6及更高版本
火车票识别
detectTrainTicket(callback(ret,err))
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.detectTrainTicket( function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.6及更高版本
数字识别
detectNumbers(callback(ret,err))
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.detectNumbers( function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.6及更高版本
清空验证缓存,出现验证过期等特殊情况调用
clearCache()
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.clearCache();
iOS系统
可提供的1.0.6及更高版本
通用机打发票识别
recNormalMachineInvoice(callback(ret,err))
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.recNormalMachineInvoice( function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.6及更高版本
医疗费用明细识别
recmedicaldetail(callback(ret,err))
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.recmedicaldetail( function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.6及更高版本
网约车行程单识别
reconlinetaxiitinerary(callback(ret,err))
ret:
{
status:, //布尔类型,是否成功
result:{} //json对象(Android返回为字符串类型);识别结果;详情见附件:识别结果
}
err:
{
code:, //数字类型;错误码
msg: '' //字符串类型;错误信息
}
var UIBdOcr = api.require('UIBdOcr');
UIBdOcr.reconlinetaxiitinerary( function(ret, err) {
if (ret) {
api.alert({msg: JSON.stringify(ret)});
} else {
api.alert({msg: JSON.stringify(err)});
}
});
iOS系统,Android系统
可提供的1.0.6及更高版本
参数 | 是否必选 | 类型 | 可选值范围 | 说明 | 支持客户端 |
recognize_granularity | false | string | big、small | 是否定位单字符位置,big:不定位单字符位置,默认值;small:定位单字符位置 | Android/iOS |
mask | false | string | - | 表示mask区域的黑白灰度图片,白色代表选中, base64编码 | iOS |
language_type | false | string | CHN_ENG、ENG、POR、FRE、GER、ITA、SPA、RUS、JAP | 识别语言类型,默认为CHN_ENG。可选值包括: - CHN_ENG:中英文混合; - ENG:英文; - POR:葡萄牙语; - FRE:法语; - GER:德语; - ITA:意大利语; - SPA:西班牙语; - RUS:俄语; - JAP:日语 |
Android/iOS |
detect_direction | false | boolean | true、false | 是否检测图像朝向,默认不检测,即:false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true:检测朝向,false:不检测朝向。 | Android/iOS |
detect_language | false | string | true、false | 是否检测语言,默认不检测。当前支持(中文、英语、日语、韩语) | Android/iOS |
classify_dimension | false | string | lottery | 分类维度(根据OCR结果进行分类),逗号分隔,当前只支持lottery。lottery:彩票分类,设置detect_direction有助于提升精度 | iOS |
vertexes_location | false | string | true、false | 是否返回文字外接多边形顶点位置,不支持单字位置。默认为false | Android/iOS |
accuracy | false | string | auto、normal、high | 精准度,精度越高,速度越慢。default:auto | Android |
字段 | 必选 | 类型 | 说明 |
direction | 否 | int32 | 图像方向,当detect_direction=true时存在。 - -1:未定义, - 0:正向, - 1: 逆时针90度, - 2:逆时针180度, - 3:逆时针270度 |
log_id | 是 | uint64 | 唯一的log id,用于问题定位 |
words_result | 是 | array() | 定位和识别结果数组 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
+vertexes_location | 否 | array() | 当前为四个顶点: 左上,右上,右下,左下。当vertexes_location=true时存在 |
++x | 是 | uint32 | 水平坐标(坐标0点为左上角) |
++y | 是 | uint32 | 垂直坐标(坐标0点为左上角) |
+location | 是 | array() | 位置数组(坐标0点为左上角) |
++left | 是 | uint32 | 表示定位位置的长方形左上顶点的水平坐标 |
++top | 是 | uint32 | 表示定位位置的长方形左上顶点的垂直坐标 |
++width | 是 | uint32 | 表示定位位置的长方形的宽度 |
++height | 是 | uint32 | 表示定位位置的长方形的高度 |
+words | 否 | string | 识别结果字符串 |
+chars | 否 | array() | 单字符结果,recognize_granularity=small时存在 |
++location | 是 | array() | 位置数组(坐标0点为左上角) |
+++left | 是 | uint32 | 表示定位位置的长方形左上顶点的水平坐标 |
+++top | 是 | uint32 | 表示定位位置的长方形左上顶点的垂直坐标 |
+++width | 是 | uint32 | 表示定位定位位置的长方形的宽度 |
+++height | 是 | uint32 | 表示位置的长方形的高度 |
++char | 是 | string | 单字符识别结果 |