cepm
/
ecologyDoc
Watch 12
Star 0
Fork 0
Code Pull Requests 0 Releases 0 Activity
Browse Source

Update 人脸识别接口文档.md

pull/1/head
周雪成 3 years ago
parent
32561a7522
commit
93e8aff017
1 changed files with 57 additions and 68 deletions
Split View Show Diff Stats
  1. 57
    68
      AI/人脸识别接口文档.md

+ 57
- 68
AI/人脸识别接口文档.md View File 

@@ -7,35 +7,30 @@
7 7 
 > 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/match` <br>
8 8
9 9
10 
-| 请求参数  | 类型 | 是否必填 | 说明 |
11 
-| --- | --- | --- | --- |
12 
-| async | boolean| 否 | 是否开启异步反馈模式，默认为false |
13 
-| liveCode | String| 否 | 传入对比数据为视频并选择LIP模式时必传，值通过[数字验证码接口](#yanzhengma)获取 |
14 
-| --- | --- | --- | --- |
15 
-| image | -| - | 对比时要参照的客户照片 |
16 
-| origin | String| 否 | image的数据类型。<br/> base64字符串：self (**base64内容需在200k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>图片链接：uri <br/>默认为 self |
17 
-| data | String| 是 | 图片数据（base64，文件服务器文件路径或链接） |
18 
-| --- | --- | --- | --- |
19 
-| faceData | -| - | 需要比对的客户照片或视频 |
20 
-| type | String| 是 | 照片：image <br/> 视频：video |
21 
-| videoType | String| 否 | type为video时生效。<br/>SILENT：默认，静默模式，视频不需要做动作 <br/> LIP：数字模式，视频需读出指定数字<br/>传该字段时，不能为空字符串|
22 
-| origin | String| 否 | faceData的数据类型。<br/> base64字符串：self (**base64内容需在200k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>视频链接：uri <br/>默认为 self <br/>传该字段时，不能为空字符串|
23 
-| data | String| 是 | 视频数据（base64，文件服务器文件路径或链接） |
24 
-| --- | --- | --- | --- |
25 
-
26 
-
27 
-| 返回参数  | 类型 | 是否必返 | 说明 |
28 
-| --- | --- | --- | --- |
29 
-| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
30 
-| errmsg | String | 否 | errcode不为0时有值 |
31 
-| --- | --- | --- | --- |
32 
-| data | - | - | 包含数据见下 |
33 
-| status | String | 是 | “SUCCESS”为业务成功 |
34 
-| traceNo | String | 是 | 当前业务的唯一id |
35 
-| result | String | 是 | 业务结果 |
36 
-| result->isSccess | String | 是 | true：识别成功<br>false：识别失败 |
37 
-| result->score | String | 否 | 匹配分数，以供参考 |
38 
-| --- | --- | --- | --- |
10 
+| 请求参数  || 类型 | 是否必填 | 说明 |
11 
+| --- | --- |--- | --- | --- |
12 
+| async || boolean| 否 | 是否开启异步反馈模式，默认为false |
13 
+| liveCode || String| 否 | 传入对比数据为视频并选择LIP模式时必传，值通过[数字验证码接口](#yanzhengma)获取 |
14 
+| image || -| - | 对比时要参照的客户照片 |
15 
+|| origin | String| 否 | image的数据类型。<br/> base64字符串：self (**base64内容需在200k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>图片链接：uri <br/>默认为 self |
16 
+|| data | String| 是 | 图片数据（base64，文件服务器文件路径或链接） |
17 
+| faceData| | -| - | 需要比对的客户照片或视频 |
18 
+| |type | String| 是 | 照片：image <br/> 视频：video |
19 
+| |videoType | String| 否 | type为video时生效。<br/>SILENT：默认，静默模式，视频不需要做动作 <br/> LIP：数字模式，视频需读出指定数字<br/>传该字段时，不能为空字符串|
20 
+| |origin | String| 否 | faceData的数据类型。<br/> base64字符串：self (**base64内容需在200k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>视频链接：uri <br/>默认为 self <br/>传该字段时，不能为空字符串|
21 
+| |data | String| 是 | 视频数据（base64，文件服务器文件路径或链接） |
22 
+
23 
+
24 
+| 返回参数  || | 类型 | 是否必返 | 说明 |
25 
+| --- | --- | --- |--- | --- | --- |
26 
+| errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
27 
+| errmsg ||| String | 否 | errcode不为0时有值 |
28 
+| data| || - | - | 包含数据见下 |
29 
+| |status || String | 是 | “SUCCESS”为业务成功 |
30 
+| |traceNo || String | 是 | 当前业务的唯一id |
31 
+| |result|| String | 是 | 业务结果 |
32 
+| ||isSccess | String | 是 | true：识别成功<br>false：识别失败 |
33 
+| ||score | String | 否 | 匹配分数，以供参考 |
39 34
40 35 
 请求示例
41 36 
 
@@ -68,8 +63,6 @@
68 63 
             "isSccess":"true",
69 64 
             "score":"99"
70 65 
         },
71 
-
72 
-
73 66 
     },
74 67 
     "errmsg":"SUCCESS"
75 68 
 }
 
@@ -79,32 +72,29 @@
79 72 
 > 用于身份证查到的公安库照片+传入照片，或者公安库照片+视频的对比，视频支持做出指定动作<br>
80 73 
 > 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/match/idno`
