文档首页> 文字识别 OCR> API参考> API> 电子面单识别
更新时间:2022-11-16 GMT+08:00
分享

电子面单识别

功能介绍

识别用户上传的电子面单图片中的文字内容,并将识别的结果以JSON格式返回给用户。

图1 电子面单示例图

约束与限制

  • 支持识别JPG、PNG、BMP、TIFF格式图片。
  • 图像各边的像素大小在15到8192px之间。

前提条件

在使用之前,需要您完成服务申请和认证鉴权,具体操作流程请参见开通服务认证鉴权章节。

用户首次使用需要先申请开通开通服务。服务只需要开通一次即可,后面使用时无需再次申请。如未开通服务,调用服务时会提示ModelArts.4204报错,请在调用服务前先进入控制台开通服务,并注意开通服务区域与调用服务的区域保持一致。

URI

POST https://{endpoint}/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服务存储图片数据。

响应参数

状态码: 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

调用失败时的错误信息。 调用成功时无此字段。

请求示例

  • 请求样例(方式一:使用图片的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"
      }
  • Python3语言请求代码示例(其他语言参照下列示例编写或使用OCR SDK)
    # encoding:utf-8
    
    import requests
    import base64
    
    url = "https://{endpoint}/v2/{project_id}/ocr/waybill-electronic"
    token = "用户获取得到的实际token值"
    headers = {'Content-Type': 'application/json', 'X-Auth-Token': token}
    imagepath = r'./data/waybill-electronic-demo.png'  # 读取本地图片
    with open(imagepath, "rb") as bin_data:
        image_data = bin_data.read()
    image_base64 = base64.b64encode(image_data).decode("utf-8")  # 使用图片的Base64编码
    payload = {"image": image_base64}
    response = requests.post(url, headers=headers, json=payload)
    print(response.text)

响应示例

状态码: 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."
}

状态码

状态码

描述

200

成功响应。

400

失败响应。

状态码请参见状态码

错误码

错误码请参见错误码

分享:

    相关文档

    相关产品