bgnTencentOCR

来自于:布谷鸟模块工作室立即使用

bc

bizlicense

creditcard

driverlicense

general

handwriting

idcard

plate

概述

模块概述

bgnTencentOCR封装了腾讯AI开放平台的OCR解析,腾讯提供永久免费的访问策略,目前该腾讯AI开放平台的OCR解析支持:身份证OCR、行驶证驾驶证OCR、通用OCR、营业执照OCR、银行卡OCR、手写体OCR、车牌OCR、名片OCR的解析策略。

模块使用攻略

使用之前须从腾讯AI开放平台https://ai.qq.com申请开发者账号并创建应用,获取 appIdappKey,并将需要的解析能力接入申请的应用。

使用此模块之前建议先配置 config.xml 文件,配置完毕,需通过云端编译生效,配置方法如下:

  • 名称:bgnTencentOCR
  • 参数:appKey、appSecret
  • 配置示例:
 <feature name="bgnTencentOCR"> 
    <param name="appId" value="87522136541"/>  
    <param name="appKey" value="ZWX6YTQcX1asw0m8e5"/> 
  </feature>

模块接口

bc

名片OCR解析

bc({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/ocrbcocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.bc({
    image:"/9j/4Rk8RXhpZgAATU0AKg......"
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

bizlicense

营业执照OCR解析

bizlicense({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/ocrbizlicenseocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.bizlicense({
    image:"/9j/4Rk8RXhpZgAATU0AKg......"
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

creditcard

银行卡OCR解析

creditcard({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/ocrcreditcardocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.creditcard({
    image:"/9j/4Rk8RXhpZgAATU0AKg......",
     type:0
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

driverlicense

行驶证驾驶证OCR解析

driverlicense({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据。

type:

  • 类型:数值
  • 描述:(必填项)识别类型,0-行驶证识别,1-驾驶证识别。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/ocrdriverlicenseocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.driverlicense({
    image:"/9j/4Rk8RXhpZgAATU0AKg......",
     type:0
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

general

通用OCR解析

general({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/ocrgeneralocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.general({
    image:"/9j/4Rk8RXhpZgAATU0AKg......"
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

handwriting

手写体OCR解析

handwriting({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/handwritingocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.handwriting({
    image:"/9j/4Rk8RXhpZgAATU0AKg......"
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

general

通用OCR解析

general({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/ocrgeneralocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.general({
    image:"/9j/4Rk8RXhpZgAATU0AKg......"
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

idcard

银行卡OCR解析

idcard({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据。

card_type:

  • 类型:数值
  • 描述:(必填项)身份证图片类型,0-正面,1-反面。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/ocrcreditcardocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.idcard({
    image:"/9j/4Rk8RXhpZgAATU0AKg......"
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

plate

车牌OCR解析

plate({params}, callback(ret, err))

params

image:

  • 类型:字符串
  • 描述:(必填项)base64格式图片数据或者图片url地址。

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    status: true      //布尔型;true||false,是否解析成功
    data:JSON格式的数据对像,请参照https://ai.qq.com/doc/plateocr.shtml
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    code: 0     //数字类型;
                    //错误码:参考https://ai.qq.com/doc/returncode.shtml

    msg:    //错误消息
}

示例代码

var OCR= api.require('bgnTencentOCR');
OCR.plate({
    image:"/9j/4Rk8RXhpZgAATU0AKg......"
},function(ret, err) {
    if (ret.status) {
        alert(JSON.stringify(ret));
    }else{
       alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本