baiduOCRRecognizer
init recognizeGeneralbase recognizeAccurateBasic recognizeGeneral recognizeAccurate recognizeGeneralEnhanced recognizeWebimage recognizeBankCard recognizeIDCard recognizeVehicleLicense recognizeDrivingLicense recognizeLicensePlate recognizeBusinessLicense recognizeReceipt recognizeVatInvoice
论坛示例
为帮助用户更好更快的使用插件，论坛维护了一个示例，示例中包含示例代码、知识点讲解、注意事项等，供您参考。
概述
baiduOCRRecognizer插件封装了百度AI文字识别功能，使用此插件可实现百度通用文字识别、通用文字识别（高精度版）、通用文字识别（含位置信息版）、通用文字识别（高精度含位置版）、通用文字识别（含生僻字版）、网络图片文字识别、身份证识别、银行卡识别、驾驶证识别、行驶证识别、车牌识别、营业执照识别、通用票据识别。。详情请参考网站帮助。
使用此插件注意
需要到管理控制台创建应用
注意：本插件 iOS 平台上最低适配系统版本为 iOS 11.0
使用说明：
1、首先要在百度AI开放平台注册账号；
2、创建应用，选择需要使用文字识别选项，然后获取API Key、Secret Key，后面需要使用ak、sk进行百度身份验证；
3、有些选项是需要付费的，若没有付费进行使用，调用相应的接口会返回错写信息；
4、具体操作可参考百度AI开发平台文档；
身份验证错误说明：
对应的是错误码、错误信息、说明
110 Access token invalid or no longer valid Access Token过期失效
283501 License file check error 授权文件不匹配
283502 App identifier unmatch BundleId不匹配
283503 License file not exists 请确认aip.licence文件存在于assets文件夹中
283504 Network error 网络请求失败
283505 Server illegal response 服务器返回数据异常
283506 Load jni so library error JNI加载异常
283601 Server authentication error 身份验证错误
283602 Authentication time error 时间戳不正确，可能是设备时间异常
283604 App identifier unmatch 错误的PackageName或者BundleId
283700 Server internal error 服务器内部错误
识别验证错误说明：
对应的是错误码、错误信息、说明
216015 module closed 插件关闭
216100 invalid param 非法参数
216101 not enough param 参数数量不够
216102 service not support 业务不支持
216103 param too long 参数太长
216110 appid not exist APP ID不存在
216111 invalid userid 非法用户ID
216200 empty image 空的图片
216201 image format error 图片格式错误
216202 image size error 图片大小错误
216300 db error DB错误
216400 backend error 后端系统错误
216401 internal error 内部错误
216500 unknown error 未知错误
216600 id number format error 身份证的ID格式错误
216601 id number and name not match 身份证的ID和名字不匹配
216630 recognize error 识别错误
216631 recognize bank card error 识别银行卡错误（通常为检测不到银行卡）
216632 ocr unknown error
216633 recognize idcard error 识别身份证错误（通常为检测不到身份证）
216634 detect error 检测错误
216635 get mask error 获取mask图片错误
282000 logic internal error 业务逻辑层内部错误
282001 logic backend error 业务逻辑层后端服务错误
282100 image transcode error 图片压缩转码错误
init
初始化sdk,先调用此接口进行授权
init({params},callback(ret))
params
appKey：
- 类型：字符串
- 描述：应用的appkey
- 默认：无
appSecret:
- 类型：布尔类型
- 描述：应用的appSecret
- 默认：无
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
{
state :true , 布尔类型: true(成功) false (失败)
token:'1111', 字符串类型: 当state为true返回 token值，iOS不支持此字段
errCode:0, 数字类型: 当state为false返回 错误码
errDesc:'' 字符串类型: 当state为false返回 错误描述
}
示例代码
var demo = api.require('baiduOCRRecognizer');
demo.init(function(ret){
api.alert({ msg:JSON.stringify(ret)});
});
补充说明
请确保参数ak、sk正确，身份验证在使用前验证一次即可，或是每次请求都先验证也可以。（程序中验证过一次）
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeGeneralbase
通用文字识别
recognizeGeneralbase({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true：检测朝向； false：不检测朝向。
- 默认：false
languageType:
- 类型：字符串
- 描述：识别语言类型，默认为CHN_ENG。可选值包括： CHN_ENG：中英文混合； ENG：英文； POR：葡萄牙语；FRE：法语；GER：德语； ITA：意大利语；SPA：西班牙语；RUS：俄语；JAP：日语
- 默认：CHN_ENG
detectLanguage:
- 类型：布尔类型
- 描述：是否检测语言，默认不检测。当前支持（中文、英语、日语、韩语）
- 默认：false
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
{
"log_id":8814667417068238186, 数字类型:唯一的log id，用于问题定位
"direction":0, 数字类型: 图像方向，当detect_direction=true时存在。
1:未定义，0:正向，- 1: 逆时针90度，- 2:逆时针180度，- 3:逆时针270度
"words_result_num":5, 数字类型:识别结果数，表示words_result的元素个数
"words_result":[ 数组类型: 定位和识别结果数组
{"words":"①"}, 字符串类型:识别结果字符串
{"words":"请完善以下信息"},
{"words":"请输入姓名"},
{"words":"(必填"},
{"words":"请输入手机号"}
]
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo = api.require('baiduOCRRecognizer');
demo.recognizeGeneralbasic({
// path:'widget://image/text.png',
path:'fs://text.jpg',
DetectDirection:true,
//languageType:"JAP",
//detectLanguage:true,
},function(ret){
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeAccurateBasic
通用文字识别(高精度版)
recognizeGeneralbase({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：是否检测图像朝向，默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：false
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
{
"log_id":8814667417068238186, 数字类型:唯一的log id，用于问题定位
"direction":0, 数字类型: 图像方向，当detect_direction=true时存在。
1:未定义，0:正向，- 1: 逆时针90度，- 2:逆时针180度，- 3:逆时针270度
"words_result_num":5, 数字类型:识别结果数，表示words_result的元素个数
"words_result":[ 数组类型: 定位和识别结果数组
{"words":"①"}, 字符串类型:识别结果字符串
{"words":"请完善以下信息"},
{"words":"请输入姓名"},
{"words":"(必填"},
{"words":"请输入手机号"}
]
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo = api.require('baiduOCRRecognizer');
demo.recognizeAccurateBasic({
// path:'widget://image/text.png',
path:'fs://text.jpg',
DetectDirection:true,
},function(ret,err){
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeGeneral
通用文字识别(含位置信息)
recognizeGeneral({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true：检测朝向； false：不检测朝向。
- 默认：false
recognize_granularity:
- 类型：字符串
- 描述：是否定位单字符位置，big：不定位单字符位置，默认值；small：定位单字符位置
- 默认：small
vertexes_location:
- 类型：布尔类型
- 描述：是否返回文字外接多边形顶点位置，不支持单字位置。默认为false
- 默认：false
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
- 结果返回字段
direction 数字类型: 图像方向，当detect_direction=true时存在。 1:未定义， 0:正向，- 1: 逆时针90度，- 2:逆时针180度，- 3:逆时针270度
log_id 数字类型: 唯一的log id，用于问题定位
words_result 数组类型: 定位和识别结果数组
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
vertexes_location 数组类型: 当前为四个顶点: 左上，右上，右下，左下。当vertexes_location=true时存在 |
x 数字类型: 水平坐标（坐标0点为左上角）
y 数字类型: 垂直坐标（坐标0点为左上角） |
left 数字类型: 表示定位位置的长方形左上顶点的水平坐标
top 数字类型: 表示定位位置的长方形左上顶点的垂直坐标
width 数字类型: 表示定位位置的长方形的宽度
height 数字类型: 表示定位位置的长方形的高度
words 字符串类型: 识别结果字符串
chars 数组类型: 单字符结果，recognize_granularity=small时存在
location 数组类型: 位置数组（坐标0点为左上角）
left 数字类型: 表示定位位置的长方形左上顶点的水平坐标
top 数字类型:表示定位位置的长方形左上顶点的垂直坐标
width 数字类型:| 表示定位定位位置的长方形的宽度
height 数字类型:表示位置的长方形的高度
char 字符串类型: 单字符识别结果
{
数字类型: 图像方向，当detect_direction=true时存在。
1:未定义，0:正向，- 1: 逆时针90度，- 2:逆时针180度，- 3:逆时针270度
direction : 2,
log_id : 676709620, 数字类型:唯一的log id，用于问题定位
words_result : [ { 数组类型: 定位和识别结果数组
location : {
height : 20;
left : 86;
top : 387;
width : 22;
};
words : "N";
},
],
words_result_num : 1; 数字类型:识别结果数，表示words_result的元素个数
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var replay = api.require('baiduOCRRecognizer');
replay.recognizeGeneral({
path:'fs://text.jpg',
DetectDirection:true,
recognize_granularity:'small',
vertexes_location:true,
},function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeAccurate
通用文字识别(含位置信息高精度版)
recognizeAccurate({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true：检测朝向； false：不检测朝向。
- 默认：false
recognize_granularity:
- 类型：字符串
- 描述：是否定位单字符位置，big：不定位单字符位置，默认值；small：定位单字符位置
- 默认：small
vertexes_location:
- 类型：布尔类型
- 描述：是否返回文字外接多边形顶点位置，不支持单字位置。默认为false
- 默认：false
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
- 结果返回字段
direction 数字类型: 图像方向，当detect_direction=true时存在。 1:未定义， 0:正向，- 1: 逆时针90度，- 2:逆时针180度，- 3:逆时针270度
log_id 数字类型: 唯一的log id，用于问题定位
words_result 数组类型: 定位和识别结果数组
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
vertexes_location 数组类型: 当前为四个顶点: 左上，右上，右下，左下。当vertexes_location=true时存在 |
x 数字类型: 水平坐标（坐标0点为左上角）
y 数字类型: 垂直坐标（坐标0点为左上角） |
left 数字类型: 表示定位位置的长方形左上顶点的水平坐标
top 数字类型: 表示定位位置的长方形左上顶点的垂直坐标
width 数字类型: 表示定位位置的长方形的宽度
height 数字类型: 表示定位位置的长方形的高度
words 字符串类型: 识别结果字符串
chars 数组类型: 单字符结果，recognize_granularity=small时存在
location 数组类型: 位置数组（坐标0点为左上角）
left 数字类型: 表示定位位置的长方形左上顶点的水平坐标
top 数字类型:表示定位位置的长方形左上顶点的垂直坐标
width 数字类型:| 表示定位定位位置的长方形的宽度
height 数字类型:表示位置的长方形的高度
char 字符串类型: 单字符识别结果
{
数字类型: 图像方向，当detect_direction=true时存在。
1:未定义，0:正向，- 1: 逆时针90度，- 2:逆时针180度，- 3:逆时针270度
direction : 2,
log_id : 676709620, 数字类型:唯一的log id，用于问题定位
words_result : [ { 数组类型: 定位和识别结果数组
location : {
height : 20;
left : 86;
top : 387;
width : 22;
};
words : "N";
},
],
words_result_num : 1; 数字类型:识别结果数，表示words_result的元素个数
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var replay = api.require('baiduOCRRecognizer');
replay.recognizeAccurate({
path:'fs://text.jpg',
DetectDirection:true,
recognize_granularity:'small',
vertexes_location:true,
},function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeGeneralEnhanced
通用文字识别(通用文字识别含生僻字版)
recognizeGeneralEnhanced({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true：检测朝向； false：不检测朝向。
- 默认：false
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
{
"log_id":8814667417068238186, 数字类型:唯一的log id，用于问题定位
"direction":0, 数字类型: 图像方向，当detect_direction=true时存在。
1:未定义，0:正向，- 1: 逆时针90度，- 2:逆时针180度，- 3:逆时针270度
"words_result_num":5, 数字类型:识别结果数，表示words_result的元素个数
"words_result":[ 数组类型: 定位和识别结果数组
{"words":"①"}, 字符串类型:识别结果字符串
{"words":"请完善以下信息"},
{"words":"请输入姓名"},
{"words":"(必填"},
{"words":"请输入手机号"}
]
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeGeneralEnhanced({
path:'fs://text.jpg',
DetectDirection:true,
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeWebimage
recognizeWebimage
网络图片文字识别
recognizeWebimage({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true：检测朝向； false：不检测朝向。
- 默认：false
detectLanguage:
- 类型：布尔类型
- 描述：是否检测语言，默认不检测。当前支持（中文、英语、日语、韩语）
- 默认：false
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
{
"log_id":8814667417068238186, 数字类型:唯一的log id，用于问题定位
"direction":0, 数字类型: 图像方向，当detect_direction=true时存在。
1:未定义，0:正向，- 1: 逆时针90度，- 2:逆时针180度，- 3:逆时针270度
"words_result_num":5, 数字类型:识别结果数，表示words_result的元素个数
"words_result":[ 数组类型: 定位和识别结果数组
{"words":"①"}, 字符串类型:识别结果字符串
{"words":"请完善以下信息"},
{"words":"请输入姓名"},
{"words":"(必填"},
{"words":"请输入手机号"}
]
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeWebimage({
path:'fs://text.jpg',
DetectDirection:true,
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeBankCard
银行卡识别
recognizeBankCard({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
结果参数:
log_id 数字类型:唯一的log id，用于问题定位 result Object 定位和识别结果数组 bank_card_number 字符串类型: 银行卡识别结果 bank_name 字符串类型: 银行名，不能识别时为空 bank_card_type 数字类型: 银行卡类型，0:不能识别; 1: 借记卡; 2: 信用卡
{
"log_id": 3207866271;
result: {
"bank_card_number": "6226 2288 8888 8888",
"bank_card_type": 1,
"bank_name": "\U5de5\U5546\U94f6\U884c"
};
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeBankCard({
path:'fs://text.jpg',
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeIDCard
身份证识别 recognizeIDCard({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true：检测朝向； false：不检测朝向。
- 默认：false
accuracy:
- 类型：字符串
- 描述：精准度 取值 auto、normal、high 精度越高，速度越慢。
- 默认：auto
isFront:
- 类型：布尔类型
- 描述：true：身份证正面，false：身份证背面
- 默认：true
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
结果参数:
direction 数字类型: 图像方向，当detect_direction=true时存在。-1:未定义，0:正向，1: 逆时针90度， 2:逆时 针180度， 3:逆时针270度
log_id 数字类型: 唯一的log id，用于问题定位
words_result 数组类型: 定位和识别结果数组，数组元素的key是身份证的主体字段（正面支持：住址、公民身份号码、出生、姓名、性别、民族，背面支持：签发机关、签发日期、失效日期）。只返回识别出的字段。若身份证号码校验不通过，则不返回
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
location 数组类型: 位置数组（坐标0点为左上角）
left 数字类型: 表示定位位置的长方形左上顶点的水平坐标
top 数字类型: 表示定位位置的长方形左上顶点的垂直坐标
width 数字类型: 表示定位位置的长方形的宽度
height 数字类型:表示定位位置的长方形的高度
words 字符串类型: 识别结果字符串
{
"log_id": 7037721,
"direction": 0,
"words_result_num": 2,
"words_result": {
"住址": {
"location": {
"left": 227,
"top": 235,
"width": 229,
"height": 51
},
"words": "湖北省天门市渔薪镇杨咀村一组2号",
}
...
}
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeIDCard({
path:'fs://text.jpg',
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeVehicleLicense
行驶证识别 recognizeVehicleLicense({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true：检测朝向； false：不检测朝向。
- 默认：false
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
结果参数:
log_id 数字类型: 唯一的log id，用于问题定位
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
words_result 数组类型: 识别结果数组
words 字符串类型: 识别结果字符串
{
"errno": 0,
"msg": "success",
"data": {
"words_result_num": 10,
"words_result": {
"品牌型号": {
"words": "保时捷GT37182RUCRE"
},
"发证日期": {
"words": "20160104"
},
"使用性质": {
"words": "非营运"
},
"发动机号码": {
"words": "20832"
},
"号牌号码": {
"words": "苏A001"
},
"所有人": {
"words": "圆圆"
},
"住址": {
"words": "南京市江宁区弘景大道"
},
"注册日期": {
"words": "20160104"
},
"车辆识别代号": {
"words": "HCE58"
},
"车辆类型": {
"words": "小型轿车"
}
}
}
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeVehicleLicense({
path:'fs://text.jpg',
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeDrivingLicense
驾驶证识别 recognizeDrivingLicense({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
DetectDirection:
- 类型：布尔类型
- 描述：默认不检测，即：false。朝向是指输入图像是正常方向、逆时针旋转90/180/270度。可选值包括:true：检测朝向； false：不检测朝向。
- 默认：false
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
结果参数:
log_id 数字类型: 唯一的log id，用于问题定位
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
words_result 数组类型: 识别结果数组
words 字符串类型: 识别结果字符串
{
"errno": 0,
"msg": "success",
"data": {
"words_result_num": 10,
"words_result": {
"证号": {
"words": "3208231999053090"
},
"有效期限": {
"words": "6年"
},
"准驾车型": {
"words": "B2"
},
"有效起始日期": {
"words": "20101125"
},
"住址": {
"words": "江苏省南通市海门镇秀山新城"
},
"姓名": {
"words": "小欧欧"
},
"国籍": {
"words": "中国"
},
"出生日期": {
"words": "19990530"
},
"性别": {
"words": "男"
},
"初次领证日期": {
"words": "20100125"
}
}
}
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeDrivingLicense({
path:'fs://text.jpg',
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeLicensePlate
车牌识别 recognizeLicensePlate({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
结果参数:
log_id 数字类型: 唯一的log id，用于问题定位
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
words_result 数组类型: 识别结果数组 字符串类型: 识别结果字符串
color 字符串类型: 车牌颜色，如"blue"
{
"words_result":{
"color":"blue",
"number":"粤FQ0000"
},
"log_id":2783673432
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeLicensePlate({
path:'fs://text.jpg',
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeBusinessLicense
营业执照识别 recognizeBusinessLicense({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
结果参数:
log_id 数字类型: 唯一的log id，用于问题定位
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
words_result 数组类型: 识别结果数组 字符串类型: 识别结果字符串
left 数字类型: 表示定位位置的长方形左上顶点的水平坐标
top 数字类型: 表示定位位置的长方形左上顶点的垂直坐标
width 数字类型: 表示定位位置的长方形的宽度
height 数字类型: 表示定位位置的长方形的高度
words 字符串类型: 识别结果字符串
{
"log_id": 490058765,
"words_result": {
"单位名称": {
"location": {
"left": 500,
"top": 479,
"width": 618,
"height": 54
},
"words": "袁氏财团有限公司"
},
"法人": {
"location": {
"left": 938,
"top": 557,
"width": 94,
"height": 46
},
"words": "袁运筹"
},
"地址": {
"location": {
"left": 503,
"top": 644,
"width": 574,
"height": 57
},
"words": "江苏省南京市中山东路19号"
},
"有效期": {
"location": {
"left": 779,
"top": 1108,
"width": 271,
"height": 49
},
"words": "2015年02月12日"
},
"证件编号": {
"location": {
"left": 1219,
"top": 357,
"width": 466,
"height": 39
},
"words": "苏餐证字(2019)第666602666661号"
},
"社会信用代码": {
"location": {
"left": 0,
"top": 0,
"width": 0,
"height": 0
},
"words": "无"
}
},
"words_result_num": 6
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeBusinessLicense({
path:'fs://text.jpg',
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeReceipt
通用票据识别 recognizeReceipt({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
结果参数:
log_id 数字类型: 唯一的log id，用于问题定位
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
words_result 数组类型: 识别结果数组 字符串类型: 识别结果字符串
left 数字类型: 表示定位位置的长方形左上顶点的水平坐标
top 数字类型: 表示定位位置的长方形左上顶点的垂直坐标
width 数字类型: 表示定位位置的长方形的宽度
height 数字类型: 表示定位位置的长方形的高度
words 字符串类型: 识别结果字符串
location object: 位置数组（坐标0点为左上角） |
|
| chars 数组类型: 单字符结果，recognize_granularity=small时存在 |
| location 数组类型: 位置数组（坐标0点为左上角） |
| left 数字类型: 表示定位位置的长方形左上顶点的水平坐标 |
| top 数字类型: 表示定位位置的长方形左上顶点的垂直坐标 |
| width 数字类型:表示定位定位位置的长方形的宽度 |
| height 数字类型:表示位置的长方形的高度 |
| char 数字类型:单字符识别结果 |
| probability object类型: 识别结果中每一行的置信度值，包含average：行置信度平均值，variance：行置信度方差，min：行置信度最小值 |
{
"log_id": 2661573626,
"words_result": [
{
"location": {
"left": 10,
"top": 3,
"width": 121,
"height": 24
},
"words": "姓名:小明明",
"chars": [
{
"location": {
"left": 16,
"top": 6,
"width": 17,
"height": 20
},
"char": "姓"
},
{
"location": {
"left": 35,
"top": 6,
"width": 17,
"height": 20
},
"char": "名"
},
{
"location": {
"left": 55,
"top": 6,
"width": 11,
"height": 20
},
"char": ":"
},
{
"location": {
"left": 68,
"top": 6,
"width": 17,
"height": 20
},
"char": "小"
},
{
"location": {
"left": 87,
"top": 6,
"width": 17,
"height": 20
},
"char": "明"
},
{
"location": {
"left": 107,
"top": 6,
"width": 17,
"height": 20
},
"char": "明"
}
]
}
],
"words_result_num": 2
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeReceipt({
path:'fs://text.jpg',
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
iOS系统，Android系统
可提供的1.0.0及更高版本
recognizeVatInvoice
增值税票据识别（本接口仅支持Android）
recognizeVatInvoice({params}, callback(ret,err))
params
path：
- 类型：字符串
- 描述：图片路径，支持fs://、widget://等文件路径协议或绝对路径。
- 默认：无
accuracy：
- 类型：字符串
- 描述：normal对应普通精度模型，识别速度较快，high对应高精度识别模型，
- 默认：normal
callback(ret,err)
ret：
- 类型：JSON对象
- 内部字段：
- 注意：通常返回结果取words_result为一个JSON对象，但是不排除为数组的可能性
结果参数字段:
log_id 数字类型: 唯一的log id，用于问题定位
words_result_num 数字类型: 识别结果数，表示words_result的元素个数
words_result 数组类型: 识别结果数组 字符串类型: 识别结果字符串
InvoiceType 字符串类型:发票种类名称
InvoiceCode 数字类型:发票代码
InvoiceNum 数字类型:发票号码
InvoiceDate 数字类型:开票日期
TotalAmount 数字类型:合计金额
TotalTax 数字类型:合计税额
AmountInFiguers 数组类型:价税合计(小写)
AmountInWords object类型:价税合计(大写)
CheckCode 字符串类型: 校验码
SellerName 数字类型:销售方名称
SellerRegisterNum 数字类型:销售方纳税人识别号
PurchaserName 数字类型: 购方名称
PurchaserRegisterNum 数字类型: 购方纳税人识别号
CommodityName object[]类型: 货物名称
-row 数字类型: 行号
-word 字符串类型: 内容
CommodityType object[]类型: 规格型号
-row 数字类型: 行号
-word 字符串类型 内容
CommodityUnit object[]类型: 单位
-row 数字类型: 行号
-word 字符串类型 内容
CommodityNum object[]类型: 数量
-row 数字类型: 行号
-word 字符串类型 内容
CommodityPrice object[]类型: 单价
-row 数字类型: 行号
-word 字符串类型 内容
CommodityAmount object[]类型: 金额
-row 数字类型: 行号
-word 是 string 内容
CommodityTaxRate object[]类型: 税率
-row 数字类型: 行号
-word 字符串类型 内容
CommodityTax object[]类型: 税额
-row 数字类型: 行号
-word 字符串类型 内容
"log_id": "5425496231209218858",
"words_result_num": 29,
"words_result": {
"InvoiceNum": "14641426",
"SellerName": "上海易火广告传媒有限公司",
"CommodityTaxRate": [
{
"word": "6%",
"row": "1"
}
],
"SellerBank": "中国银行南翔支行446863841354",
"Checker": ":沈园园",
"TotalAmount": "94339.62",
"CommodityAmount": [
{
"word": "94339.62",
"row": "1"
}
],
"InvoiceDate": "2016年06月02日",
"CommodityTax": [
{
"word": "5660.38",
"row": "1"
}
],
"PurchaserName": "百度时代网络技术(北京)有限公司",
"CommodityNum": [
{
"word": "",
"row": "1"
}
],
"PurchaserBank": "招商银行北京分行大屯路支行8661820285100030",
"Remarks": "告传",
"Password": "074/45781873408>/6>8>65*887676033/51+<5415>9/32--852>1+29<65>641-5>66<500>87/*-34<943359034>716905113*4242>",
"SellerAddress": ":嘉定区胜辛南路500号15幢1161室55033753",
"PurchaserAddress": "北京市海淀区东北旺西路8号中关村软件园17号楼二属A2010-59108001",
"InvoiceCode": "3100153130",
"CommodityUnit": [
{
"word": "",
"row": "1"
}
],
"Payee": ":徐蓉",
"PurchaserRegisterNum": "110108787751579",
"CommodityPrice": [
{
"word": "",
"row": "1"
}
],
"NoteDrawer": "沈园园",
"AmountInWords": "壹拾万圆整",
"AmountInFiguers": "100000.00",
"TotalTax": "5660.38",
"InvoiceType": "专用发票",
"SellerRegisterNum": "913101140659591751",
"CommodityName": [
{
"word": "信息服务费",
"row": "1"
}
],
"CommodityType": [
{
"word": "",
"row": "1"
}
]
}
}
err：
- 类型：JSON对象
- 内部字段：
{
errCode : 0, //数值类型；错误码
errDesc : '', //字符串类型；错误描述
}
示例代码
var demo =api.require('baiduOCRRecognizer');
demo.recognizeVatInvoice({
path:'fs://text.jpg',
accuracy:'high',
},function(ret,err) {
api.alert({ msg:JSON.stringify(ret)});
api.alert({ msg:JSON.stringify(err)});
}
);
可用性
Android系统
可提供的1.0.0及更高版本