Merge branch 'feature-人脸库接口文档' of cepm/ecologyDoc into master

AI/人脸库接入文档.md

@@ -0,0 +1,116 @@
+### 注意事项
+1. 以下接口请求头必须加入`Authorization`，值为授权token([如何获取token](../core/Token使用文档.md))
+2. 接口数据格式 `Json`
+
+### 人脸特征注册
+> 经过身份核查的人脸信息登记接口，为身份核查提供人脸库基础数据<br>
+> 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/faceLib/person/reg` <br> 
+
+
+| 请求参数  || 类型 | 是否必填 | 说明 |
+| --- | --- |--- | --- | --- | 
+| async || boolean| 否 | 是否开启异步反馈模式，默认为false |
+| idNum || String| 是 | 身份证号 | 
+| name || String| 是 | 姓名 | 
+| personType || String| 是 | 人员类型，normal-普通客户 vip-高级客户 inner-内部员工 | 
+| faceImage || -| - | 注册人脸库生活照 |
+|| origin | String| 否 | image的数据类型。<br/> base64字符串：self (**base64内容需在400k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>图片链接：uri <br/>默认为 self |
+|| data | String| 是 | 图片数据（base64，文件服务器文件路径或链接） |
+
+
+| 返回参数  || | 类型 | 是否必返 | 说明 |
+| --- | --- | --- |--- | --- | --- |
+| errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
+| errmsg ||| String | 否 | errcode不为0时有值 | 
+| data| || - | - | 包含数据见下 |
+| |status || String | 是 | “SUCCESS”为业务成功 |
+| |traceNo || String | 是 | 当前业务的唯一id |
+| |result|| String | 是 | 业务结果 |
+| ||ok | String | 是 | true：注册成功 <br> false：注册失败 |
+
+
+请求示例
+
+```
+{
+    "personType": "vip",
+    "idNum": "610xxxxxxxxxxxx019",
+    "name": "张三",
+    "customerID": "",
+    "faceImage": {
+        "type": "image",
+        "origin": "fds",
+        "data": "xxxxxxxxxxxxxx.jpg"
+    },
+    "async": false
+}
+```
+
+返回示例
+
+```
+{
+    "errcode":0,
+    "data":{
+        "ok":"true",
+    },
+    "errmsg":"SUCCESS"
+}
+```
+
+### 人脸库检索
+> 传入人脸照片获取人员在人脸库中的信息及对比相似度<br>
+> 请求方式  ` POST http://172.20.109.105:7007/tech/ai/face/faceLib/person/recong`
+
+| 请求参数  || 类型 | 是否必填 | 说明 |
+| --- | ---| --- | --- | --- | 
+| async || boolean| 否 | 是否开启异步反馈模式，默认为false |
+| faceImage || -| - | 注册人脸库生活照 |
+|| origin | String| 否 | image的数据类型。<br/> base64字符串：self (**base64内容需在400k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>图片链接：uri <br/>默认为 self |
+|| data | String| 是 | 图片数据（base64，文件服务器文件路径或链接） |
+
+
+| 返回参数  || | 类型 | 是否必返 | 说明 |
+| --- | --- | --- |--- | --- | --- |
+| errcode ||| Num| 是 | 0交易成功<br>其它为异常情况 |
+| errmsg ||| String | 否 | errcode不为0时有值 | 
+| data| || - | - | 包含数据见下 |
+| |status || String | 是 | “SUCCESS”为业务成功 |
+| |traceNo || String | 是 | 当前业务的唯一id |
+| |result|| String | 是 | 业务结果 |
+| ||idNum | String| 否 | 身份证号，match为true返回 | 
+| ||customerID | String| 否 | 客户号，match为true返回 | 
+| ||name | String| 否 | 姓名，match为true返回 | 
+| ||personType | String| 否 | 人员类型，match为true返回，normal-普通客户 vip-高级客户 inner-内部员工 | 
+| ||match | String | 否 | true：匹配成功<br>false：匹配失败 |
+| ||score | String | 否 | 匹配分数，验证通过时返回，推荐达到70时可判断为同一人（70的误通过率为千分之一，80的误通过率是万分之一，根据具体场景自行调整阈值）|
+
+请求示例
+
+```
+{
+     "async":false,
+     "faceImage":{
+        "type": "image",
+        "origin": "fds",
+        "data": "xxxxxxxxxxxxxx.jpg"
+     }
+}
+```
+
+返回示例
+
+```
+{
+    "errcode":0,
+    "data":{
+        "idNum":"610xxxxxxxxxxxx019",
+        "customerID":"",
+        "name":"张三",
+        "personType":"vip",
+        "isMatch":"true",
+        "score":"80",
+    },
+    "errmsg":"SUCCESS"
+}
+```

AI/人脸识别接口文档.md

@@ -83,6 +83,7 @@
 | |videoType | String| 是 | type为video时生效。<br/>SILENT：默认，静默模式，视频不需要做动作 <br/> LIP：数字模式，视频需读出指定数字<br/>传该字段时，不能为空字符串|
 | |origin | String| 否 | faceData的数据类型。<br/> base64字符串：self (**base64内容需在400k以内**)<br/>来自文件服务器：fds （**带压缩效果，推荐使用，详见[fds使用文档](../file/文件服务器接口.md)）**<br/>视频链接：uri <br/>默认为 self <br/>传该字段时，不能为空字符串|
 | |data | String| 是 | 视频数据（base64，文件服务器文件路径或链接） |
+| personType || String| 否 | 人员类型，normal-普通客户 vip-高级客户 inner-内部员工 | 
 
 
 | 返回参数  || | 类型 | 是否必返 | 说明 |