文档首页 > > API参考> API> 名片识别

名片识别

分享
更新时间: 2020/04/26 GMT+08:00

功能介绍

识别名片图片上的文字信息,并返回识别的结构化结果。支持对多种不同版式名片进行结构化信息提取。

URI

URI格式:

POST /v1.0/ocr/business-card

请求消息

名片识别请求参数说明请参见 表1
表1 请求参数

参数

是否必选

参数类型

说明

image

与url二选一

String

图像数据,base64编码,要求base64编码后大小不超过10MB。图片最小边不小于15像素,最长边不超过8192像素,支持JPEG/JPG/PNG/BMP/TIFF格式。

url

与image二选一

String

图片的URL路径,目前仅支持华为云上OBS提供的匿名公开授权访问的URL以及公网URL

detect_direction

Boolean

图片朝向检测开关,可选值包括:

  • true:检测图片朝向;
  • false:不检测图片朝向。

支持任意角度的图片朝向检测。未传入该参数时默认为false,即不检测图片朝向。

return_adjusted_image

Boolean

返回矫正后的名片图像的BASE64编码的开关,可选值包括:

true:返回BASE64编码;

false:不返回BASE64编码。

未传入该参数时默认为false,即不返回BASE64编码。

响应消息

名片识别响应参数说明请参见 表2
表2 响应参数

参数

参数类型

说明

result

Object

调用成功时返回的结果。

调用失败时无此字段。

name

Array of objects

姓名列表。

title

Array of objects

职位头衔列表。

company

Array of objects

公司列表。

department

Array of objects

部门列表。

phone

Array of objects

联系方式列表。

address

Array of objects

地址列表。

email

Array of objects

邮箱列表。

fax

Array of objects

传真列表。

postcode

Array of objects

邮编列表。

website

Array of objects

公司网址列表。

extra_info_list

Array of objects

其余信息列表。

item

String

表示key值,可能是qq, wechat, alipay及bank等。

value

String

表示value值,对应qq, wechat, alipay及bank等的账号。

note

Array of objects

对应item关联的额外信息,为bank时第一个默认为户名,第二个为开户行,为alipay时第一个默认为账号名。

adjusted_image

String

返回矫正后的名片图像的BASE64编码。

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

示例

  • 请求样例(方式一:使用图片的BASE64编码)
    POST https://{endpoint}/v1.0/ocr/business-card
     
    Request Header:   
    Content-Type: application/json
    X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
    Request Body:
    {
        "image":"/9j/4AAQSkZJRgABAgEASABIAAD/4RFZRXhpZgAATU0AKgAAAA..."
    }
  • 请求样例(方式二:使用图片URL)
    POST https://{endpoint}/v1.0/ocr/business-card
     
    Request Header:   
    Content-Type: application/json
    X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG...
    Request Body:
    {
        "url":"https://BucketName.obs.xxxx.com/ObjectName"
    }

    Endpoint即调用API的请求地址,不同服务不同区域的Endpoint不同,具体请参见终端节点

    例如名片识别服务部署在“华北-北京四”区域的Endpoint为“ocr.cn-north-4.myhuaweicloud.com”,请求URL为“https://ocr.cn-north-4.myhuaweicloud.com/v1.0/ocr/business-card”。

  • 成功响应样例
    {
        "result": {
            "name": ["张三"],
            "title": ["销售总监"],
            "company": ["华为技术有限公司"],
            "department": ["华为云EI服务产品部"],
            "phone": ["+86 189 2221 5230","0755 545353232"],
            "address": ["深圳市坂田华为基地"],
            "email": ["zhangsan@huawei.com"],
            "fax": ["0755 66542642"],
            "postcode": [],
            "website": ["www.huaweicloud.com"],
            "extra_info_list": [
                {
                    "item": "qq",
                    "value": "24242523",
                    "note": []
                },
                {
                    "item": "qq",
                    "value": "54363654",
                    "note": []
                },
                {
                    "item": "wechat",
                    "value": "13425642564",
                    "note": []
                },
                {
                    "item": "alipay",
                    "value": "54454@qq.com",
                    "note": ["张三"]
                },
                {
                    "item": "bank",
                    "value": "6217866200004973114",
                    "note": ["张三","农行"]
                },
                {
                    "item": "bank",
                    "value": "6217866200004973114",
                    "note": ["张三","工行"]
                }
            ]
        }
    }
  • 失败响应样例
    {
        "error_code": "AIS.0103", 
        "error_msg": "The image size does not meet the requirements."
    }

状态码

状态码请参见状态码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问