名片识别
功能介绍
识别名片图片上的文字信息,并以json格式返回识别的结构化结果。支持对多种不同版式名片进行结构化信息提取。该接口的使用限制请参见约束与限制,详细使用指导请参见OCR服务使用简介章节。

调试
您可以在API Explorer中调试该接口。
URI
POST https://{endpoint}/v2/{project_id}/ocr/business-card
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,响应消息头中X-Subject-Token的值即为Token。 |
Content-Type |
是 |
String |
发送的实体的MIME类型,参数值为“application/json”。 |
参数 |
是否必选 |
参数类型 |
说明 |
---|---|---|---|
image |
否,该参数与url二选一 |
String |
图像数据,base64编码,要求base64编码后大小不超过10MB。图片最小边不小于15px,最长边不超过8192px,支持JPEG、JPG、PNG、BMP、TIFF格式。 |
url |
否,该参数与image二选一 |
String |
图片的url路径,目前支持:
说明:
|
detect_direction |
否 |
Boolean |
校正图片的倾斜角度开关,可选值如下所示。
支持任意角度的校正,未传入该参数时默认为“false”。 |
return_adjusted_image |
否 |
Boolean |
返回校正后的名片图像的base64编码的开关,可选值如下所示。
未传入该参数时默认为“false”。 |
响应参数
根据识别的结果,可能有不同的HTTP响应状态码(status code),状态码和响应参数说明如下。
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
BusinessCardResult object |
调用成功时表示调用结果。 调用失败时无此字段。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
Array of strings |
姓名列表。 |
title |
Array of strings |
职位头衔列表。 |
company |
Array of strings |
公司列表。 |
department |
Array of strings |
部门列表。 |
phone |
Array of strings |
联系方式列表。 |
address |
Array of strings |
地址列表。 |
Array of strings |
邮箱列表。 |
|
fax |
Array of strings |
传真列表。 |
postcode |
Array of strings |
邮编列表。 |
website |
Array of strings |
公司网址列表。 |
extra_info_list |
Array of ExtraInfoList objects |
其余信息列表。 |
adjusted_image |
String |
返回矫正后的名片图像的BASE64编码。 |
参数 |
参数类型 |
描述 |
---|---|---|
item |
String |
表示“key”值,例如:bank等。 |
value |
String |
表示“value”值,例如:bank等。 |
note |
Array of strings |
对应“item”关联的额外信息,为“bank”时第一个默认为户名,第二个为开户行。 |
状态码: 400
参数 |
参数类型 |
说明 |
---|---|---|
error_code |
String |
调用失败时的错误码,具体请参见错误码。 当出现错误码“ModelArts.4204”时,请参考为什么调用API时提示“ModelArts.4204”?章节。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
请求示例

- 请求样例(方式一:使用图片的base64编码)
POST https://{endpoint}/v2/{project_id}/ocr/business-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/business-card Request Header: Content-Type: application/json X-Auth-Token: MIINRwYJKoZIhvcNAQcCoIINODCCDTQCAQExDTALBglghkgBZQMEAgEwgguVBgkqhkiG... Request Body: { "url":"https://BucketName.obs.xxxx.com/ObjectName" }
- Python3语言请求代码示例(其他语言参照下列示例编写或使用OCR SDK)
# encoding:utf-8 import requests import base64 url = "https://{endpoint}/v2/{project_id}/ocr/business-card" token = "用户获取得到的实际token值" headers = {'Content-Type': 'application/json', 'X-Auth-Token': token} imagepath = r'./data/business-card-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} # url与image参数二选一 response = requests.post(url, headers=headers, json=payload) print(response.text)
响应示例
状态码:200
成功响应示例
{ "result": { "name": ["XX"], "title": ["销售总监"], "company": ["XX有限公司"], "department": ["XX产品部"], "phone": ["+XX XXX XXXX XXXX","XXXX XXXXXXXXX"], "address": ["XXXX"], "email": ["XX"], "fax": ["XXXX XXXXXXXX"], "postcode": [], "website": ["XX"], "extra_info_list": [ { "item": "bank", "value": "XXXXXXXXXXXXXXX", "note": ["张三","XX"] } ] } }
状态码:400
失败响应示例
{ "error_code": "AIS.0103", "error_msg": "The image size does not meet the requirements." }
错误码
错误码请参见错误码。
