# Ocr

• 方法
  • getOcrServices 获取OCR支持的服务
  • startOcr OCR识别类型
  • startOcrWithHeHe 合合OCR识别类型

# getOcrServices

获取OCR支持的服务

• 参数说明

  参数名	类型	必填	说明
  sdkType	String	是	OCR sdk厂商信息（目前仅支持百度）,默认'Baidu',可选'合合'
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请插件全局状态码
  message	String	调用结果信息
  payload	Object{ocrSupports}	详细结果,见下表

• ocrSupports返回数据类型枚举

  • '0': '通用文字识别'
  • '2': '身份证正面识别'
  • '3': '身份证背面识别'
  • '4': '银行卡识别'
  • '5': '网络图片识别'
  • '6': '驾驶证证识别'
  • '7': '行驶证识别'
  • '8': '车牌识别'
  • '9': '营业执照识别'
  • '10': '票据识别'

• 示例代码

foxsdk.ocr.getOCRServices('', ret => {
    console.log('ocr/getOCRServices===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# startOcr

ocr识别

• 参数说明

  参数名	类型	必填	说明
  RecognizeType	String	是	识别类型
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发
  needBase64	String	可选	是否返回base64图片信息，"1"表示需要返回base64编码，其他不返回,默认0

• RecognizeType类型枚举

  • '0': '通用文字识别'
  • '1': '身份证识别'
  • '2': '身份证正面识别'
  • '3': '身份证背面识别'
  • '4': '银行卡识别'
  • '5': '网络图片识别'
  • '6': '驾驶证证识别'
  • '7': '行驶证识别'
  • '8': '车牌识别'
  • '9': '营业执照识别'
  • '10': '票据识别'

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请插件全局状态码
  message	String	调用结果信息
  payload	Object	调用结果，详见下表

• 返回payload参数说明

  参数名	类型	说明
  imagePath	String	识别图片缓存路径(Base64)
  ocrReuslt	Object	识别结果具体对象, 详见下表

• 返回ocrReuslt参数说明

  参数名	类型	说明
  log_id	String	日志标识
  words_result_num	Number	返回结果单词数量
  words_result	Array[{words:"",location:{}}]	返回结果单词数据

• 示例代码

foxsdk.ocr.startOCR('0', ret => {
    console.log('ocr/startOCR===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});

# startocrwithhehe

合合OCR识别类型

• 参数说明

  参数名	类型	必填	说明
  RecognizeType	String	是	识别类型
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发
  needBase64	String	可选	是否返回base64图片信息，"1"表示需要返回base64编码，其他不返回,默认0
  ocrWithHeHeAppKey	String	必传	合合ocrsdk 的AppKey
  ocrWithHeHeSubKey	String	必传	合合ocrsdk 的AppSecrect

• RecognizeType类型枚举

  • '0': '通用文字识别'
  • '1': '身份证识别'
  • '2': '身份证正面识别'
  • '3': '身份证背面识别'
  • '4': '银行卡识别'
  • '5': '网络图片识别'
  • '6': '驾驶证证识别'
  • '7': '行驶证识别'
  • '8': '车牌识别'
  • '9': '营业执照识别'
  • '10': '票据识别'

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请插件全局状态码
  message	String	调用结果信息
  payload	Object	调用结果，详见下表

• 返回payload参数说明

  参数名	类型	说明
  ImagePath	String	识别图片缓存路径(Base64)
  HeadImgPath	String	识别图片缓存路径(Base64)
  IdShotsPath	String	识别图片缓存路径(Base64)
  Name	String	身份证名字
  Gender	String	性别
  Nation	String	名族
  Birthday	String	生日
  Address	String	地址
  ID Card No	String	id编号

• 示例代码

foxsdk.ocr.startOCRWithHeHe({RecognizeType:'1',needBase64:true,ocrWithHeHeAppKey:'jdkasjkfdjas',ocrWithHeHeSubKey:''}, ret => {
    console.log('ocr/startOCRWithHeHe===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' + JSON.stringify(ret.payload));
});