81 74
82 
-| 请求参数  | 类型 | 是否必填 | 说明 |
83 
-| --- | --- | --- | --- |
84 
-| async | boolean| 否 | 是否开启异步反馈模式，默认为false |
85 
-| idNum | String| 是 | 验证人的身份证号 |
86 
-| name | String| 是 | 验证人的姓名 |
87 
-| liveCode | String| 是 | 数字验证码，选择LIP模式时必传，值通过[数字验证码接口](#yanzhengma)获取 |
88 
-| --- | --- | --- | --- |
89 
-| faceData | -| - | 需要比对的客户照片或视频 |
90 
-| type | String| 是 | 照片：image <br/> 视频：video |
91 
-| videoType | String| 是 | type为video时生效。<br/>SILENT：默认，静默模式，视频不需要做动作 <br/> LIP：数字模式，视频需读出指定数字<br/>传该字段时，不能为空字符串|
92 
-| origin | String| 否 | faceData的数据类型。<br/> base64字符串：self (**base64内容需在200k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>视频链接：uri <br/>默认为 self <br/>传该字段时，不能为空字符串|
93 
-| data | String| 是 | 视频数据（base64，文件服务器文件路径或链接） |
94 
-| --- | --- | --- | --- |
95 
-
96 
-| 返回参数  | 类型 | 是否必返 | 说明 |
97 
-| --- | --- | --- | --- |
98 
-| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
99 
-| errmsg | String | 否 | errcode不为0时有值 |
100 
-| --- | --- | --- | --- |
101 
-| data | - | - | 包含数据见下 |
102 
-| status | String | 是 | “SUCCESS”为业务成功 |
103 
-| traceNo | String | 是 | 当前业务的唯一id |
104 
-| result | String | 是 | 业务结果 |
105 
-| result->isSccess | String | 是 | true：识别成功<br>false：识别失败 |
106 
-| result->score | String | 否 | 匹配分数，以供参考 |
107 
-| --- | --- | --- | --- |
75 
+| 请求参数  || 类型 | 是否必填 | 说明 |
76 
+| --- | ---| --- | --- | --- |
77 
+| async || boolean| 否 | 是否开启异步反馈模式，默认为false |
78 
+| idNum || String| 是 | 验证人的身份证号 |
79 
+| name || String| 是 | 验证人的姓名 |
80 
+| liveCode || String| 是 | 数字验证码，选择LIP模式时必传，值通过[数字验证码接口](#yanzhengma)获取 |
81 
+| faceData || -| - | 需要比对的客户照片或视频 |
82 
+| |type | String| 是 | 照片：image <br/> 视频：video |
83 
+| |videoType | String| 是 | type为video时生效。<br/>SILENT：默认，静默模式，视频不需要做动作 <br/> LIP：数字模式，视频需读出指定数字<br/>传该字段时，不能为空字符串|
84 
+| |origin | String| 否 | faceData的数据类型。<br/> base64字符串：self (**base64内容需在200k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>视频链接：uri <br/>默认为 self <br/>传该字段时，不能为空字符串|
85 
+| |data | String| 是 | 视频数据（base64，文件服务器文件路径或链接） |
86 
+
87 
+
88 
+| 返回参数  || | 类型 | 是否必返 | 说明 |
89 
+| --- | --- | --- |--- | --- | --- |
90 
+| errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
91 
+| errmsg ||| String | 否 | errcode不为0时有值 |
92 
+| data| || - | - | 包含数据见下 |
93 
+| |status || String | 是 | “SUCCESS”为业务成功 |
94 
+| |traceNo || String | 是 | 当前业务的唯一id |
95 
+| |result|| String | 是 | 业务结果 |
96 
+| ||isSccess | String | 是 | true：识别成功<br>false：识别失败 |
97 
+| ||score | String | 否 | 匹配分数，以供参考 |
108 98
109 99 
 请求示例
110 100 
 
@@ -152,17 +142,16 @@
152 142 
 | --- | --- | --- | --- |
153 143 
 | 无 | -| - | - |
154 144
155 
-| 返回参数  | 类型 | 是否必返 | 说明 |
156 
-| --- | --- | --- | --- |
157 
-| errcode | Num| 是 | 0交易成功<br>其它为异常情况 |
158 
-| errmsg | String | 否 | errcode不为0时有值 |
159 
-| --- | --- | --- | --- |
160 
-| data | - | - | 包含数据见下 |
161 
-| status | String | 是 | “SUCCESS”为业务成功 |
162 
-| traceNo | String | 是 | 当前业务的唯一id |
163 
-| result | String | 是 | 业务结果 |
164 
-| result->code | String | 否 | 数字验证码 |
165 
-| --- | --- | --- | --- |
145 
+| 返回参数  || | 类型 | 是否必返 | 说明 |
146 
+| --- | --- | --- |--- | --- | --- |
147 
+| errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
148 
+| errmsg ||| String | 否 | errcode不为0时有值 |
149 
+| data| || - | - | 包含数据见下 |
150 
+| |status || String | 是 | “SUCCESS”为业务成功 |
151 
+| |traceNo || String | 是 | 当前业务的唯一id |
152 
+| |result|| String | 是 | 业务结果 |
153 
+| ||code | String | 是 | 数字验证码 |
154 
+
166 155
167 156 
 请求示例
168 157

Write Preview
Loading…
Cancel
Save