# 名片识别
版本 V1.0.0
# 1. 接口定义
# 1.1 接口
URL = http://ip:port/hex/ocrapi/bcocr
其中 ip 为部署机器的 ip 地址,port 为对应服务器的端口
# 1.2 描述
名片识别支持对各类名片上的文字内容识别为结构化文本。
# 1.3 HTTP请求格式
# 1.3.1 请求参数
参数名称 | 是否必选 | 类型 | 可选值 | 默认值 | 描述 | |
---|---|---|---|---|---|---|
app_id | 是 | String | 无 | 无 | 接入优图服务时生成的唯一id,用于唯一标识接入业务 | |
image | 和url二选一 | String | 无 | 无 | 图像base64编码后的字符串,图像需是JPG、PNG、BMP其中之一的格式 | |
url | 和image二选一 | String | 无 | 无 | 图片url地址,url与image两者填一个即可,同时赋值时,则以url指定的图像作为输入 | |
session_id | 否 | String | 无 | 无 | 用户自定义的唯一会话id |
# 1.3.2 请求示例
Request:
{
"app_id": 填写对应的app_id,
"image": 填写Base64编码后的图片数据,
"session_id": 填写对应的session_id
}
1
2
3
4
5
6
2
3
4
5
6
# 1.3.3 返回参数
字段 | 是否必然返回 | 类型 | 说明 | |
---|---|---|---|---|
errorcode | 是 | Int32 | 错误码 | |
errormsg | 是 | String | 错误码消息 | |
session_id | 否 | String | 相应请求的session标识符,可用于结果查询 | |
image | 否 | String | 图片数据,返回证照中的肖像或预处理后图像 | |
items | ||||
item | 是 | String | 识别出的字段名称(关键字) | |
itemstring | 是 | String | 识别出的字段名称对应的值,也就是字段item对应的字符串结果 | |
itemconf | 是 | Float | 置信度 | |
itemcoord | 是 | Object | 文本行在旋转纠正之后的图像中的像素坐标,表示为(左上角x, 左上角y,宽width,高height) |
# 1.3.4 返回示例
Response:
{
"items": [
{
"itemstring": "上海致宇信息技术有限公司",
"item": "公司",
"itemcoord": {
"width": 1164,
"x": 198,
"y": 147,
"height": 100
}
},
{
"itemstring": "marketing@goupwith.com",
"item": "邮箱",
"itemcoord": {
"width": 1259,
"x": 188,
"y": 1069,
"height": 102
}
},
{
"itemstring": "021-64958718",
"item": "电话",
"itemcoord": {
"width": 648,
"x": 190,
"y": 912,
"height": 90
}
}
],
"errorcode": 0,
"errormsg": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# 1.3.5 接口错误码说明
错误码 | 错误码消息 | 错误码说明 |
---|---|---|
-5208 | OCR_SERVER_INTERN_ERROR | 服务器内部错误 |
-1102 | SDK_IMAGE_DECODE_FAILED | 图片解码失败 |
-1400 | ERROR_OCR_TEMPLATE_NOT_MATCH | 模板不匹配 |
-9003 | GLOCR_RECOG_FAILED | OCR识别失败 |