@wecity/weda-plugin-ocr

0.0.1-alpha14 • Public • Published

WeDa-ORC插件

基于WeDa的腾讯云风格OCR插件

使用方法

安装

在WeDa中安装npm依赖 @wecity/weda-plugin-ocr

使用
  1. 引入依赖
    import ocr from '@wecity/weda-plugin-ocr'
  2. 调用ocr.start方法,详细参数见注释
    const result = await ocr.start({
    
      /** OCR识别类型,必填
       * 例如身份证的业务类型是IDCardOCR
       * 其他证件业务类型请在腾讯云服务端API文档对应业务的Action取值中获取
       **/
       action: 'IDCardOCR',  
    
       /**
        * 获取临时密钥的函数,必填。是一个返回 {temSecretId,temSecretKey,token}对象的异步函数
        * 为了确保数据安全,本插件只支持临时密钥,请自行部署获取临时密钥接口服务
        * 参考:https://cloud.tencent.com/document/product/866/49461#getauthorization.3A
        **/
       getAuthorization: () => {}, 
    
       /**
        * 是否禁用相册,非必填,默认为false
        **/
       disableAlbum: false,  
    
       /**
        * 选择框方向,非必填 ,默认为vertical ,可选值为 vertical、horizontal
        **/
       selectionAreaDirection: 'vertical', 
       
       /** 请求额外参数,非必填。
        * 可包含腾讯云服务端API文档中当前类型的OCR接口中除了 Action、Version、Region、ImageBase64、ImageUrl 之外的参数。
        * 如身份证识别场景中(https://cloud.tencent.com/document/product/866/33524#2.-.E8.BE.93.E5.85.A5.E5.8F.82.E6.95.B0)可按需传入 {CardSide,Config}
        **/
       ocrOption: {}
    })
    
     /** 返回值结构:
     * 如果返回值包含Error字段,则说明识别错误,请根据错误信息进行处理;
     * 否则说明识别成功,此时返回值的内容和腾讯云服务端API文档中当前类型的OCR接口返回值一致。
     * 如身份证识别场景中(https://cloud.tencent.com/document/api/866/33524#3.-.E8.BE.93.E5.87.BA.E5.8F.82.E6.95.B0)返回值为 {Name,Sex,Nation,...}
     **/ 
    if(result.Error) {
      console.error(result.Error.Message)
    }else {
      console.log(result)
    }

Readme

Keywords

none

Package Sidebar

Install

npm i @wecity/weda-plugin-ocr

Weekly Downloads

1

Version

0.0.1-alpha14

License

ISC

Unpacked Size

277 kB

Total Files

13

Last publish

Collaborators

  • loopzhou
  • zystylish
  • brian_zhang
  • legendlu
  • fenfeizeng
  • colinczhu
  • easonruan
  • yikazhu
  • daniel-dx
  • domy
  • delenzhang
  • vickiliang
  • derrickliu
  • xiaoyaojones
  • smileswlin
  • jillysong
  • allennzhang
  • sharryliao
  • pechelhuang
  • phspan