百度智能云-自定义模版文字识别iOCR

Installation

yarn add --dev @dfeidao/fd-an000006

参数

参数 | 描述 --|-- app_id | 从百度智能云申请的AppID api_key |从百度智能云获取的ApiKey secret_key | 从百度智能云获取的Secret Key images |图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式 template_sign | 百度智能云上创建的自定义模板ID(templateSign),见文末说明

返回值

名称 | 说明 --|-- msg | 值为success，成功 template_sign | iOCR模板ID template_name | iOCR模板名称 name_pinyin | 姓名拼音,该字段名称需要在iOCR模板中自己定义 credentials_number | 证件号码,该字段名称需要在iOCR模板中自己定义 gender | 性别,该字段名称需要在iOCR模板中自己定义 issuing_authority | 签发机关,该字段名称需要在iOCR模板中自己定义 name | 姓名,该字段名称需要在iOCR模板中自己定义 valid_time | 有效日期,该字段名称需要在iOCR模板中自己定义 born_date | 出生日期,该字段名称需要在iOCR模板中自己定义 renewal_number | 换证次数,该字段名称需要在iOCR模板中自己定义

result_success

{
	"msg": "success",
	"template_sign": "xxxxxxxxxxxxxxxxx",
	"template_name": "回乡证",
	"name_pinyin": "CESHIYANGBEN",
	"credentials_number": "000000000",
	"gender": "女",
	"issuing_authority": "公安部出入境管理局",
	"name": "测试样本",
	"valid_time": "2019.04.12-2024.04.11",
	"born_date": "2011.11.16",
	"renewal_number": "00"
}

result_error

{
	// 图片识别失败,可以更换清晰的图片
	"msg":"structure failed",
	"detail":"structure failed"
}

{
	// api_key错误认证失败
	"msg":"IAM Certification failed",
	"detail":"IAM Certification failed"
}

{
	// template_sign参数错误
	"msg":"invalid parameter, appId doesn't own this template nor not launch",
	"detail":"invalid parameter, appId doesn't own this template nor not launch"
}

{	// 图片错误
	"msg":"image size error,image is too big or too small,upper limit 4M, lower limit 1k,please check your param","detail":"image size error,image is too big or too small,upper limit 4M, lower limit 1k,please check your param"
}

Example

1. 客户端通过把base64格式的图片传到服务端
2. 服务端调用 @dfeidao/fd-an000006 护照识别原子操作进行识别
3. 需要注意的是 app_id, api_key, secret_key, template_sign不要出现在客户端，仅限在服务端出现

import an006 from '@dfeidao/fd-an000006';

export default async function atom(message: Message, action_id: string, session_id: string, headers: IncomingHttpHeaders): Promise<IWebResult> {
	try {
		const img = message.img;
		const res = await an006('app_id', 'api_key', 'secret_key', message.img, 'template_sign');
	} catch (error) {
		// 获取到具体的错误信息
		console.log(error);
	}
}