智能结构化识别
更新时间:2023-08-28
该接口已停止更新且即将下线,为避免影响您目前的业务使用,请您及时进行相关迁移工作
接口描述
结构化识别各类卡证、票据,无需配置结构化对应关系、无需提取关键词、无需定制开发,直接上传图片即可获得结构化识别信息。
请求说明
请求示例
HTTP 方法:POST
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/x-www-form-urlencoded |
Body中放置请求参数,参数详情如下:
请求参数
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
image | 和url二选一 | string | - | 图像数据,base64编码后进行urlencode,要求base64编码和urlencode后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式 |
url | 和image二选一 | string | - | 图片完整URL,URL长度不超过1024字节,URL对应的图片base64编码后大小不超过4M,最短边至少15px,最长边最大4096px,支持jpg/jpeg/png/bmp格式,当image字段存在时url字段失效请注意关闭URL防盗链 |
detect_direction | 否 | string | true/false | 是否进行方向检测及矫正,默认为 false,可缺省- false:不进行方向矫正,返回参数 direction 固定为 0- true:开启自动方向矫正功能,可识别旋转90/180/270度的图片,并返回 direction 检测数值 |
detect_null_word | 否 | string | true/false | 是否返回未成功匹配的Key/Value值,缺少的对应 Value/Key 置为 NULL,默认为 false,可缺省- false:不返回未匹配成功的单独 Key/Value,仅返回成功匹配的 KV 结果组- true:返回未匹配成功的单独 Key/Value,缺少的对应 Value/Key 置为 NULL |
probability | 否 | string | true/false | 是否返回字段识别结果的置信度,默认为 false,可缺省- false:不返回字段识别结果的置信度- true:返回字段识别结果的置信度,包括字段识别结果中各字符置信度的平均值(average)、最小值(min)和方差(variance) |
返回说明
返回参数
字段 | 是否必输出 | 类型 | 说明 |
---|---|---|---|
log_id | 是 | uint64 | 调用日志id,用于问题定位 |
direction | 是 | int | 图片旋转角度,当请求参数 detect_direction=true 时,返回图片方向检测结果 0/1/2/3 分别代表 不旋转、逆时针旋转 90/180/270度 |
words_result_num | 是 | uint32 | 识别结果数,表示words_result的元素个数 |
words_result | 是 | array | 识别结果数组 |
+ key | 是 | object | 关键词信息,与 value 一一对应,形成 key:value 结构化识别结果组 |
++ word | 是 | string | 识别结果 |
++ location | 是 | object | 字段位置信息 |
+++ top | 是 | int | 字段的上边距 |
+++ left | 是 | int | 字段的左边距 |
+++ height | 是 | int | 字段的高度 |
+++ width | 是 | int | 字段的宽度 |
++ probability | 否 | object | 字段识别结果置信度,当请求参数 probability=true 时,以上各字段均包含此参数 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
+++ variance | 否 | float | 字段识别结果中各字符的置信度方差 |
+ value | 是 | object | 字段内容,与 key 一一对应,形成 key:value 结构化识别结果组 |
++ word | 是 | string | 识别结果 |
++ location | 是 | object | 字段位置信息 |
+++ top | 是 | int | 字段的上边距 |
+++ left | 是 | int | 字段的左边距 |
+++ height | 是 | int | 字段的高度 |
+++ width | 是 | int | 字段的宽度 |
++ probability | 否 | object | 字段识别结果置信度,当请求参数 probability=true 时,以上各字段均包含此参数 |
+++ average | 否 | float | 字段识别结果中各字符的置信度平均值 |
+++ min | 否 | float | 字段识别结果中各字符的置信度最小值 |
+++ variance | 否 | float | 字段识别结果中各字符的置信度方差 |
返回示例
JSON
1{
2 "words_result": [
3 {
4 "value": {
5 "probability": {
6 "average": 0.99977076053619,
7 "min": 0.99970018863678,
8 "variance": 4.9803929869086e-9
9 },
10 "location": {
11 "top": 146,
12 "left": 365,
13 "width": 50,
14 "height": 25
15 },
16 "word": "丛齐"
17 },
18 "key": {
19 "probability": {
20 "average": 0.99997997283936,
21 "min": 0.99997985363007,
22 "variance": 1.4210854715202e-14
23 },
24 "location": {
25 "top": 149,
26 "left": 311,
27 "width": 40,
28 "height": 20
29 },
30 "word": "姓名"
31 }
32 },
33 {
34 "value": {
35 "probability": {
36 "average": 0.9999588727951,
37 "min": 0.9999588727951,
38 "variance": 0
39 },
40 "location": {
41 "top": 190,
42 "left": 366,
43 "width": 20,
44 "height": 21
45 },
46 "word": "男"
47 },
48 "key": {
49 "probability": {
50 "average": 0.99983507394791,
51 "min": 0.99969410896301,
52 "variance": 1.9871126966109e-8
53 },
54 "location": {
55 "top": 192,
56 "left": 312,
57 "width": 39,
58 "height": 19
59 },
60 "word": "性别"
61 }
62 },
63 {
64 "value": {
65 "probability": {
66 "average": 0.99964165687561,
67 "min": 0.99964165687561,
68 "variance": 0
69 },
70 "location": {
71 "top": 228,
72 "left": 366,
73 "width": 22,
74 "height": 20
75 },
76 "word": "汉"
77 },
78 "key": {
79 "probability": {
80 "average": 0.99994975328445,
81 "min": 0.99993216991425,
82 "variance": 3.0917490789761e-10
83 },
84 "location": {
85 "top": 228,
86 "left": 310,
87 "width": 41,
88 "height": 20
89 },
90 "word": "民族"
91 }
92 },
93 {
94 "value": {
95 "probability": {
96 "average": 0.99989211559296,
97 "min": 0.9996235370636,
98 "variance": 1.0301564046244e-8
99 },
100 "location": {
101 "top": 262,
102 "left": 356,
103 "width": 158,
104 "height": 21
105 },
106 "word": "1989年7月28日"
107 },
108 "key": {
109 "probability": {
110 "average": 0.99828881025314,
111 "min": 0.99683433771133,
112 "variance": 0.0000021154903606657
113 },
114 "location": {
115 "top": 264,
116 "left": 312,
117 "width": 40,
118 "height": 19
119 },
120 "word": "出生"
121 }
122 },
123 {
124 "value": {
125 "probability": {
126 "average": 0.99985313415527,
127 "min": 0.99945932626724,
128 "variance": 1.7040544975089e-8
129 },
130 "location": {
131 "top": 315,
132 "left": 343,
133 "width": 297,
134 "height": 25
135 },
136 "word": "370441198907287001"
137 },
138 "key": {
139 "probability": {
140 "average": 0.99995613098145,
141 "min": 0.99990141391754,
142 "variance": 1.089595969006e-9
143 },
144 "location": {
145 "top": 320,
146 "left": 191,
147 "width": 140,
148 "height": 21
149 },
150 "word": "社会保障号码"
151 }
152 }
153 ],
154 "log_id": "8733452781125821952",
155 "words_result_num": 5,
156 "direction": 0
157}