华为云用户手册

  • 响应参数 根据识别的结果,可能有不同的HTTP响应状态码(status code)。例如,200表示API调用成功,400表示调用失败,详细的状态码和响应参数说明如下。 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result BusinessLicenseResult object 识别结果。 调用失败时不返回此字段。 表5 BusinessLicenseResult 参数 参数类型 描述 registration_number String 老版本营业执照对应注册号。 新三证合一版本营业执照对应社会保障号。 name String 企业名称。 type String 公司/企业类型/主体类型。 address String 住所/营业场所/企业住所。 legal_representative String 法定代表人/负责人。 registered_capital String 注册资本。 found_date String 成立日期。 business_term String 营业期限。 说明: 若无截止日期,默认返回长期。 business_scope String 经营范围。 issue_date String 发照日期。 confidence Object 字段的置信度,取值范围0~1。 置信度越大,本次识别的字段的可靠性越高,在统计意义上,置信度越大,准确率越高。 置信度由算法给出,不直接等价于字段的准确率。 状态码: 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码,具体请参见错误码。 当出现错误码“ModelArts.4204”时,请参考为什么调用API时提示“ModelArts.4204”?章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。
  • URI POST /v2/{project_id}/ocr/business-license 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
  • 响应示例 状态码:200 成功响应示例 { "result" : [ { "status" : { "error_code" : "AIS.0000", "error_msg" : "Succeeded." }, "type" : "quota_invoice", "location" : [ [ 65, 1006 ], [ 1388, 1006 ], [ 1388, 1863 ], [ 65, 1863 ] ], "content" : { "code" : "131001661301", "number" : "40300888", "amount" : "¥50.00", "location" : "上海", "confidence" : { "code" : 0.9253, "number" : 0.9665, "amount" : 0.9848, "location" : 0.9847 } }, "seal_mark" : true }, { "status" : { "error_code" : "AIS.0000", "error_msg" : "Succeeded." }, "type" : "quota_invoice", "location" : [ [ 621, 605 ], [ 1328, 605 ], [ 1328, 1094 ], [ 621, 1094 ] ], "content" : { "code" : "131001661301", "number" : "40300888", "amount" : "¥100.00", "location" : "上海", "confidence" : { "code" : 0.9556, "number" : 0.9455, "amount" : 0.9917, "location" : 0.9347 } }, "seal_mark" : true }, { "status" : { "error_code" : "AIS.0104", "error_msg" : "The image is not supported or the image quality is poor." }, "type" : "quota_invoice", "location" : [ [ 816, 103 ], [ 2125, 103 ], [ 2125, 978 ], [ 816, 978 ] ], "content" : { }, "seal_mark" : false } ] } 状态码:400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }
  • 请求示例 “endpoint”即调用API的请求地址,不同服务不同区域的“endpoint”不同,具体请参见终端节点。 例如,智能分类识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/auto-classification”,“project_id”为项目ID,获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入图片的base64编码,进行图片分类和内容识别 POST https://{endpoint}/v1.0/ocr/auto-classification Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入图片的url,进行图片分类和内容识别 POST https://{endpoint}/v2/{project_id}/ocr/auto-classification Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 企业项目创建步骤请参见用户指南。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用OCR服务,账单归到企业ID对应的企业项目中。 携带错误的ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 不携带ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 表4 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码,要求Base64编码后大小不超过10MB。 图片最短边不小于15px,最长边不超过8000px,支持JPEG、JPG、PNG、BMP、TIFF、PDF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...,带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径,目前支持: 公网http/https url例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0000001222608606.png OBS提供的url,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权,详情参见配置OBS访问权限。 说明: 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。 url中不能存在中文字符,若存在,中文需要进行utf8编码。 type_list 否 List 输入图片中,待识别票证的类型,指定后不出现在type_list参数中的票证不识别。不指定时默认返回所有支持类别票证的识别信息。 当前版本支持的票证类型请参见表5。 extended_parameters 否 Object 可指定需要识别票证的传入参数,具体参数可参考各票证API文档。若不指定则默认传入image 。当前版本支持票证类型如下: vat_invoice:增值税发票(含全电发票) quota_invoice:定额发票 taxi_invoice:出租车票 train_ticket:火车票 flight_itinerary:飞机行程单 toll_invoice:车辆通行费发票 mvs_invoice:机动车销售发票 id_card:身份证 passport:护照 driver_license:驾驶证 vehicle_license:行驶证 transportation_license:道路运输证 bankcard:银行卡 bus_ship_ticket:车船票 ride_hailing_itinerary:网约车行程单 machine_printed_invoice:通用机打发票 vat_invoice_sales_list:增值税发票(销货清单) 增值税发票传参示例: "extended_parameters" : { "vat_invoice" : { "advanced_mode" : true, "return_text_location" : true } } 车船票传参示例: "extended_parameters" : { "bus_ship_ticket":{ "return_text_location" : true //开启返回识别到的文字块的区域位置信息。 } } 通用机打发票传参示例: "extended_parameters" : { "machine_printed_invoice":{ "pdf_page_number" : 1 //指定PDF页码识别,如果不传该参数,则默认识别第1页。 } } 说明: 若指定票证参数填写错误会导致该票证识别错误,会提示"AIS.0101":"The input parameter is invalid."报错。 detect_seal 否 Boolean 检测印章开关,开启时则返回单张票证是否含有印章,否则不返回是否含有印章。可选值包括: true:开启检测票证是否含有印章功能。 false:关闭检测票证是否含有印章功能。 说明: 该功能仅检测判断有无印章,不返回印章具体内容。 表5 支持票证类型 票证类型 参数值 身份证头像面 id_card_portrait_side 身份证国徽面 id_card_emblem_side 行驶证主页 vehicle_license_front 行驶证副页 vehicle_license_back 驾驶证主页 driver_license_front 驾驶证副页 driver_license_back 护照 china_passport或foreign_passport 银行卡 bankcard 道路运输证 transportation_license 增值税发票(含全电发票) vat_invoice 如果输入数据为全电发票,API除返回vat_invoice外。会同时返回全电发票类型: fully_digitalized_special_electronic:全电专用发票 fully_digitalized_normal_electronic:全电普通发票 增值税普通发票(卷票) vat_roll_invoice 增值税发票(销货清单) vat_invoice_sales_list 机动车销售统一发票 mvs_invoice 出租车发票 taxi_invoice 火车票 train_ticket 定额发票 quota_invoice 车辆通行费发票 toll_invoice 飞机行程单 flight_itinerary 车船票 bus_ship_ticket 网约车行程单 ride_hailing_itinerary 通用机打发票 machine_printed_invoice
  • URI POST /v2/{project_id}/ocr/auto-classification 表2 路径参数 参数 是否必选 说明 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
  • 功能介绍 检测定位图片上指定要识别的票证(票据、证件或其他文字载体),并以JSON格式返回识别的结构化结果。 接口以列表形式返回图片上要识别票证的位置坐标、结构化识别的内容以及对应的类别。该接口支持的票证类型请见表1,该接口的使用限制请参见约束与限制,详细使用指导请参见OCR服务使用简介章节。 图1 智能分类示例图 表1 支持票证类型 票证类型 身份证头像面 银行卡 身份证国徽面 道路运输证 行驶证主页 增值税发票(含全电发票) 行驶证副页 增值税普通发票(卷票) 驾驶证主页 机动车销售统一发票 驾驶证副页 出租车发票 护照 火车票 车辆通行费发票 定额发票 飞机行程单 车船票 网约车行程单 通用机打发票 增值税发票(销货清单) - 智能分类服务只对识别成功的票证进行计费,识别失败的票证不计费。例如,图片中包含三张票证,有两张识别成功,一张识别失败,此时接口计费两次。
  • 请求示例 “endpoint”即调用API的请求地址,不同服务不同区域的“endpoint”不同,具体请参见终端节点。 例如,VIN码识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/vin”,“project_id”为项目ID,获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入车架号VIN码图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/vin Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入车架号VIN码图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/vin Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }
  • URI POST /v2/{project_id}/ocr/vin 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 企业项目创建步骤请参见用户指南。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用OCR服务,账单归到企业ID对应的企业项目中。 携带错误的ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 不携带ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 说明 image 否 String 该参数与url二选一。 图片的Base64编码,要求Base64编码后大小不超过10MB。 图片最短边不小于15px,最长边不超过4096px,支持JPEG、JPG、PNG、BMP、TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...,带有多余前缀会产生The image format is not supported报错。 url 否 String 该参数与image二选一。图片的url路径,目前支持: 公网http/https url OBS提供的url,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权,详情参见配置OBS访问权限。 说明: 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。 url中不能存在中文字符,若存在,中文需要进行utf8编码。
  • 响应参数 根据识别的结果,可能有不同的HTTP响应状态码(status code)。例如,200表示API调用成功,400表示调用失败,详细的状态码和响应参数说明如下。 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result VINResult object 识别结果。 调用失败时不返回此字段。 表5 VINResult 参数 参数类型 描述 vin String 识别检测到的车架号。 状态码: 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码,具体请参见错误码。 当出现错误码“ModelArts.4204”时,请参考为什么调用API时提示“ModelArts.4204”?章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。
  • URI POST /v2/{project_id}/ocr/colombia-id-card 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
  • 请求示例 Endpoint即调用API的请求地址,不同服务不同区域的Endpoint不同,具体请参见终端节点。 例如,哥伦比亚身份证识别服务部署在“拉美-圣地亚哥”区域的“endpoint”为“ocr.la-south-2.myhuaweicloud.com”,请求URL为“https://ocr.la-south-2.myhuaweicloud.com/v2/{project_id}/ocr/colombia-id-card”,“project_id”为项目ID,获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入哥伦比亚身份证图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/colombia-id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入哥伦比亚身份证图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/colombia-id-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName" }
  • 响应示例 状态码: 200 成功响应示例 { "result" : { "side" : "front", "number" : "1.039xxxx", "name" : "VALENxxx", "last_name" : "SANCHxxxx", "confidence" : { "number" : 0.9888, "name" : 0.9969, "last_name" : 0.9959 } } } 状态码: 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }
  • 约束与限制 支持哥伦比亚身份证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 图像各边的像素大小在15px到8000px之间。 图像中身份证区域有效占比超过80%,保证整张身份证内容及其边缘包含在图像内。 支持图像中身份证任意角度的水平旋转。 支持少量扭曲,扭曲后图像中的身份证长宽比与实际身份证相差不超过10%。 能处理反光、暗光等干扰的图片但影响识别精度。 目前只支持识别单张身份证的正面或者反面。
  • 响应示例 状态码: 200 成功响应样例 { "result" : { "template_id" : "43580526-658f-11ed-863a-0242ac11000b", "template_name" : "3", "confidence" : 0.4057 }, "template_id" : "43580526-658f-11ed-863a-0242ac11000b" } 状态码: 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }
  • 请求示例 “endpoint”即调用API的请求地址,不同服务不同区域的“endpoint”不同,具体请参见终端节点。 例如,自定义模板OCR部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/custom-template”,“project_id”为项目ID,获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入自定义模板OCR的图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/custom-template Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "classifier_id" : "3bed12e0-7c1e-11ed-9bdb-0255ac10009d", "classifier_mode" : true } 传入自定义模板OCR的图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/custom-template Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName", "classifier_id" : "3bed12e0-7c1e-11ed-9bdb-0255ac10009d", "classifier_mode" : true }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 企业项目创建步骤请参见用户指南。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用OCR服务,账单归到企业ID对应的企业项目中。 携带错误的ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 不携带ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 描述 image 否 String 与url二选一 图像数据,base64编码,要求base64编码后大小不超过10MB。图片最小边不小于15px,最长边不超过8192px,支持JPEG、JPG、PNG、BMP、TIFF、GIF、WEBP格式。 图片文件Base64编码字符串,单击这里查看详细获取方式。 url 否 String 与image二选一 图片的URL路径,目前支持: 公网http/https url OBS提供的url,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权,详情参见配置OBS访问权限。 说明: 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。 template_id 否 String 该参数与classifier_id二选一。 模型id,如果传入,启用单模板识别模式。 classifier_id 否 String 该参数与template_id二选一。 分类器id,如果传入,启用多模板识别模式。 classifier_mode 否 Boolean 该参数与classifier_id参数配合使用,可选值如下所示: true:仅返回模板分类结果 false:正常返回多模板识别结果 说明: 如果未传入该参数时默认为false,即正常返回多模板识别结果。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result Object 调用成功时表示调用结果。 调用失败时无此字段。 template_id String 调用成功时返回调用模板id。 调用失败时无此字段。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 约束与限制 只支持识别PNG、JPG、PNG、BMP、TIFF、GIF、WEBP格式图片。 图像各边的像素大小在100px到8000px之间。 图像中识别区域有效占比超过80%,保证整张表格及其边缘包含在图像内。 支持图像任意角度的水平旋转。 目前不支持复杂背景(如户外自然场景、防伪水印等)和表格线扭曲图像的文字识别。 支持中英文以及部分繁体字。 API支持识别的图片版式依赖于创建自定义OCR工作流时的类型。
  • URI POST /v2/{project_id}/ocr/custom-template 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
  • 请求示例 Endpoint即调用API的请求地址,不同服务不同区域的Endpoint不同,具体请参见终端节点。 例如,核酸检测记录服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”或“ocr.cn-north-4.myhuaweicloud.cn”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/pcr-test-record”,“project_id”为项目ID,获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入核酸检测记录图片的base64编码进行文字识别 POST https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/pcr-test-record Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." }
  • 约束与限制 支持全国不同地区健康码小程序中的核酸检测记录界面的识别。 支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 图像各边的像素大小在15px到8192px之间。 图像中核酸检测记录区域有效占比超过80%,保证整张核酸检测记录内容及其边缘包含在图像内。 推荐采用手机截图图像。 支持图像中核酸检测记录界面任意角度的水平旋转(需开启方向检测)。 能处理反光、暗光等干扰的图片但影响识别精度。 目前只支持识别单张核酸检测记录界面。
  • URI POST /v2/{project_id}/ocr/pcr-test-record 表1 路径参数 参数 是否必选 描述 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
  • 功能介绍 支持对全国各地不同版式的核酸检测记录中的4个关键字段进行结构化识别,包括姓名、核酸检测采样时间、检测检测结果更新时间、核酸检测结果(阳性、阴性、未知) 图1 核酸检测记录版式示例 防疫健康码识别已推出三码合一功能(健康码、核酸检测记录、行程卡)。相比于核酸检测记录识别API,您只需要调用1个接口,即可智能结构化识别健康码、核酸检测记录、行程卡等页面信息,包括防疫码类别、姓名、身份证号码、手机号码、省份、城市、健康码或行程卡的更新时间、健康码或行程卡颜色、疫苗接种情况、核酸检测结果、核酸检测机构、核酸检测结果更新时间、核酸检测采样时间、行程卡的途经地址等14个关键字段。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 Content-Type 是 String 发送的实体的MIME类型,参数值为“application/json”。 Enterprise-Project-Id 否 String 企业项目ID。OCR支持通过企业项目管理(EPS)对不同用户组和用户的资源使用,进行分账。 获取方法:进入“企业项目管理”页面,单击企业项目名称,在企业项目详情页获取Enterprise-Project-Id(企业项目ID)。 企业项目创建步骤请参见用户指南。 说明: 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用OCR服务,账单归到企业ID对应的企业项目中。 携带错误的ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 不携带ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 描述 image 否 String 图片的Base64编码,图片尺寸不小于15×15像素,最长边不超过8192像素,支持JPG/PNG/BMP/TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...,带有多余前缀会产生The image format is not supported报错。 url 否 String 与image二选一 图片的URL路径,目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。 detect_direction 否 Boolean 是否校正图片的倾斜角度,可选值如下: true:校正图片的倾斜角度 false:不校正图片的倾斜角度 支持任意角度的校正,未传入该参数时默认为“false”。 待识别图片如果存在倾斜,建议将此参数设置为“true”。
  • 请求示例 Endpoint即调用API的请求地址,不同服务不同区域的Endpoint不同,具体请参见终端节点。 例如,承兑汇票识别服务部署在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/acceptance-bill”,“project_id”为项目ID,获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入承兑汇票图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/acceptance-bill Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入承兑汇票图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/acceptance-bill Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName" }
  • 响应示例 状态码: 200 成功响应样例 { "result" : { "issue_date" : "20xx-07-10", "bill_status" : "背书待签收", "due_date" : "20xx-01-10", "bill_number" : "130212XXX", "issuer_account" : "811180XXX", "payee_account" : "793201XXX", "issuer_full_name" : "XX集团有限公司", "issuer_bank_name" : "XX银行股份有限公司XX支行", "issuer_bank_number" : "302121XXX", "payee_full_name" : "XX有限公司", "payee_bank_name" : "XX银行股份有限公司XX分行", "payee_bank_number" : "303124XXX", "amount_in_figures" : "¥XXX", "amount_in_words" : "XXX元整", "acceptor_bank_name" : "XX银行XX分行", "acceptor_full_name" : "XX银行XX分行", "acceptor_bank_number" : "302121XXX", "issuer_commitment" : "本汇票请予以承兑,到期无条件付款", "acceptor_commitment" : "本汇票已经承兑,到期无条件付款", "assignability" : "可再转让", "acceptance_date" : "20xx-07-10", "issuance_guarantor_name" : "xx", "issuance_guarantor_address" : "xx", "issuance_guarantor_account" : "xx", "issuance_guarantee_date" : "xx", "issuance_guarantor_bank_number" : "xx", "issuance_guarantor_bank_name" : "xx", "acceptor_account" : "xx", "contract_number" : "xx", "acceptance_guarantor_name" : "xx", "acceptance_guarantor_address" : "xx", "acceptance_guarantor_account" : "xx", "acceptance_guarantee_date" : "xx", "acceptance_guarantor_bank_number" : "xx", "acceptance_guarantor_bank_name" : "xx", "issuer_rating_entity" : "xx", "issuer_credit_rating" : "xx", "issuer_rating_due_date" : "xx", "acceptor_rating_entity" : "xx", "acceptor_credit_rating" : "xx", "acceptor_rating_due_date" : "xx", "remarks" : "xxx", "bill_package_number" : "xx", "confidence" : { "issue_date" : 0.9998, "bill_status" : 0.9997, "due_date" : 0.9999, "bill_number" : 1.0, "issuer_account" : 1.0, "payee_account" : 1.0, "issuer_full_name" : 1.0, "issuer_bank_name" : 0.9999, "issuer_bank_number" : 0.999, "payee_full_name" : 1.0, "payee_bank_name" : 0.9999, "payee_bank_number" : 0.9999, "amount_in_figures" : 0.9999, "amount_in_words" : 0.9998, "acceptor_account" : 0.0, "acceptor_bank_name" : 0.9997, "acceptor_full_name" : 0.9999, "acceptor_bank_number" : 0.9998, "issuer_commitment" : 0.9998, "acceptor_commitment" : 1.0, "assignability" : 1.0, "acceptance_date" : 1.0, "issuance_guarantor_name" : 0.0, "issuance_guarantor_address" : 0.0, "issuance_guarantor_account" : 0.0, "issuance_guarantee_date" : 0.0, "issuance_guarantor_bank_number" : 0.0, "issuance_guarantor_bank_name" : 0.0, "contract_number" : 0.0, "acceptance_guarantor_name" : 0.0, "acceptance_guarantor_address" : 0.0, "acceptance_guarantor_account" : 0.0, "acceptance_guarantee_date" : 0.0, "acceptance_guarantor_bank_number" : 0.0, "acceptance_guarantor_bank_name" : 0.0, "issuer_rating_entity" : 0.0, "issuer_credit_rating" : 0.0, "issuer_rating_due_date" : 0.0, "acceptor_rating_entity" : 0.0, "acceptor_credit_rating" : 0.0, "acceptor_rating_due_date" : 0.0, "remarks" : 0.0, "bill_package_number" : 0.0 } } } 状态码: 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result AcceptanceBillResult object 调用成功时表示调用结果。 调用失败时无此字段。 表5 AcceptanceBillResult 参数 参数类型 描述 issue_date String 出票日期。 due_date String 汇票到期日。 bill_status String 票据状态。 bill_number String 票据号码。 issuer_full_name String 出票人全称。 issuer_account String 出票人账号。 issuer_bank_name String 出票人开户银行。 issuer_bank_number String 出票人开户行号。 payee_full_name String 收款人全称。 payee_account String 收款人账号。 payee_bank_name String 收款人开户银行。 payee_bank_number String 收款人开户行号。 issuance_guarantor_name String 出票保证人名称。 issuance_guarantor_address String 出票保证人地址。 issuance_guarantor_account String 出票保证人账号。 issuance_guarantee_date String 出票保证日期。 issuance_guarantor_bank_number String 出票保证人开户行行号。 issuance_guarantor_bank_name String 出票保证人开户行名称。 amount_in_words String 大写票据金额。 amount_in_figures String 小写票据金额。 acceptor_full_name String 承兑人全称。 acceptor_account String 承兑人账号。 acceptor_bank_number String 承兑人开户行行号。 acceptor_bank_name String 承兑人开户行名称。 contract_number String 交易合同号。 assignability String 能否转让。 issuer_commitment String 出票人承诺。 acceptor_commitment String 承兑人承诺。 acceptance_date String 承兑日期。 acceptance_guarantor_name String 承兑保证人名称。 acceptance_guarantor_address String 承兑保证人地址。 acceptance_guarantor_account String 承兑保证人账号。 acceptance_guarantee_date String 承兑保证日期。 acceptance_guarantor_bank_number String 承兑保证人开户行行号。 acceptance_guarantor_bank_name String 承兑保证人开户行名称。 issuer_rating_entity String 出票人评级主体。 issuer_credit_rating String 出票人信用等级。 issuer_rating_due_date String 出票人评级到期日。 acceptor_rating_entity String 承兑人评级主体。 acceptor_credit_rating String 承兑人信用等级。 acceptor_rating_due_date String 承兑人评级到期日。 bill_package_number String 票据包号。 remarks String 备注。 confidence Object 各个字段的置信度。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码。调用成功时无此字段。 error_msg String 调用失败时的错误信息。调用成功时无此字段。
  • URI POST /v2/{project_id}/ocr/acceptance-bill 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
共100000条