华为云用户手册

  • JavaAgent下载地址 区域 下载地址 历史版本下载地址 华北-北京四 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华北-北京一 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华东-上海一 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华东-上海二 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华南-广州 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 亚太-新加坡 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华南-广州-友好用户环境 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华北-乌兰察布一 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华北-乌兰察布二零一 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华北-乌兰察布二零二 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b 2.4.1 sha256:c31cd55ead0b2172eb694fe402242b09caeb67d7059aaf4060258633d9ade9f8 2.3.19 sha256:8755abcd541797ebf900f8f1767d62678b3cd57a6d8e045dcfb2f8c24885bfce 2.3.17 sha256:8893e89cd3174879232704828027fd636471525d6e5772ff77e3313f79a4b6b5 华北-乌兰察布汽车一 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b - - - 西南-贵阳一 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b - - - 中国-香港 2.4.5 sha256:37b155626f46f3a8b19772e3fd6597ece92bb255fdffa21e3e9e1467cc009392 2.4.4 sha256:f60b55d646fe592c427143f1c8d8e8f277a647a3dd73dcdca43d7d37655ec573 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b - - - 墨西哥城二 2.4.3 sha256:73de7b49e148b102b74a6075c3d8b25e76f43d6144ec5aafe6ac190ab3c1ef0b - - - - -
  • 关于用户欠费后消息&短信服务调整的通知 尊敬的华为云用户: 华为云计划于2024年4月15日 00:00:00(北京时间)对用户欠费后的消息&短信服务做出调整。调整详情如下: 您的账号欠费后,账号下的按需服务将按规则进入宽限期、保留期,影响如下: 类型 调整前 调整后 宽限期 可以继续使用短信服务 已添加的短信签名和短信模板不会被删除 无法使用短信服务 已添加的短信签名和短信模板不会被删除 保留期 无法使用短信服务 已添加的短信签名和短信模板不会被删除 如您有任何问题,请随时通过工单与我们联系。 感谢您对华为云的支持!
  • 请求示例 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/transportation-qualification-certificate”,“project_id”为项目ID,获取方法请参见获取项目ID获取项目ID。 如何获取Token请参见认证鉴权。 传入道路运输从业资格证图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/transportation-qualification-certificate Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入道路运输从业资格证图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/transportation-qualification-certificate Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName" }
  • 响应示例 状态码: 200 成功响应示例 { "result" : { "id_number" : "140xxxxxxxxxxxxxxx", "assessment_date" : "11月11日", "certificate_number" : "22038119xxxxxxxxxx", "file_number" : "3704020030xxxxxxxxxxxxxxxxx", "union_card_number" : "3105060xxxxxxxxxxxx", "continuing_education_info" : "2020年11月-2022年11月", "sex" : "男", "phone_number" : "139xxxxxxxx", "registration_date" : "2016年07月13日", "work_unit" : "无", "integrity_assessment_info" : "AAA 2019年11月-2020年11月", "nationality" : "中国", "name" : "xxx", "address" : "吉林省xxxx", "driving_class" : "A2", "issuing_authority" : "长春市交通运输局", "birth_date" : "1979/12/22", "qualification_category_list" : [ { "category" : "经营性道路货物运输驾驶员", "initial_issue_date" : "2006年04月03日", "issue_date" : "2021年06月22日", "expiry_date" : "2027年06月22日" } ], "confidence" : { "id_number" : 0.9974, "assessment_date" : 0.9917, "certificate_number" : 0.9957, "file_number" : 0.9873, "union_card_number" : 0.9973, "continuing_education_info" : 0.9795, "sex" : 0.9863, "phone_number" : 0.8987, "registration_date" : 0.9806, "work_unit" : 0.8285, "integrity_assessment_info" : 0.9983, "nationality" : 0.995, "name" : 0.9944, "address" : 0.9565, "driving_class" : 0.5711, "issuing_authority" : 0.9234, "birth_date" : 0.9821, "qualification_category_list" : [ { "category" : 0.9979, "initial_issue_date" : 0.9883, "issue_date" : 0.9964, "expiry_date" : 0.9988 } ] } } } 状态码: 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result QualificationCertificateResult object 识别结果。 调用失败时不返回此字段。 表5 QualificationCertificateResult 参数 参数类型 描述 id_number String 身份证号(非必有,依赖对应从业资格证板式)。 assessment_date String 考核时间(非必有,依赖对应从业资格证板式)。 certificate_number String 从业资格证号。 file_number String 档案号(非必有,依赖对应从业资格证板式)。 union_card_number String 福路通号(非必有,依赖对应从业资格证板式)。 continuing_education_info String 继续教育信息(非必有,依赖对应从业资格证板式)。 sex String 性别(非必有,依赖对应从业资格证板式)。 phone_number String 联系电话(非必有,依赖对应从业资格证板式)。 registration_date String 登记时间(非必有,依赖对应从业资格证板式)。 work_unit String 单位(非必有,依赖对应从业资格证板式)。 integrity_assessment_info String 诚信考核信息(非必有,依赖对应从业资格证板式)。 nationality String 国籍(非必有,依赖对应从业资格证板式)。 name String 姓名。 address String 住址。 driving_class String 准驾车型(非必有,依赖对应从业资格证板式)。 issuing_authority String 发证机关(非必有,依赖对应从业资格证板式)。 birth_date String 出生日期(非必有,依赖对应从业资格证板式)。 qualification_category_list Array of QualificationCategory objects 从业资格列表。 confidence QualificationConfidence object 各个字段的置信度。 表6 QualificationCategory 参数 参数类型 描述 category String 从业资格类别(非必有,依赖对应从业资格证板式)。 initial_issue_date String 初次领证日期(非必有,依赖对应从业资格证板式) issue_date String 有效起始日期(非必有,依赖对应从业资格证板式) expiry_date String 有效期至xxx。 表7 QualificationConfidence 参数 参数类型 描述 id_number Float 身份证号置信度。 assessment_date Float 考核时间置信度。 certificate_number Float 从业资格证号置信度。 file_number Float 档案号置信度。 union_card_number Float 福路通号置信度。 continuing_education_info Float 继续教育信息置信度。 sex Float 性别置信度。 phone_number Float 联系电话置信度。 registration_date Float 登记时间置信度。 work_unit Float 单位置信度。 integrity_assessment_info Float 诚信考核信息置信度。 nationality Float 国籍置信度。 name Float 姓名置信度。 address Float 住址置信度。 driving_class Float 准驾车型置信度。 issuing_authority Float 发证机关置信度。 birth_date Float 出生日期置信度。 qualification_category_list Array of QualificationCategoryConfidence objects 从业资格列表置信度。 表8 QualificationCategoryConfidence 参数 参数类型 描述 category Float 从业资格类别(非必有,依赖对应从业资格证板式)。 initial_issue_date Float 初次领证日期(非必有,依赖对应从业资格证板式) issue_date Float 有效起始日期(非必有,依赖对应从业资格证板式) expiry_date Float 有效期至xxx。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。
  • 请求参数 表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)。 企业项目创建步骤请参见用户指南。 说明: 该功能仅支持开通在华东-上海一区域的API。 创建企业项目后,在传参时,有以下三类场景。 携带正确的ID,正常使用OCR服务,账单归到企业ID对应的企业项目中。 携带错误的ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 不携带ID,正常使用OCR服务,账单的企业项目会被分类为“未归集”。 表3 请求Body参数 参数 是否必选 参数类型 描述 image 否 String 与url二选一 图片的Base64编码,要求Base64编码后大小不超过10MB。 图片最短边不小于15px,最长边不超过8192px,支持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编码。
  • URI POST /v2/{project_id}/ocr/transportation-qualification-certificate 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result WaybillElectronicResult object 识别结果。 调用失败时无此字段。 表5 WaybillElectronicResult 参数 参数类型 描述 code String 三段码。 receiver_name String 收件人姓名。 receiver_phone String 收件人电话。 receiver_address String 收件人地址。 sender_name String 寄件人姓名。 sender_phone String 寄件人电话。 sender_address String 寄件人地址。 waybill_number String 条形码运单号。 confidence Object 相关字段的置信度信息,取值范围0~1。 置信度越大,表示本次识别的对应字段的可靠性越高,在统计意义上,置信度越大,准确率越高。 置信度由算法给出,不直接等价于对应字段的准确率。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 响应示例 状态码: 200 成功响应样例 { "result" : { "code" : "12345678901", "receiver_name" : "张三", "receiver_phone" : "12345678901", "receiver_address" : "深圳市龙岗区坂田街道华为基地", "sender_name" : "生活用品用品专营店", "sender_phone" : "1234567890", "sender_address" : "httpe-//", "waybill_number" : "", "confidence" : { "code" : 0.9899, "receiver_name" : 0.9898, "receiver_phone" : 0.9899, "receiver_address" : 0.9897, "sender_name" : 0.9896, "sender_phone" : 0.9899, "sender_address" : 0.8855, "waybill_number" : 0.0 } } } 状态码: 400 失败响应样例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }
  • 请求示例 传入快递单图片的base64编码进行文字识别 POST https://ocr.cn-north-4.xxxx.com/v1.0/ocr/waybill-electronic Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAAgABwESAAMAAAABAAEAAAEaAAUAAAABAAAAYgEbAAUAAAABAAAAagEoAAMAAAABAAIAAAExAAIAAAAcAAAAcgEyAAIAAAAUAAAAjodpAAQAAAABAAAApAAAANAACvyAAAAnEAAK/IAAACcQQWRvYmUgUGhvdG9zaG9wIENTMyBXaW5kb3dzADIwMTc6MTA6MjAgMTA6NDU6MzYAAAAAA6ABAAMAAAAB//8AAKACAAQAAAABAAALIKADAAQAAAABAAAGQAAAAAAAAAAGAQMAAwAAAAEABgAAARoABQAAAAEAAAEeARsABQAAAAEAAAEmASgAAwAAAAEAAgAAAgEABAAAAAEAAAEuAgIABAAAAAEAABAj..." } 传入快递单图片的url进行文字识别 POST https://ocr.cn-north-4.myhuaweicloud.com/v1.0/ocr/waybill-electronic Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.myhuaweicloud.com/ObjectName" }
  • URI POST /v2/{project_id}/ocr/waybill-electronic 表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。 图像各边的像素大小在15到8192px之间。支持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服务存储图片数据。
  • API概览 通过使用文字识别服务的自研API,您可以使用文字识别服务的所有功能,如表1所示。 文字识别服务当前支持通用类、证件类、票据类和智能分类四种不同类型的接口。您可以通过在线体验,体验接口的识别效果。 对于固定板式的图片,如果当前接口不满足您的业务需求,可以使用ModelArts Pro服务提供的文字识别套件,零代码搭建出专属的API,详细操作请参见视频指导。 服务部署区域是从地理位置和网络时延维度划分,同一个区域内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。一般情况下,建议就近选择靠近您或者您的目标用户的区域,这样可以减少网络时延,提高访问速度。对于OCR服务,不同的区域之间资源包不互通,请根据您的实际需求慎重选择。 表1 接口说明 类别 API 说明 智能文档解析 智能文档解析 对证件、票据、表单等任意版式文档进行键值对提取、文字识别、以及表格识别等任务,实现进阶高效的自动化结构化返回。 通用类 通用表格识别 识别表格图片上的文字内容,并返回识别的结构化结果。 通用文字识别 识别图片上的文字内容,并返回识别的文字和坐标。 网络图片识别 识别网络图片中的文字内容,并以JSON格式返回识别的结构化结果。支持横向、竖向、艺术字识别。 智能分类识别 检测定位图片上指定要识别的票证(票据、证件或其他文字载体),并以JSON格式返回识别的结构化结果。 手写文字识别 识别手写文字图片中的文字内容。 证件类 身份证识别 识别身份证图片中正面与反面的文字内容,并返回识别的文字和坐标。 行驶证识别 识别行驶证图片中主页与副页的文字内容,并返回识别的文字和坐标。 驾驶证识别 识别驾驶证图片中主页与副页的文字内容,并返回识别的文字和坐标。 护照识别 识别护照首页图片中的文字信息,并以JSON格式返回识别的结构化结果。 银行卡识别 识别银行卡上的关键文字信息,并以JSON格式返回识别的结构化结果。 营业执照识别 识别营业执照首页图片中的文字信息,并以JSON格式返回识别的结构化结果。 道路运输证识别 识别道路运输证首页中的文字信息,并以JSON格式返回识别的结构化结果。 车牌识别 识别车牌图片中的车牌信息,并返回其坐标和内容。 名片识别 识别名片图片上的文字信息,并返回识别的结构化结果。支持对多种不同版式名片进行结构化信息提取。 VIN码识别 识别图片中的车架号信息,并将识别结果返回给用户。 电子面单识别 识别用户上传的电子面单图片中的文字内容,并将识别的结果返回给用户。 道路运输从业资格证识别 识别道路运输从业资格证上的关键文字信息,并返回识别的结构化结果。 泰文身份证识别 识别泰国身份证中的文字信息,并以JSON格式返回识别的结构化结果。 不动产证识别 识别不动产证中的文字信息,并返回识别的结构化结果。 车辆合格证识别 识别车辆合格证中的文字信息,并返回识别的结构化结果。 哥伦比亚身份证识别 识别哥伦比亚身份证中的文字信息,并将识别的结构化结果返回给用户。 票据类 增值税发票识别 识别增值税发票图片中的文字内容,并返回识别的结构化结果。 发票验真 支持10种增值税发票的信息核验。 机动车销售发票识别 识别机动车销售发票图片中的文字内容,并返回识别的结构化结果。 出租车发票识别 识别出租车发票中的文字信息,并以JSON格式返回识别的结构化结果。 火车票识别 识别火车票中的文字信息,并以JSON格式返回识别的结构化结果 定额发票识别 识别定额发票中的文字信息,并以JSON格式返回识别的结构化结果。 车辆通行费发票识别 识别车辆通行费发票中的关键文字信息,并以JSON格式返回识别的结构化结果。 飞机行程单识别 识别飞机行程单中的文字信息,并以JSON格式返回识别的结构化结果。 财务报表识别 识别用户上传的表格图片中的文字内容,并将识别的结果返回给用户。 承兑汇票识别 识别承兑汇票识别中的关键字段, 并以json格式返回结构化结果。 行业类 防疫健康码识别 识别防疫健康码中的姓名、健康码更新时间、健康码颜色,并将识别的结构化结果返回给用户。 核酸检测记录识别 支持对全国各地不同版式的核酸检测记录中的4个关键字段进行结构化识别,包括姓名、核酸检测采样时间、检测检测结果更新时间、核酸检测结果(阳性、阴性、未知)。 保险单识别 识别保险单图片上的文字信息,并将识别的结构化结果返回给用户。支持对多板式保险单的扫描图片及手机照片进行结构化信息提取。 自定义模板 自定义模板OCR 自定义模板OCR,支持用户自定义模板,对于版式固定的各种票据和卡证,通过可视化界面操作,指定需要识别的关键字段,实现用户特定格式图片的自动识别和结构化提取。
  • 响应示例 状态码:200 成功响应示例 { "result": { "amount": "¥50.00", "code": "244031XXXX11", "location": "广东省深圳市", "number": "91XXXX61", "confidence": { "amount": 0.9971, "code": 0.9908, "location": 0.9706, "number": 0.9943 } } } 状态码:400 失败响应示例 { "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }
  • 响应参数 根据识别的结果,可能有不同的HTTP响应状态码(status code)。例如,200表示API调用成功,400表示调用失败,详细的状态码和响应参数说明如下。 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result QuotaInvoiceResult object 识别结果。 调用失败时不返回此字段。 表5 QuotaInvoiceResult 参数 参数类型 描述 number String 发票号码。 code String 发票代码。 location String 地址。 amount String 发票金额。 confidence Object 字段的置信度,取值范围0~1。 置信度越大,本次识别的字段的可靠性越高,在统计意义上,置信度越大,准确率越高。 置信度由算法给出,不直接等价于字段的准确率。 状态码: 400 表6 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码,具体请参见错误码。 当出现错误码“ModelArts.4204”时,请参考为什么调用API时提示“ModelArts.4204”?章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。
  • 请求示例 “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/quota-invoice”,“project_id”为项目ID,获取方法请参见获取项目ID 如何获取Token请参见认证鉴权。 传入定额发票图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/quota-invoice Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAg..." } 传入定额发票图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/quota-invoice 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/quota-invoice 表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例如https://support.huaweicloud.com/api-ocr/zh-cn_image_0000001528088841.png OBS提供的url,使用OBS数据需要进行授权。包括对服务授权、临时授权、匿名公开授权,详情参见配置OBS访问权限。 说明: 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。 url中不能存在中文字符,若存在,中文需要进行utf8编码。
  • 请求示例 “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/driver-license”,“project_id”为项目ID,获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入驾驶证主页图片的base64编码进行文字识别,并识别发证机关信息 POST https://{endpoint}/v2/{project_id}/ocr/driver-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA...", "side":"front", "return_issuing_authority": true } 传入驾驶证副页图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/driver-license Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName", "side":"back" }
  • 响应示例 状态码:200 成功响应示例(纸质驾驶证主页) { "result" : { "type" : "normal", "number" : "362XXXXXXXXXXXXXXXX", "name" : "张三", "sex" : "男", "nationality" : "中国", "address" : "XX省XX市XX区XX街道XX号", "birth" : "2000-03-06", "issue_date" : "2000-03-06", "class" : "C1", "valid_from" : "2004-08-26", "valid_to" : "2034-08-26" } } 成功响应示例(纸质驾驶证副页) { "result" : { "type" : "normal", "number" : "362XXXXXXXXXXXXXXXX", "name" : "张三", "file_number" : "880008886666", "record" : "实习期至2005年08月26日。" } } 状态码:400 失败响应示例 { "error_code" : "AIS.0103", "error_msg" : "The image size does not meet the requirements." }
  • 响应参数 根据识别的结果,可能有不同的HTTP响应状态码(status code)。例如,200表示API调用成功,400表示调用失败,详细的状态码和响应参数说明如下。 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result DriverLicenseResult object 识别结果。 调用失败时不返回此字段。 表5 DriverLicenseResult 参数 参数类型 描述 type String 驾驶证类型。 normal:纸质驾驶证 electronic:电子驾驶证 number String 驾驶证号。 name String 姓名。 sex String 性别。 nationality String 国籍。 address String 住址。 birth String 出生日期。 issue_date String 初次领证日期。 class String 准驾类型。 valid_from String 有效起始日期。 valid_to String 有效结束日期。 issuing_authority String 发证机关。 file_number String 档案编号。 record String 记录。 accumulated_scores String 累积记分。 status Array of strings 状态。 generation_date String 生成时间。 current_time String 当前时间。 text_location Object 对应所有在原图上识别到的字段位置信息,包含所有文字区域四个顶点的二维坐标(x,y)。采用图像坐标系,坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。 front DriverLicenseFront object 驾驶证主页。 当请求参数"side"设置为"double_side"时才返回。 back DriverLicenseBack object 驾驶证副页。 当请求参数"side"设置为"double_side"时才返回。 表6 DriverLicenseFront 参数 参数类型 描述 type String 驾驶证类型。 normal:纸质驾驶证 electronic:电子驾驶证 number String 驾驶证号。 name String 姓名。 sex String 性别。 nationality String 国籍。 address String 住址。 birth String 出生日期。 issue_date String 初次领证日期。 class String 准驾类型。 valid_from String 有效起始日期。 valid_to String 有效结束日期。 issuing_authority String 发证机关。 accumulated_scores String 累积记分。 status Array of strings 状态。 generation_date String 生成时间。 current_time String 当前时间。 file_number String 档案编号。 text_location Object 对应所有在原图上识别到的字段位置信息,包含所有文字区域四个顶点的二维坐标(x,y)。采用图像坐标系,坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。 表7 DriverLicenseBack 参数 参数类型 描述 type String 驾驶证类型。 normal:纸质驾驶证 electronic:电子驾驶证 number String 驾驶证号。 name String 姓名。 issuing_authority String 发证机关。 address String 住址。 file_number String 档案编号。 record String 记录。 text_location Object 对应所有在原图上识别到的字段位置信息,包含所有文字区域四个顶点的二维坐标(x,y)。采用图像坐标系,坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。 状态码: 400 表8 响应Body参数 参数 参数类型 说明 error_code String 调用失败时的错误码,具体请参见错误码。 当出现错误码“ModelArts.4204”时,请参考为什么调用API时提示“ModelArts.4204”?章节。 调用成功时不返回此字段。 error_msg String 调用失败时返回的错误信息。 调用成功时不返回此字段。
  • 约束与限制 只支持中国大陆驾驶证纸质版本及交管12123提供的电子驾驶证版本识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式图片。 图像各边的像素大小在100px到8000px之间。 图像中驾驶证区域有效占比超过50%,保证整张驾驶证内容及其边缘包含在图像内。 支持图像中驾驶证任意角度的水平旋转。 支持少量扭曲,扭曲后图像中的驾驶证长宽比与实际驾驶证相差不超过10%。 能处理反光、暗光、防伪标识等干扰的图片但影响识别精度。
  • 请求参数 表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。 图片最短边不小于100px,最长边不超过8000px。支持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编码。 side 否 String 检测驾驶证的主页、副页。 front: 驾驶证主页 back: 驾驶证副页 double_side:驾驶证双页信息 如果参数值为空或无该参数,系统默认识别主页,建议填写,准确率更高。 return_issuing_authority 否 Boolean 是否返回发证机关的开关,可选值包括: true:返回发证机关 false:不返回发证机关 如果无该参数,系统默认不返回发证机关。如果输入参数不是Boolean类型,则会报非法参数错误AIS.0101。 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括: true:返回各个文字块区域 false:不返回各个文字块区域 如果无该参数,系统默认不返回文字块区域。如果输入参数不是Boolean类型,则会报非法参数错误。
  • URI POST /v2/{project_id}/ocr/driver-license 表1 路径参数 参数 是否必选 说明 endpoint 是 终端节点,即调用API的请求地址。 不同服务不同区域的endpoint不同,您可以从终端节点中获取。 例如,OCR服务在“华北-北京四”区域的“endpoint”为“ocr.cn-north-4.myhuaweicloud.com”。 project_id 是 项目ID,您可以从获取项目ID中获取。
  • 错误码说明 由于OCR服务部署在ModelArts平台,使用API网关(API Gateway)系统,因此OCR服务错误码会出现“ModelArts”、“APIGW”、“APIG”开头的错误码。 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。遇到“APIG”开头的错误码,请参考本文档进行处理。 模块 错误码 错误信息 说明 建议解决方法 文字识别 AIS.0101 The input parameter is invalid. 输入参数不符合规范。 请检查输入参数是否正确。出现此报错可能原因如下: image、url参数为二选一,请勿同时填写。填写时注意格式规范。 功能开关true、false拼写错误。 传参时中英文字符错误。 具体参数格式参见各API的请求参数说明。 AIS.0102 The image format is not supported. 图片格式不支持,或image参数值不是base64编码字符串。 请检查图片格式,各服务支持图片格式请参考使用限制。 AIS.0103 The image size does not meet the requirements. 图片尺寸不满足要求。 请检查图片尺寸,各服务支持图片尺寸请参考使用限制。 AIS.0104 The image is not supported or the image quality is poor. 非支持的图片类型或图片质量差。 请检查图片类型与图片质量。 请检查调用的接口是否正确。 AIS.0105 Recognition failed. 算法计算失败。 请联系华为云支持人员。 AIS.0117 Input ID does not exist. 输入ID不存在。 请检查入参中的classifier_id或template_id是否存在。 AIS.0118 Service request error or the tax authority’s interface was malfunctioning. 税局机关接口超时未响应,导致服务请求错误。 请等待税局机关接口恢复(建议2小时后重试)。 AIS.0119 Template match failed, template_id={xxx}. 输入图片与模板匹配失败。 请检查模板中的参照字段是否与输入图片匹配。 AIS.0120 Classification failed. 输入图片分类失败。 请检查分类器中模板是否与输入图片匹配。 AIS.0121 The recognition area of template is not configured, template_id={xxx} 模板未配置识别区。 请检查模板是否配置了识别区。 AIS.0122 The image contains two or more ID cards with the same side. 存在两张及以上同面身份证。 请检查输入图片是否存在两张及以上同面身份证。身份证服务参数side为double_side时,图片中不能存在两张及以上同面身份证。 平台 ModelArts.0203 Invalid token. 非法Token。 请检查Token是否正确。 ModelArts.4101 Token header cannot be empty. Token为空。 发送的HTTP请求header中没有带x-auth-token的token请求认证信息,请检查发送的请求。 ModelArts.4102 Parse Token error. 解析Token失败。 发送的HTTP请求header中x-auth-token的token请求认证信息错误,请检查发送的请求和token。 ModelArts.4103 Invalid Token header. Token不合法。 发送的HTTP请求header中x-auth-token的token请求认证信息错误,请检查发送的请求和token。 ModelArts.4104 Invalid Request Content Length. 请求body体长度不合法。 请检查请求body体长度。要求Base64编码后大小不超过10MB。 ModelArts.4105 The JSON format of the input data is incorrect. 请求body体JSON格式不对。 请检查请求body体是否符合JSON格式。 Failed to obtain the temporary AK/SK 获取用户临时AK,SK失败 请联系技术支持人员(如果有使用OBS,请先检查授权)。 ModelArts.4106 Invalid authorization request. 用户账号受限。 请检查用户资源状态。账号受限原因请参考帐号中心相关描述。 ModelArts.4107 Get user temp ak sk error. 获取用户临时AK,SK异常。 请联系华为云支持人员。 ModelArts.4201 Request url need service id. 请求url中需要包含服务ID。 请检查请求url中的服务ID。 ModelArts.4202 Request url format invalid. 请求url格式不合法。 请检查请求url格式。 ModelArts.4203 Access denied! You do not have permission. 没有权限访问。 请检查访问权限。 ModelArts.4204 Request api error! The API XXX is not subscribed. 请求服务失败,服务未开通。 请前往文字识别控制台开通需要调用的API,注意API的开通区域。 如已开通服务,请检查开通服务的区域(或账号)与调用服务的区域(或账号)是否一致;若一致请检查API的URL是否拼写正确。 ModelArts.4301 Have error when get ai-service admin token. 获取服务admin Token失败。 请联系华为云支持人员。 ModelArts.4302 Gateway forwarding error. 访问服务失败。 请联系华为云支持人员。 ModelArts.4401 Max concurrency error. 最大并发错误,请求并发过大,超过限额。 请联系华为云支持人员。 ModelArts.4402 Backend service timeout error. 服务处理超时。 请联系华为云支持人员。 ModelArts.4403 Backend service unavailable error. 服务无法正常响应,或者失败率过高,不可用。 请联系华为云支持人员。 ModelArts.4502 Backend service response error. 服务响应失败。 请联系华为云支持人员。 ModelArts.4503 Backend service found error. 服务不存在。 请联系华为云支持人员。 ModelArts.4504 Backend service api not found. 访问的API不存在。 请联系华为云支持人员。 ModelArts.4505 Backend service internal error. 服务内部错误。 请联系华为云支持人员。 ModelArts.4506 SubService service found error. 该API对应的子服务不存在。 请联系华为云支持人员。 ModelArts.4508 Service not start. 服务不存在或者服务停止。 请联系华为云支持人员。 ModelArts.4601 The URL is not allowed. 外网下载地址不合法。 请检查输入的url下载地址参数格式。 ModelArts.4603 Obtaining the file from the URL failed. 下载外网URL文件失败。 请检查网络与URL。 ModelArts.4702 Query Obs agency failed. 查询OBS委托失败。 请检查是否已开通服务的OBS委托。 ModelArts.4703 The Obs URL is invalid. OBS地址不合法。 请检查OBS地址。 ModelArts.4704 Obtaining the file from the OBS failed. 获取OBS文件失败。 请检查OBS文件。 ModelArts.4705 The file stored on the OBS is oversized. OBS文件大小超限。 请检查OBS文件大小,请使用符合服务大小限制的文件作为输入。 ModelArts.4706 The Obs file is not exist. OBS文件不存在。 请检查对应的文件是否存在。 APIG APIG.0101 The API does not exist or has not been published in the environment. 访问的API不存在或尚未在环境中发布。 请检查API的URL是否拼写正确,例如,URL中是否缺少project_id。 检查URI中的区域信息是否和调用服务配置的终端节点是否对应。 HTTP请求方法(POST,GET等)是否正确。 具体的URI信息请在各接口的API页面查看。 APIG.0201 Backend timeout. 请求超时。 请检查原调用请求是否过于频繁,如果是并发过大,可以通过重试机制解决,在代码里检查返回值,碰到这个并发错误可以延时一小段时间(如2-5s)重试请求;也可以后端检查上一个请求结果,上一个请求返回之后再发送下一个请求,避免请求过于频繁。 请检查图片是否过大,或网络延时过长,如果图片过大,在保证图片清晰度前提下可以对图片进行等比例压缩;如果网络延时较长,可以适当提升网络传输速度。 APIG.0301 Incorrect IAM authentication information. IAM身份验证信息不正确: decrypt token fail:token解析失败。 token expires:token过期。 verify aksk signature fail:AK/SK认证失败。 x-auth-token not found:未找到x-auth-token参数。 token解析失败,请检查获取token的方法,请求体信息是否填写正确,token是否正确;检查获取token的环境与调用的环境是否一致。 token超时(token expires) ,请重新获取token,使用不过期的token。 请检查AK/SK是否正确(AK对应的SK错误,不匹配;AK/SK中多填了空格)。 AK/SK频繁出现鉴权出错,连续错误5次以上,被锁定5分钟(5分钟内,则一直认为其是异常的鉴权请求),5分钟后解锁重新认证。 检查账号权限,是否欠费,被冻结等。 检查请求header参数X-Auth-Token是否拼写正确。 APIG.0308 The throttling threshold has been reached: policy user over ratelimit,limit:XX,time:1 minute. 发送请求超过了服务的默认配置限流。 请参考调用API时提示"APIG.0308"方案进行解决。 其他 如若出现其他无法解决的错误码,请联系华为云支持人员。
  • 响应示例 状态码: 200 成功响应示例 { "result" : { "certificate_number" : "WAS1xxxx2399503", "issue_date" : "2022年10月23日", "manufacture_name" : "xxxx汽车有限公司", "vehicle_brand" : "xxx牌/xxx", "vehicle_name" : "轿车", "vehicle_model" : "TV7xxxxx", "vin" : "LFMAYxxxxxxx92063", "vehicle_color" : "白", "chassis_model" : "x", "chassis_id" : "x", "chassis_certificate_number" : "x", "engine_model" : "9NR", "engine_number" : "A2853xx", "fuel_type" : "汽油", "displacement" : "x197", "power" : "xx", "emission_standard" : "GBXXXXX-XXXX", "fuel_consumption" : "xx", "overall_dimension_length" : "xx35", "overall_dimension_width" : "17xx", "overall_dimension_height" : "14xx", "container_dimension_length" : "x", "container_dimension_width" : "x", "container_dimension_height" : "x", "spring_quantity" : "xx", "tire_quantity" : "x", "tire_size" : "XXXXX.X", "front_wheel_track" : "xx27", "rear_wheel_track" : "xx26", "wheelbase" : "27xx", "axle_load" : "xxx/830", "axle_quantity" : "x", "steering_form" : "方向盘", "total_weight" : "xx70", "equipment_weight" : "xx40", "maximum_laden_mass" : "x", "mass_utilization_coefficient" : "x", "traction_weight" : "x", "maximum_load_mass" : "x", "cab_passenger_capacity" : "x", "passenger_capacity" : "x", "max_design_speed" : "xxx", "manufacture_date" : "2022年10月xxx日", "confidence" : { "certificate_number" : 0.9856, "issue_date" : 0.9931, "manufacture_name" : 0.9485, "vehicle_brand" : 0.9612, "vehicle_name" : 0.9562, "vehicle_model" : 0.9741, "vin" : 0.9963, "vehicle_color" : 0.9645, "chassis_model" : 0, "chassis_id" : 0, "chassis_certificate_number" : 0, "engine_model" : 0.9745, "engine_number" : 0.9384, "fuel_type" : 0.9845, "displacement" : 0.9954, "power" : 0.9861, "emission_standard" : 0.9864, "fuel_consumption" : 0.9952, "overall_dimension_length" : 0.9995, "overall_dimension_width" : 0.9996, "overall_dimension_height" : 0.9982, "container_dimension_length" : 0, "container_dimension_width" : 0, "container_dimension_height" : 0, "spring_quantity" : 0, "tire_quantity" : 0.9984, "tire_size" : 0.9631, "front_wheel_track" : 0.9815, "rear_wheel_track" : 0.9951, "wheelbase" : 0.9762, "axle_load" : 0.9978, "axle_quantity" : 0.9982, "steering_form" : 0.9946, "total_weight" : 0.9863, "equipment_weight" : 0.9975, "maximum_laden_mass" : 0, "mass_utilization_coefficient" : 0, "traction_weight" : 0, "maximum_load_mass" : 0, "cab_passenger_capacity" : 0, "passenger_capacity" : 0.9992, "max_design_speed" : 0.9999, "manufacture_date" : 0.9856 } } } 状态码: 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”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v2/{project_id}/ocr/vehicle-certificate”,“project_id”为项目ID,获取方法请参见获取项目ID。 如何获取Token请参见认证鉴权。 传入车辆合格证图片的base64编码进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/vehicle-certificate { "image" : "/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..." } 传入车辆合格证图片的url进行文字识别 POST https://{endpoint}/v2/{project_id}/ocr/vehicle-certificate { "url" : "https://BucketName.obs.myhuaweicloud.com/ObjectName" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 result VehicleCertificateResult object 调用成功时表示调用结果。 调用失败时无此字段。 表5 VehicleCertificateResult 参数 参数类型 描述 certificate_number String 合格证编号。 issue_date String 发证日期。 manufacture_name String 车辆制造企业名称。 vehicle_brand String 车辆品牌。 vehicle_name String 车辆名称。 vehicle_model String 车辆型号。 vin String 车架号。 vehicle_color String 车身颜色。 chassis_model String 底盘型号。 chassis_id String 底盘ID。 chassis_certificate_number String 底盘合格证编号。 engine_model String 发动机型号。 engine_number String 发动机号。 fuel_type String 燃料种类。 displacement String 排量。 power String 功率。 emission_standard String 排放标准。 fuel_consumption String 油耗。 overall_dimension_length String 外廓尺寸-长。 overall_dimension_width String 外廓尺寸-宽。 overall_dimension_height String 外廓尺寸-高。 container_dimension_length String 货厢内部尺寸-长。 container_dimension_width String 货厢内部尺寸-宽。 container_dimension_height String 货厢内部尺寸-高。 spring_quantity String 钢板弹簧片数。 tire_quantity String 轮胎数。 tire_size String 轮胎规格。 front_wheel_track String 轮距-前。 rear_wheel_track String 轮距-后。 wheelbase String 轴距。 axle_load String 轴荷。 axle_quantity String 轴数。 steering_form String 转向形式。 total_weight String 总质量。 equipment_weight String 整备质量。 maximum_laden_mass String 额定载质量。 mass_utilization_coefficient String 载质量利用系数。 traction_weight String 准牵引总质量。 maximum_load_mass String 半挂车鞍座最大允许总质量。 cab_passenger_capacity String 驾驶室准乘人数。 passenger_capacity String 额定载客。 max_design_speed String 最高设计车速。 manufacture_date String 车辆制造日期。 confidence Object 字段的置信度,取值范围0~1。 置信度越大,本次识别的字段的可靠性越高,在统计意义上,置信度越大,准确率越高。 置信度由算法给出,不直接等价于字段的准确率。 text_location Object 对应所有在原图上识别到的字段位置信息,包含所有文字区域四个顶点的二维坐标(x,y)。采用图像坐标系,坐标原点为图片左上角,x轴沿水平方向,y轴沿竖直方向。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 调用失败时的错误码。 调用成功时无此字段。 error_msg String 调用失败时的错误信息。 调用成功时无此字段。
  • 约束与限制 只支持中国大陆车辆合格证的识别。 只支持识别PNG、JPG、JPEG、BMP、TIFF格式的图片。 图像各边的像素大小在15到8192px之间。 图像中识别区域有效占比超过80%,保证整张车辆合格证内容及其边缘包含在图像内。 支持图像中车辆合格证任意角度的水平旋转。 支持少量扭曲,扭曲后图像中的车辆合格证长宽比与实际驾驶证相差不超过10%。 能处理暗光等干扰的图片但影响识别精度。 文字识别服务属于公有云服务,线上用户资源共享,如果需要多并发请求,请提前联系我们。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 用于获取操作API的权限。获取Token接口响应消息头中X-Subject-Token的值即为Token。 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编码后大小不超过10M。 图片最小边不小于15像素,最长边不超过8192像素。支持JPG/PNG/BMP/TIFF格式。 图片Base64编码示例如/9j/4AAQSkZJRgABAg...,带有多余前缀会产生The image format is not supported报错。 url 否 String 与image二选一。 图片的URL路径,目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL。 说明: 接口响应时间依赖于图片的下载时间,如果图片下载时间过长,会返回接口调用失败。 请保证被检测图片所在的存储服务稳定可靠,推荐使用OBS服务存储图片数据。 return_text_location 否 Boolean 识别到的文字块的区域位置信息。可选值包括: true:返回各个文字块区域 false:不返回各个文字块区域 如果无该参数,系统默认不返回文字块区域。如果输入参数不是Boolean类型,则会报非法参数错误。
共100000条