tccli 3.0.1391.1__py2.py3-none-any.whl → 3.0.1414.1__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of tccli might be problematic. Click here for more details.

Files changed (226) hide show
  1. tccli/__init__.py +1 -1
  2. tccli/services/__init__.py +2 -1
  3. tccli/services/ai3d/v20250513/api.json +22 -4
  4. tccli/services/aiart/aiart_client.py +173 -67
  5. tccli/services/aiart/v20221229/api.json +193 -0
  6. tccli/services/aiart/v20221229/examples.json +16 -0
  7. tccli/services/apm/apm_client.py +53 -0
  8. tccli/services/apm/v20210622/api.json +354 -0
  9. tccli/services/apm/v20210622/examples.json +8 -0
  10. tccli/services/asr/v20190614/api.json +3 -3
  11. tccli/services/autoscaling/v20180419/api.json +24 -2
  12. tccli/services/batch/v20170312/api.json +1 -1
  13. tccli/services/bda/bda_client.py +15 -704
  14. tccli/services/bda/v20200324/api.json +107 -1819
  15. tccli/services/bda/v20200324/examples.json +0 -176
  16. tccli/services/billing/billing_client.py +326 -8
  17. tccli/services/billing/v20180709/api.json +2200 -255
  18. tccli/services/billing/v20180709/examples.json +48 -0
  19. tccli/services/cam/v20190116/api.json +4 -4
  20. tccli/services/captcha/v20190722/api.json +3 -3
  21. tccli/services/cat/v20180409/api.json +7 -7
  22. tccli/services/ccc/ccc_client.py +235 -76
  23. tccli/services/ccc/v20200210/api.json +502 -18
  24. tccli/services/ccc/v20200210/examples.json +24 -0
  25. tccli/services/cdb/cdb_client.py +106 -0
  26. tccli/services/cdb/v20170320/api.json +257 -44
  27. tccli/services/cdb/v20170320/examples.json +22 -6
  28. tccli/services/cdn/cdn_client.py +4 -163
  29. tccli/services/cdn/v20180606/api.json +61 -310
  30. tccli/services/cdn/v20180606/examples.json +1 -25
  31. tccli/services/cdwdoris/v20211228/api.json +51 -12
  32. tccli/services/cdwpg/v20201230/api.json +11 -1
  33. tccli/services/cdwpg/v20201230/examples.json +1 -1
  34. tccli/services/cfg/v20210820/api.json +11 -1
  35. tccli/services/cfs/cfs_client.py +41 -94
  36. tccli/services/cfs/v20190719/api.json +171 -55
  37. tccli/services/cfs/v20190719/examples.json +1 -9
  38. tccli/services/cfw/v20190904/api.json +122 -10
  39. tccli/services/ckafka/ckafka_client.py +188 -29
  40. tccli/services/ckafka/v20190819/api.json +277 -4
  41. tccli/services/ckafka/v20190819/examples.json +25 -1
  42. tccli/services/clb/clb_client.py +0 -265
  43. tccli/services/clb/v20180317/api.json +130 -296
  44. tccli/services/clb/v20180317/examples.json +12 -40
  45. tccli/services/cloudapp/v20220530/api.json +55 -0
  46. tccli/services/cloudaudit/v20190319/api.json +11 -0
  47. tccli/services/cloudhsm/v20191112/api.json +10 -10
  48. tccli/services/cls/v20201016/api.json +63 -45
  49. tccli/services/cls/v20201016/examples.json +10 -4
  50. tccli/services/csip/v20221121/api.json +53 -3
  51. tccli/services/ctem/v20231128/api.json +320 -0
  52. tccli/services/ctem/v20231128/examples.json +3 -3
  53. tccli/services/cvm/cvm_client.py +0 -212
  54. tccli/services/cvm/v20170312/api.json +91 -843
  55. tccli/services/cvm/v20170312/examples.json +32 -58
  56. tccli/services/cynosdb/cynosdb_client.py +167 -8
  57. tccli/services/cynosdb/v20190107/api.json +1126 -148
  58. tccli/services/cynosdb/v20190107/examples.json +31 -7
  59. tccli/services/dbbrain/dbbrain_client.py +246 -87
  60. tccli/services/dbbrain/v20191016/api.json +74 -62
  61. tccli/services/dbbrain/v20191016/examples.json +1 -1
  62. tccli/services/dbbrain/v20210527/api.json +601 -177
  63. tccli/services/dbbrain/v20210527/examples.json +28 -4
  64. tccli/services/dc/v20180410/api.json +101 -3
  65. tccli/services/dcdb/v20180411/api.json +1 -1
  66. tccli/services/dlc/dlc_client.py +53 -0
  67. tccli/services/dlc/v20210125/api.json +237 -24
  68. tccli/services/dlc/v20210125/examples.json +12 -4
  69. tccli/services/dnspod/dnspod_client.py +106 -0
  70. tccli/services/dnspod/v20210323/api.json +126 -20
  71. tccli/services/dnspod/v20210323/examples.json +17 -7
  72. tccli/services/dsgc/v20190723/api.json +73 -15
  73. tccli/services/dts/v20180330/api.json +4 -4
  74. tccli/services/dts/v20211206/api.json +408 -127
  75. tccli/services/dts/v20211206/examples.json +15 -9
  76. tccli/services/eb/v20210416/api.json +41 -1
  77. tccli/services/eb/v20210416/examples.json +1 -1
  78. tccli/services/emr/v20190103/api.json +56 -9
  79. tccli/services/emr/v20190103/examples.json +5 -5
  80. tccli/services/es/es_client.py +273 -8
  81. tccli/services/es/v20180416/api.json +845 -33
  82. tccli/services/es/v20180416/examples.json +33 -1
  83. tccli/services/es/v20250101/api.json +135 -2
  84. tccli/services/es/v20250101/examples.json +8 -0
  85. tccli/services/ess/ess_client.py +509 -32
  86. tccli/services/ess/v20201111/api.json +1366 -113
  87. tccli/services/ess/v20201111/examples.json +94 -10
  88. tccli/services/essbasic/v20210526/api.json +265 -27
  89. tccli/services/essbasic/v20210526/examples.json +12 -12
  90. tccli/services/facefusion/v20220927/api.json +1 -1
  91. tccli/services/gaap/v20180529/api.json +18 -8
  92. tccli/services/gme/gme_client.py +53 -0
  93. tccli/services/gme/v20180711/api.json +241 -1
  94. tccli/services/gme/v20180711/examples.json +8 -0
  95. tccli/services/gs/gs_client.py +216 -4
  96. tccli/services/gs/v20191118/api.json +202 -1
  97. tccli/services/gs/v20191118/examples.json +32 -0
  98. tccli/services/gwlb/gwlb_client.py +53 -0
  99. tccli/services/gwlb/v20240906/api.json +150 -0
  100. tccli/services/gwlb/v20240906/examples.json +8 -0
  101. tccli/services/hai/v20230812/api.json +5 -5
  102. tccli/services/hunyuan/v20230901/api.json +3 -3
  103. tccli/services/hunyuan/v20230901/examples.json +1 -1
  104. tccli/services/iai/v20180301/api.json +227 -207
  105. tccli/services/iai/v20180301/examples.json +26 -26
  106. tccli/services/iai/v20200303/api.json +4 -4
  107. tccli/services/iai/v20200303/examples.json +1 -1
  108. tccli/services/ioa/ioa_client.py +265 -0
  109. tccli/services/ioa/v20220601/api.json +781 -85
  110. tccli/services/ioa/v20220601/examples.json +46 -0
  111. tccli/services/iotexplorer/iotexplorer_client.py +387 -16
  112. tccli/services/iotexplorer/v20190423/api.json +1183 -63
  113. tccli/services/iotexplorer/v20190423/examples.json +92 -0
  114. tccli/services/keewidb/v20220308/api.json +69 -17
  115. tccli/services/keewidb/v20220308/examples.json +5 -5
  116. tccli/services/lcic/v20220817/api.json +61 -15
  117. tccli/services/lighthouse/v20200324/api.json +193 -24
  118. tccli/services/lighthouse/v20200324/examples.json +9 -3
  119. tccli/services/live/v20180801/api.json +6 -6
  120. tccli/services/live/v20180801/examples.json +7 -1
  121. tccli/services/lke/lke_client.py +40 -93
  122. tccli/services/lke/v20231130/api.json +943 -390
  123. tccli/services/lke/v20231130/examples.json +38 -46
  124. tccli/services/lkeap/v20240522/api.json +39 -12
  125. tccli/services/lkeap/v20240522/examples.json +12 -0
  126. tccli/services/mariadb/v20170312/api.json +1 -1
  127. tccli/services/mna/v20210119/api.json +11 -2
  128. tccli/services/mna/v20210119/examples.json +1 -1
  129. tccli/services/mongodb/mongodb_client.py +334 -16
  130. tccli/services/mongodb/v20190725/api.json +1092 -383
  131. tccli/services/mongodb/v20190725/examples.json +69 -21
  132. tccli/services/monitor/monitor_client.py +106 -0
  133. tccli/services/monitor/v20180724/api.json +383 -12
  134. tccli/services/monitor/v20180724/examples.json +24 -2
  135. tccli/services/mps/mps_client.py +220 -8
  136. tccli/services/mps/v20190612/api.json +1999 -179
  137. tccli/services/mps/v20190612/examples.json +56 -6
  138. tccli/services/mqtt/v20240516/api.json +10 -0
  139. tccli/services/mqtt/v20240516/examples.json +3 -9
  140. tccli/services/nlp/v20190408/api.json +6 -6
  141. tccli/services/oceanus/oceanus_client.py +318 -0
  142. tccli/services/oceanus/v20190422/api.json +461 -26
  143. tccli/services/oceanus/v20190422/examples.json +50 -2
  144. tccli/services/ocr/ocr_client.py +41 -253
  145. tccli/services/ocr/v20181119/api.json +153 -659
  146. tccli/services/ocr/v20181119/examples.json +8 -40
  147. tccli/services/omics/v20221128/api.json +90 -7
  148. tccli/services/organization/v20210331/api.json +46 -7
  149. tccli/services/postgres/v20170312/api.json +333 -77
  150. tccli/services/postgres/v20170312/examples.json +37 -31
  151. tccli/services/privatedns/privatedns_client.py +641 -58
  152. tccli/services/privatedns/v20201028/api.json +930 -19
  153. tccli/services/privatedns/v20201028/examples.json +91 -3
  154. tccli/services/pts/v20210728/api.json +2 -2
  155. tccli/services/redis/v20180412/api.json +303 -109
  156. tccli/services/redis/v20180412/examples.json +12 -12
  157. tccli/services/region/v20220627/api.json +1 -1
  158. tccli/services/rum/v20210622/api.json +22 -4
  159. tccli/services/rum/v20210622/examples.json +2 -2
  160. tccli/services/sms/v20190711/api.json +12 -12
  161. tccli/services/sms/v20190711/examples.json +9 -3
  162. tccli/services/sms/v20210111/api.json +13 -13
  163. tccli/services/sms/v20210111/examples.json +8 -2
  164. tccli/services/sqlserver/v20180328/api.json +46 -7
  165. tccli/services/sqlserver/v20180328/examples.json +2 -2
  166. tccli/services/ssl/v20191205/api.json +28 -0
  167. tccli/services/svp/v20240125/api.json +14 -4
  168. tccli/services/tag/v20180813/api.json +3 -3
  169. tccli/services/tat/v20201028/api.json +22 -3
  170. tccli/services/tcb/v20180608/api.json +1 -1
  171. tccli/services/tcss/tcss_client.py +228 -69
  172. tccli/services/tcss/v20201101/api.json +273 -25
  173. tccli/services/tcss/v20201101/examples.json +26 -2
  174. tccli/services/teo/teo_client.py +317 -52
  175. tccli/services/teo/v20220901/api.json +1824 -242
  176. tccli/services/teo/v20220901/examples.json +109 -21
  177. tccli/services/thpc/thpc_client.py +57 -4
  178. tccli/services/thpc/v20230321/api.json +163 -21
  179. tccli/services/thpc/v20230321/examples.json +13 -5
  180. tccli/services/tione/tione_client.py +163 -4
  181. tccli/services/tione/v20211111/api.json +285 -21
  182. tccli/services/tione/v20211111/examples.json +27 -3
  183. tccli/services/tke/tke_client.py +8 -8
  184. tccli/services/tke/v20180525/api.json +168 -130
  185. tccli/services/tke/v20180525/examples.json +20 -20
  186. tccli/services/tke/v20220501/api.json +215 -3
  187. tccli/services/tke/v20220501/examples.json +8 -0
  188. tccli/services/tms/tms_client.py +106 -0
  189. tccli/services/tms/v20201229/api.json +249 -3
  190. tccli/services/tms/v20201229/examples.json +16 -0
  191. tccli/services/tmt/v20180321/api.json +78 -1
  192. tccli/services/trabbit/v20230418/api.json +271 -4
  193. tccli/services/trabbit/v20230418/examples.json +9 -3
  194. tccli/services/trocket/v20230308/api.json +4 -4
  195. tccli/services/trro/trro_client.py +106 -0
  196. tccli/services/trro/v20220325/api.json +456 -0
  197. tccli/services/trro/v20220325/examples.json +16 -0
  198. tccli/services/trtc/v20190722/api.json +197 -49
  199. tccli/services/trtc/v20190722/examples.json +4 -4
  200. tccli/services/tse/v20201207/api.json +69 -2
  201. tccli/services/tse/v20201207/examples.json +3 -3
  202. tccli/services/tsf/v20180326/api.json +70 -7
  203. tccli/services/tsf/v20180326/examples.json +2 -2
  204. tccli/services/vclm/v20240523/api.json +145 -0
  205. tccli/services/vclm/v20240523/examples.json +16 -0
  206. tccli/services/vclm/vclm_client.py +106 -0
  207. tccli/services/vcube/v20220410/api.json +1 -1
  208. tccli/services/vod/v20180717/api.json +7 -7
  209. tccli/services/vpc/v20170312/api.json +1216 -70
  210. tccli/services/vpc/v20170312/examples.json +139 -3
  211. tccli/services/vpc/vpc_client.py +1023 -122
  212. tccli/services/vrs/v20200824/api.json +11 -11
  213. tccli/services/vrs/v20200824/examples.json +1 -1
  214. tccli/services/vtc/v20240223/api.json +14 -14
  215. tccli/services/waf/v20180125/api.json +812 -143
  216. tccli/services/waf/v20180125/examples.json +2 -2
  217. tccli/services/wedata/v20210820/api.json +1281 -601
  218. tccli/services/wedata/v20210820/examples.json +127 -157
  219. tccli/services/wedata/v20250806/api.json +19335 -0
  220. tccli/services/wedata/v20250806/examples.json +999 -0
  221. tccli/services/wedata/wedata_client.py +7072 -1131
  222. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/METADATA +9 -7
  223. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/RECORD +226 -224
  224. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/WHEEL +1 -1
  225. {tccli-3.0.1391.1.dist-info → tccli-3.0.1414.1.dist-info}/entry_points.txt +0 -0
  226. {tccli-3.0.1391.1.dist-info/license_files → tccli-3.0.1414.1.dist-info/licenses}/LICENSE +0 -0
@@ -57,9 +57,9 @@
57
57
  "status": "online"
58
58
  },
59
59
  "DeleteGroup": {
60
- "document": "删除该人员库及包含的所有的人员。同时,人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中,该人员不会被删除,但属于该人员库中的自定义描述字段信息会被删除,属于其他人员库的自定义描述字段信息不受影响。\n",
60
+ "document": "删除该人员库及包含的所有的人员。同时,人员对应的所有人脸信息将被删除。若某人员同时存在多个人员库中,该人员不会被删除,但属于该人员库中的自定义描述字段信息会被删除,属于其他人员库的自定义描述字段信息不受影响。",
61
61
  "input": "DeleteGroupRequest",
62
- "name": "删除人员库",
62
+ "name": "人员库删除",
63
63
  "output": "DeleteGroupResponse",
64
64
  "status": "online"
65
65
  },
@@ -129,7 +129,7 @@
129
129
  "GetPersonList": {
130
130
  "document": "获取指定人员库中的人员列表。",
131
131
  "input": "GetPersonListRequest",
132
- "name": "获取人员列表",
132
+ "name": "人员列表",
133
133
  "output": "GetPersonListResponse",
134
134
  "status": "online"
135
135
  },
@@ -709,7 +709,7 @@
709
709
  {
710
710
  "disabled": false,
711
711
  "document": "图片 base64 数据,base64 编码后大小不可超过5M。\n人员人脸总数量不可超过5张。\n若图片中包含多张人脸,只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。",
712
- "example": "",
712
+ "example": "[\"/9j/4AAQSkZJRg.....s97n//2Q==\"]",
713
713
  "member": "string",
714
714
  "name": "Images",
715
715
  "required": false,
@@ -727,7 +727,7 @@
727
727
  {
728
728
  "disabled": false,
729
729
  "document": "只有和该人员已有的人脸相似度超过FaceMatchThreshold值的人脸,才能增加人脸成功。 \n默认值60分。取值范围[0,100] 。",
730
- "example": "60",
730
+ "example": "60.0",
731
731
  "member": "float",
732
732
  "name": "FaceMatchThreshold",
733
733
  "required": false,
@@ -790,7 +790,7 @@
790
790
  {
791
791
  "disabled": false,
792
792
  "document": "加入成功的人脸索引。索引顺序和入参中 Images 或 Urls 的顺序一致。 \n例, Urls 中 有 3 个 url,第二个 url 失败,则 SucIndexes 值为 [0,2] 。",
793
- "example": "",
793
+ "example": "[0]",
794
794
  "member": "uint64",
795
795
  "name": "SucIndexes",
796
796
  "output_required": true,
@@ -810,7 +810,7 @@
810
810
  {
811
811
  "disabled": false,
812
812
  "document": "人脸识别所用的算法模型版本。",
813
- "example": "",
813
+ "example": "\"3.0\"",
814
814
  "member": "string",
815
815
  "name": "FaceModelVersion",
816
816
  "output_required": true,
@@ -1109,7 +1109,7 @@
1109
1109
  {
1110
1110
  "disabled": false,
1111
1111
  "document": "人员库ID。",
1112
- "example": "",
1112
+ "example": "ZhuYuanDormitoryNo1",
1113
1113
  "member": "string",
1114
1114
  "name": "GroupId",
1115
1115
  "required": true,
@@ -1199,180 +1199,180 @@
1199
1199
  {
1200
1200
  "disabled": false,
1201
1201
  "document": "人脸框左上角横坐标。",
1202
- "example": "",
1202
+ "example": "198",
1203
1203
  "member": "int64",
1204
1204
  "name": "X",
1205
- "required": true,
1205
+ "output_required": true,
1206
1206
  "type": "int",
1207
1207
  "value_allowed_null": false
1208
1208
  },
1209
1209
  {
1210
1210
  "disabled": false,
1211
1211
  "document": "人脸框左上角纵坐标。",
1212
- "example": "",
1212
+ "example": "254",
1213
1213
  "member": "int64",
1214
1214
  "name": "Y",
1215
- "required": true,
1215
+ "output_required": true,
1216
1216
  "type": "int",
1217
1217
  "value_allowed_null": false
1218
1218
  },
1219
1219
  {
1220
1220
  "disabled": false,
1221
1221
  "document": "人脸框宽度。",
1222
- "example": "",
1222
+ "example": "853",
1223
1223
  "member": "int64",
1224
1224
  "name": "Width",
1225
- "required": true,
1225
+ "output_required": true,
1226
1226
  "type": "int",
1227
1227
  "value_allowed_null": false
1228
1228
  },
1229
1229
  {
1230
1230
  "disabled": false,
1231
1231
  "document": "人脸框高度。",
1232
- "example": "",
1232
+ "example": "468",
1233
1233
  "member": "int64",
1234
1234
  "name": "Height",
1235
- "required": true,
1235
+ "output_required": true,
1236
1236
  "type": "int",
1237
1237
  "value_allowed_null": false
1238
1238
  },
1239
1239
  {
1240
1240
  "disabled": false,
1241
1241
  "document": "描述左侧眼睛轮廓的 XX 点。",
1242
- "example": "",
1242
+ "example": "",
1243
1243
  "member": "Point",
1244
1244
  "name": "LeftEye",
1245
- "required": true,
1245
+ "output_required": true,
1246
1246
  "type": "list",
1247
1247
  "value_allowed_null": false
1248
1248
  },
1249
1249
  {
1250
1250
  "disabled": false,
1251
1251
  "document": "描述右侧眼睛轮廓的 XX 点。",
1252
- "example": "",
1252
+ "example": "",
1253
1253
  "member": "Point",
1254
1254
  "name": "RightEye",
1255
- "required": true,
1255
+ "output_required": true,
1256
1256
  "type": "list",
1257
1257
  "value_allowed_null": false
1258
1258
  },
1259
1259
  {
1260
1260
  "disabled": false,
1261
1261
  "document": "描述左侧眉毛轮廓的 XX 点。",
1262
- "example": "",
1262
+ "example": "",
1263
1263
  "member": "Point",
1264
1264
  "name": "LeftEyeBrow",
1265
- "required": true,
1265
+ "output_required": true,
1266
1266
  "type": "list",
1267
1267
  "value_allowed_null": false
1268
1268
  },
1269
1269
  {
1270
1270
  "disabled": false,
1271
1271
  "document": "描述右侧眉毛轮廓的 XX 点。",
1272
- "example": "",
1272
+ "example": "",
1273
1273
  "member": "Point",
1274
1274
  "name": "RightEyeBrow",
1275
- "required": true,
1275
+ "output_required": true,
1276
1276
  "type": "list",
1277
1277
  "value_allowed_null": false
1278
1278
  },
1279
1279
  {
1280
1280
  "disabled": false,
1281
1281
  "document": "描述外嘴巴轮廓的 XX 点, 从左侧开始逆时针返回。",
1282
- "example": "",
1282
+ "example": "",
1283
1283
  "member": "Point",
1284
1284
  "name": "MouthOutside",
1285
- "required": true,
1285
+ "output_required": true,
1286
1286
  "type": "list",
1287
1287
  "value_allowed_null": false
1288
1288
  },
1289
1289
  {
1290
1290
  "disabled": false,
1291
1291
  "document": "描述内嘴巴轮廓的 XX 点,从左侧开始逆时针返回。",
1292
- "example": "",
1292
+ "example": "",
1293
1293
  "member": "Point",
1294
1294
  "name": "MouthInside",
1295
- "required": true,
1295
+ "output_required": true,
1296
1296
  "type": "list",
1297
1297
  "value_allowed_null": false
1298
1298
  },
1299
1299
  {
1300
1300
  "disabled": false,
1301
1301
  "document": "描述鼻子轮廓的 XX 点。",
1302
- "example": "",
1302
+ "example": "",
1303
1303
  "member": "Point",
1304
1304
  "name": "Nose",
1305
- "required": true,
1305
+ "output_required": true,
1306
1306
  "type": "list",
1307
1307
  "value_allowed_null": false
1308
1308
  },
1309
1309
  {
1310
1310
  "disabled": false,
1311
1311
  "document": "左瞳孔轮廓的 XX 个点。",
1312
- "example": "",
1312
+ "example": "",
1313
1313
  "member": "Point",
1314
1314
  "name": "LeftPupil",
1315
- "required": true,
1315
+ "output_required": true,
1316
1316
  "type": "list",
1317
1317
  "value_allowed_null": false
1318
1318
  },
1319
1319
  {
1320
1320
  "disabled": false,
1321
1321
  "document": "右瞳孔轮廓的 XX 个点。",
1322
- "example": "",
1322
+ "example": "",
1323
1323
  "member": "Point",
1324
1324
  "name": "RightPupil",
1325
- "required": true,
1325
+ "output_required": true,
1326
1326
  "type": "list",
1327
1327
  "value_allowed_null": false
1328
1328
  },
1329
1329
  {
1330
1330
  "disabled": false,
1331
1331
  "document": "中轴线轮廓的 XX 个点。",
1332
- "example": "",
1332
+ "example": "",
1333
1333
  "member": "Point",
1334
1334
  "name": "CentralAxis",
1335
- "required": true,
1335
+ "output_required": true,
1336
1336
  "type": "list",
1337
1337
  "value_allowed_null": false
1338
1338
  },
1339
1339
  {
1340
1340
  "disabled": false,
1341
1341
  "document": "下巴轮廓的 XX 个点。",
1342
- "example": "",
1342
+ "example": "",
1343
1343
  "member": "Point",
1344
1344
  "name": "Chin",
1345
- "required": true,
1345
+ "output_required": true,
1346
1346
  "type": "list",
1347
1347
  "value_allowed_null": false
1348
1348
  },
1349
1349
  {
1350
1350
  "disabled": false,
1351
1351
  "document": "左眼袋的 XX 个点。",
1352
- "example": "",
1352
+ "example": "",
1353
1353
  "member": "Point",
1354
1354
  "name": "LeftEyeBags",
1355
- "required": true,
1355
+ "output_required": true,
1356
1356
  "type": "list",
1357
1357
  "value_allowed_null": false
1358
1358
  },
1359
1359
  {
1360
1360
  "disabled": false,
1361
1361
  "document": "右眼袋的 XX 个点。",
1362
- "example": "",
1362
+ "example": "",
1363
1363
  "member": "Point",
1364
1364
  "name": "RightEyeBags",
1365
- "required": true,
1365
+ "output_required": true,
1366
1366
  "type": "list",
1367
1367
  "value_allowed_null": false
1368
1368
  },
1369
1369
  {
1370
1370
  "disabled": false,
1371
1371
  "document": "额头的 XX 个点。",
1372
- "example": "",
1372
+ "example": "",
1373
1373
  "member": "Point",
1374
1374
  "name": "Forehead",
1375
- "required": true,
1375
+ "output_required": true,
1376
1376
  "type": "list",
1377
1377
  "value_allowed_null": false
1378
1378
  }
@@ -1784,7 +1784,7 @@
1784
1784
  {
1785
1785
  "disabled": false,
1786
1786
  "document": "性别[0~49]为女性,[50,100]为男性,越接近0和100表示置信度越高。NeedFaceAttributes 不为 1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。",
1787
- "example": "",
1787
+ "example": "40",
1788
1788
  "member": "int64",
1789
1789
  "name": "Gender",
1790
1790
  "output_required": true,
@@ -1794,7 +1794,7 @@
1794
1794
  {
1795
1795
  "disabled": false,
1796
1796
  "document": "年龄 [0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。",
1797
- "example": "",
1797
+ "example": "39",
1798
1798
  "member": "int64",
1799
1799
  "name": "Age",
1800
1800
  "output_required": true,
@@ -1804,7 +1804,7 @@
1804
1804
  {
1805
1805
  "disabled": false,
1806
1806
  "document": "微笑[0(normal,正常))~100(laugh,大笑)]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。",
1807
- "example": "",
1807
+ "example": "13",
1808
1808
  "member": "int64",
1809
1809
  "name": "Expression",
1810
1810
  "output_required": true,
@@ -1814,7 +1814,7 @@
1814
1814
  {
1815
1815
  "disabled": false,
1816
1816
  "document": "是否有眼镜 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。",
1817
- "example": "",
1817
+ "example": "true",
1818
1818
  "member": "bool",
1819
1819
  "name": "Glass",
1820
1820
  "output_required": true,
@@ -1824,7 +1824,7 @@
1824
1824
  {
1825
1825
  "disabled": false,
1826
1826
  "document": "上下偏移[-30,30],单位角度。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 \n建议:人脸入库选择[-10,10]的图片。",
1827
- "example": "",
1827
+ "example": "13",
1828
1828
  "member": "int64",
1829
1829
  "name": "Pitch",
1830
1830
  "output_required": true,
@@ -1834,7 +1834,7 @@
1834
1834
  {
1835
1835
  "disabled": false,
1836
1836
  "document": "左右偏移[-30,30],单位角度。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 \n建议:人脸入库选择[-10,10]的图片。",
1837
- "example": "",
1837
+ "example": "21",
1838
1838
  "member": "int64",
1839
1839
  "name": "Yaw",
1840
1840
  "output_required": true,
@@ -1844,7 +1844,7 @@
1844
1844
  {
1845
1845
  "disabled": false,
1846
1846
  "document": "平面旋转[-180,180],单位角度。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。 \n建议:人脸入库选择[-20,20]的图片。",
1847
- "example": "",
1847
+ "example": "54",
1848
1848
  "member": "int64",
1849
1849
  "name": "Roll",
1850
1850
  "output_required": true,
@@ -1854,7 +1854,7 @@
1854
1854
  {
1855
1855
  "disabled": false,
1856
1856
  "document": "魅力[0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。",
1857
- "example": "",
1857
+ "example": "50",
1858
1858
  "member": "int64",
1859
1859
  "name": "Beauty",
1860
1860
  "output_required": true,
@@ -1864,7 +1864,7 @@
1864
1864
  {
1865
1865
  "disabled": false,
1866
1866
  "document": "是否有帽子 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。\n注意:此字段可能返回 null,表示取不到有效值。",
1867
- "example": "",
1867
+ "example": "true",
1868
1868
  "member": "bool",
1869
1869
  "name": "Hat",
1870
1870
  "output_required": true,
@@ -1874,7 +1874,7 @@
1874
1874
  {
1875
1875
  "disabled": false,
1876
1876
  "document": "是否有口罩 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。\n注意:此字段可能返回 null,表示取不到有效值。",
1877
- "example": "",
1877
+ "example": "true",
1878
1878
  "member": "bool",
1879
1879
  "name": "Mask",
1880
1880
  "output_required": true,
@@ -1894,7 +1894,7 @@
1894
1894
  {
1895
1895
  "disabled": false,
1896
1896
  "document": "双眼是否睁开 [true,false]。只要有超过一只眼睛闭眼,就返回false。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。\n注意:此字段可能返回 null,表示取不到有效值。",
1897
- "example": "",
1897
+ "example": "true",
1898
1898
  "member": "bool",
1899
1899
  "name": "EyeOpen",
1900
1900
  "output_required": true,
@@ -2102,30 +2102,30 @@
2102
2102
  {
2103
2103
  "disabled": false,
2104
2104
  "document": "0:光头,1:短发,2:中发,3:长发,4:绑发\n注意:此字段可能返回 null,表示取不到有效值。",
2105
- "example": "",
2105
+ "example": "1",
2106
2106
  "member": "int64",
2107
2107
  "name": "Length",
2108
- "required": true,
2108
+ "output_required": true,
2109
2109
  "type": "int",
2110
2110
  "value_allowed_null": true
2111
2111
  },
2112
2112
  {
2113
2113
  "disabled": false,
2114
2114
  "document": "0:有刘海,1:无刘海\n注意:此字段可能返回 null,表示取不到有效值。",
2115
- "example": "",
2115
+ "example": "0",
2116
2116
  "member": "int64",
2117
2117
  "name": "Bang",
2118
- "required": true,
2118
+ "output_required": true,
2119
2119
  "type": "int",
2120
2120
  "value_allowed_null": true
2121
2121
  },
2122
2122
  {
2123
2123
  "disabled": false,
2124
2124
  "document": "0:黑色,1:金色,2:棕色,3:灰白色\n注意:此字段可能返回 null,表示取不到有效值。",
2125
- "example": "",
2125
+ "example": "1",
2126
2126
  "member": "int64",
2127
2127
  "name": "Color",
2128
- "required": true,
2128
+ "output_required": true,
2129
2129
  "type": "int",
2130
2130
  "value_allowed_null": true
2131
2131
  }
@@ -2138,60 +2138,60 @@
2138
2138
  {
2139
2139
  "disabled": false,
2140
2140
  "document": "人脸框左上角横坐标。\n人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。 \n若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。",
2141
- "example": "",
2141
+ "example": "35",
2142
2142
  "member": "int64",
2143
2143
  "name": "X",
2144
- "required": true,
2144
+ "output_required": true,
2145
2145
  "type": "int",
2146
2146
  "value_allowed_null": false
2147
2147
  },
2148
2148
  {
2149
2149
  "disabled": false,
2150
2150
  "document": "人脸框左上角纵坐标。 \n人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。 \n若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。",
2151
- "example": "",
2151
+ "example": "61",
2152
2152
  "member": "int64",
2153
2153
  "name": "Y",
2154
- "required": true,
2154
+ "output_required": true,
2155
2155
  "type": "int",
2156
2156
  "value_allowed_null": false
2157
2157
  },
2158
2158
  {
2159
2159
  "disabled": false,
2160
2160
  "document": "人脸框宽度。",
2161
- "example": "",
2161
+ "example": "10",
2162
2162
  "member": "int64",
2163
2163
  "name": "Width",
2164
- "required": true,
2164
+ "output_required": true,
2165
2165
  "type": "int",
2166
2166
  "value_allowed_null": false
2167
2167
  },
2168
2168
  {
2169
2169
  "disabled": false,
2170
2170
  "document": "人脸框高度。",
2171
- "example": "",
2171
+ "example": "8",
2172
2172
  "member": "int64",
2173
2173
  "name": "Height",
2174
- "required": true,
2174
+ "output_required": true,
2175
2175
  "type": "int",
2176
2176
  "value_allowed_null": false
2177
2177
  },
2178
2178
  {
2179
2179
  "disabled": false,
2180
2180
  "document": "人脸属性信息,包含性别( gender )、年龄( age )、表情( expression )、 \n魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息。",
2181
- "example": "",
2181
+ "example": "",
2182
2182
  "member": "FaceAttributesInfo",
2183
2183
  "name": "FaceAttributesInfo",
2184
- "required": true,
2184
+ "output_required": true,
2185
2185
  "type": "object",
2186
2186
  "value_allowed_null": false
2187
2187
  },
2188
2188
  {
2189
2189
  "disabled": false,
2190
2190
  "document": "人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。\n注意:此字段可能返回 null,表示取不到有效值。",
2191
- "example": "",
2191
+ "example": "",
2192
2192
  "member": "FaceQualityInfo",
2193
2193
  "name": "FaceQualityInfo",
2194
- "required": true,
2194
+ "output_required": true,
2195
2195
  "type": "object",
2196
2196
  "value_allowed_null": true
2197
2197
  }
@@ -2204,60 +2204,60 @@
2204
2204
  {
2205
2205
  "disabled": false,
2206
2206
  "document": "眉毛的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围:[0,80]表示发生遮挡。\n注意:此字段可能返回 null,表示取不到有效值。",
2207
- "example": "",
2207
+ "example": "70",
2208
2208
  "member": "int64",
2209
2209
  "name": "Eyebrow",
2210
- "required": true,
2210
+ "output_required": true,
2211
2211
  "type": "int",
2212
2212
  "value_allowed_null": true
2213
2213
  },
2214
2214
  {
2215
2215
  "disabled": false,
2216
2216
  "document": "眼睛的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围:[0,80]表示发生遮挡。\n注意:此字段可能返回 null,表示取不到有效值。",
2217
- "example": "",
2217
+ "example": "60",
2218
2218
  "member": "int64",
2219
2219
  "name": "Eye",
2220
- "required": true,
2220
+ "output_required": true,
2221
2221
  "type": "int",
2222
2222
  "value_allowed_null": true
2223
2223
  },
2224
2224
  {
2225
2225
  "disabled": false,
2226
2226
  "document": "鼻子的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围:[0,60]表示发生遮挡。\n注意:此字段可能返回 null,表示取不到有效值。",
2227
- "example": "",
2227
+ "example": "30",
2228
2228
  "member": "int64",
2229
2229
  "name": "Nose",
2230
- "required": true,
2230
+ "output_required": true,
2231
2231
  "type": "int",
2232
2232
  "value_allowed_null": true
2233
2233
  },
2234
2234
  {
2235
2235
  "disabled": false,
2236
2236
  "document": "脸颊的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围:[0,70]表示发生遮挡。\n注意:此字段可能返回 null,表示取不到有效值。",
2237
- "example": "",
2237
+ "example": "10",
2238
2238
  "member": "int64",
2239
2239
  "name": "Cheek",
2240
- "required": true,
2240
+ "output_required": true,
2241
2241
  "type": "int",
2242
2242
  "value_allowed_null": true
2243
2243
  },
2244
2244
  {
2245
2245
  "disabled": false,
2246
2246
  "document": "嘴巴的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围:[0,50]表示发生遮挡。\n注意:此字段可能返回 null,表示取不到有效值。",
2247
- "example": "",
2247
+ "example": "20",
2248
2248
  "member": "int64",
2249
2249
  "name": "Mouth",
2250
- "required": true,
2250
+ "output_required": true,
2251
2251
  "type": "int",
2252
2252
  "value_allowed_null": true
2253
2253
  },
2254
2254
  {
2255
2255
  "disabled": false,
2256
2256
  "document": "下巴的遮挡分数[0,100],分数越高遮挡越少。 \n参考范围:[0,70]表示发生遮挡。\n注意:此字段可能返回 null,表示取不到有效值。",
2257
- "example": "",
2257
+ "example": "10",
2258
2258
  "member": "int64",
2259
2259
  "name": "Chin",
2260
- "required": true,
2260
+ "output_required": true,
2261
2261
  "type": "int",
2262
2262
  "value_allowed_null": true
2263
2263
  }
@@ -2270,40 +2270,40 @@
2270
2270
  {
2271
2271
  "disabled": false,
2272
2272
  "document": "质量分: [0,100],综合评价图像质量是否适合人脸识别,分数越高质量越好。 \n正常情况,只需要使用Score作为质量分总体的判断标准即可。Sharpness、Brightness、Completeness等细项分仅供参考。\n参考范围:[0,40]较差,[40,60] 一般,[60,80]较好,[80,100]很好。 \n建议:人脸入库选取70以上的图片。\n注意:此字段可能返回 null,表示取不到有效值。",
2273
- "example": "",
2273
+ "example": "80",
2274
2274
  "member": "int64",
2275
2275
  "name": "Score",
2276
- "required": true,
2276
+ "output_required": true,
2277
2277
  "type": "int",
2278
2278
  "value_allowed_null": true
2279
2279
  },
2280
2280
  {
2281
2281
  "disabled": false,
2282
2282
  "document": "清晰分:[0,100],评价图片清晰程度,分数越高越清晰。 \n参考范围:[0,40]特别模糊,[40,60]模糊,[60,80]一般,[80,100]清晰。 \n建议:人脸入库选取80以上的图片。\n注意:此字段可能返回 null,表示取不到有效值。",
2283
- "example": "",
2283
+ "example": "100",
2284
2284
  "member": "int64",
2285
2285
  "name": "Sharpness",
2286
- "required": true,
2286
+ "output_required": true,
2287
2287
  "type": "int",
2288
2288
  "value_allowed_null": true
2289
2289
  },
2290
2290
  {
2291
2291
  "disabled": false,
2292
2292
  "document": "光照分:[0,100],评价图片光照程度,分数越高越亮。 \n参考范围: [0,30]偏暗,[30,70]光照正常,[70,100]偏亮。 \n建议:人脸入库选取[30,70]的图片。\n注意:此字段可能返回 null,表示取不到有效值。",
2293
- "example": "",
2293
+ "example": "30",
2294
2294
  "member": "int64",
2295
2295
  "name": "Brightness",
2296
- "required": true,
2296
+ "output_required": true,
2297
2297
  "type": "int",
2298
2298
  "value_allowed_null": true
2299
2299
  },
2300
2300
  {
2301
2301
  "disabled": false,
2302
2302
  "document": "五官遮挡分,评价眉毛(Eyebrow)、眼睛(Eye)、鼻子(Nose)、脸颊(Cheek)、嘴巴(Mouth)、下巴(Chin)的被遮挡程度。\n注意:此字段可能返回 null,表示取不到有效值。",
2303
- "example": "",
2303
+ "example": "",
2304
2304
  "member": "FaceQualityCompleteness",
2305
2305
  "name": "Completeness",
2306
- "required": true,
2306
+ "output_required": true,
2307
2307
  "type": "object",
2308
2308
  "value_allowed_null": true
2309
2309
  }
@@ -2462,7 +2462,7 @@
2462
2462
  {
2463
2463
  "disabled": false,
2464
2464
  "document": "人员库 ID。",
2465
- "example": "",
2465
+ "example": "\"31\"",
2466
2466
  "member": "string",
2467
2467
  "name": "GroupId",
2468
2468
  "required": true,
@@ -2477,54 +2477,60 @@
2477
2477
  {
2478
2478
  "disabled": false,
2479
2479
  "document": "人员库名称",
2480
- "example": "",
2480
+ "example": "人员库",
2481
2481
  "member": "string",
2482
2482
  "name": "GroupName",
2483
+ "output_required": true,
2483
2484
  "type": "string",
2484
2485
  "value_allowed_null": false
2485
2486
  },
2486
2487
  {
2487
2488
  "disabled": false,
2488
2489
  "document": "人员库ID",
2489
- "example": "",
2490
+ "example": "\"31\"",
2490
2491
  "member": "string",
2491
2492
  "name": "GroupId",
2493
+ "output_required": true,
2492
2494
  "type": "string",
2493
2495
  "value_allowed_null": false
2494
2496
  },
2495
2497
  {
2496
2498
  "disabled": false,
2497
2499
  "document": "人员库自定义描述字段",
2498
- "example": "",
2500
+ "example": "[\"年龄\"]",
2499
2501
  "member": "string",
2500
2502
  "name": "GroupExDescriptions",
2503
+ "output_required": true,
2501
2504
  "type": "list",
2502
2505
  "value_allowed_null": false
2503
2506
  },
2504
2507
  {
2505
2508
  "disabled": false,
2506
2509
  "document": "人员库信息备注",
2507
- "example": "",
2510
+ "example": "\"不含实习生\"",
2508
2511
  "member": "string",
2509
2512
  "name": "Tag",
2513
+ "output_required": true,
2510
2514
  "type": "string",
2511
2515
  "value_allowed_null": false
2512
2516
  },
2513
2517
  {
2514
2518
  "disabled": false,
2515
2519
  "document": "人脸识别所用的算法模型版本。",
2516
- "example": "",
2520
+ "example": "\"3.0\"",
2517
2521
  "member": "string",
2518
2522
  "name": "FaceModelVersion",
2523
+ "output_required": true,
2519
2524
  "type": "string",
2520
2525
  "value_allowed_null": false
2521
2526
  },
2522
2527
  {
2523
2528
  "disabled": false,
2524
2529
  "document": "Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。",
2525
- "example": "",
2530
+ "example": "1559530931613",
2526
2531
  "member": "uint64",
2527
2532
  "name": "CreationTimestamp",
2533
+ "output_required": true,
2528
2534
  "type": "int",
2529
2535
  "value_allowed_null": false
2530
2536
  },
@@ -2599,7 +2605,7 @@
2599
2605
  {
2600
2606
  "disabled": false,
2601
2607
  "document": "人员ID",
2602
- "example": "",
2608
+ "example": "\"1001\"",
2603
2609
  "member": "string",
2604
2610
  "name": "PersonId",
2605
2611
  "required": true,
@@ -2614,27 +2620,30 @@
2614
2620
  {
2615
2621
  "disabled": false,
2616
2622
  "document": "人员名称",
2617
- "example": "",
2623
+ "example": "\"EvanLiao\"",
2618
2624
  "member": "string",
2619
2625
  "name": "PersonName",
2626
+ "output_required": true,
2620
2627
  "type": "string",
2621
2628
  "value_allowed_null": false
2622
2629
  },
2623
2630
  {
2624
2631
  "disabled": false,
2625
2632
  "document": "人员性别",
2626
- "example": "",
2633
+ "example": "1",
2627
2634
  "member": "int64",
2628
2635
  "name": "Gender",
2636
+ "output_required": true,
2629
2637
  "type": "int",
2630
2638
  "value_allowed_null": false
2631
2639
  },
2632
2640
  {
2633
2641
  "disabled": false,
2634
2642
  "document": "包含的人脸 ID 列表",
2635
- "example": "",
2643
+ "example": "[\"2873640802022644880\",\"2875186538564559728\"]",
2636
2644
  "member": "string",
2637
2645
  "name": "FaceIds",
2646
+ "output_required": true,
2638
2647
  "type": "list",
2639
2648
  "value_allowed_null": false
2640
2649
  },
@@ -2653,7 +2662,7 @@
2653
2662
  {
2654
2663
  "disabled": false,
2655
2664
  "document": "人员ID",
2656
- "example": "",
2665
+ "example": "1002",
2657
2666
  "member": "string",
2658
2667
  "name": "PersonId",
2659
2668
  "required": true,
@@ -2662,7 +2671,7 @@
2662
2671
  {
2663
2672
  "disabled": false,
2664
2673
  "document": "起始序号,默认值为0",
2665
- "example": "",
2674
+ "example": "0",
2666
2675
  "member": "uint64",
2667
2676
  "name": "Offset",
2668
2677
  "required": false,
@@ -2671,7 +2680,7 @@
2671
2680
  {
2672
2681
  "disabled": false,
2673
2682
  "document": "返回数量,默认值为10,最大值为100",
2674
- "example": "",
2683
+ "example": "10",
2675
2684
  "member": "uint64",
2676
2685
  "name": "Limit",
2677
2686
  "required": false,
@@ -2686,27 +2695,30 @@
2686
2695
  {
2687
2696
  "disabled": false,
2688
2697
  "document": "包含此人员的人员库及描述字段内容列表",
2689
- "example": "",
2698
+ "example": "",
2690
2699
  "member": "PersonGroupInfo",
2691
2700
  "name": "PersonGroupInfos",
2701
+ "output_required": true,
2692
2702
  "type": "list",
2693
2703
  "value_allowed_null": false
2694
2704
  },
2695
2705
  {
2696
2706
  "disabled": false,
2697
2707
  "document": "人员库总数量\n注意:此字段可能返回 null,表示取不到有效值。",
2698
- "example": "",
2708
+ "example": "30",
2699
2709
  "member": "uint64",
2700
2710
  "name": "GroupNum",
2711
+ "output_required": true,
2701
2712
  "type": "int",
2702
2713
  "value_allowed_null": true
2703
2714
  },
2704
2715
  {
2705
2716
  "disabled": false,
2706
2717
  "document": "人脸识别服务所用的算法模型版本。\n注意:此字段可能返回 null,表示取不到有效值。",
2707
- "example": "",
2718
+ "example": "\"3.0\"",
2708
2719
  "member": "string",
2709
2720
  "name": "FaceModelVersion",
2721
+ "output_required": true,
2710
2722
  "type": "string",
2711
2723
  "value_allowed_null": true
2712
2724
  },
@@ -2725,7 +2737,7 @@
2725
2737
  {
2726
2738
  "disabled": false,
2727
2739
  "document": "人员库ID",
2728
- "example": "",
2740
+ "example": "TencentShenZhenEmployee",
2729
2741
  "member": "string",
2730
2742
  "name": "GroupId",
2731
2743
  "required": true,
@@ -2740,18 +2752,20 @@
2740
2752
  {
2741
2753
  "disabled": false,
2742
2754
  "document": "人员数量",
2743
- "example": "",
2755
+ "example": "10",
2744
2756
  "member": "uint64",
2745
2757
  "name": "PersonNum",
2758
+ "output_required": true,
2746
2759
  "type": "int",
2747
2760
  "value_allowed_null": false
2748
2761
  },
2749
2762
  {
2750
2763
  "disabled": false,
2751
2764
  "document": "人脸数量",
2752
- "example": "",
2765
+ "example": "10",
2753
2766
  "member": "uint64",
2754
2767
  "name": "FaceNum",
2768
+ "output_required": true,
2755
2769
  "type": "int",
2756
2770
  "value_allowed_null": false
2757
2771
  },
@@ -2770,7 +2784,7 @@
2770
2784
  {
2771
2785
  "disabled": false,
2772
2786
  "document": "人员库ID",
2773
- "example": "",
2787
+ "example": "ZhuYuanDormitory",
2774
2788
  "member": "string",
2775
2789
  "name": "GroupId",
2776
2790
  "required": true,
@@ -2779,7 +2793,7 @@
2779
2793
  {
2780
2794
  "disabled": false,
2781
2795
  "document": "起始序号,默认值为0",
2782
- "example": "",
2796
+ "example": "0",
2783
2797
  "member": "uint64",
2784
2798
  "name": "Offset",
2785
2799
  "required": false,
@@ -2788,7 +2802,7 @@
2788
2802
  {
2789
2803
  "disabled": false,
2790
2804
  "document": "返回数量,默认值为10,最大值为1000",
2791
- "example": "",
2805
+ "example": "10",
2792
2806
  "member": "uint64",
2793
2807
  "name": "Limit",
2794
2808
  "required": false,
@@ -2803,36 +2817,40 @@
2803
2817
  {
2804
2818
  "disabled": false,
2805
2819
  "document": "返回的人员信息",
2806
- "example": "",
2820
+ "example": "",
2807
2821
  "member": "PersonInfo",
2808
2822
  "name": "PersonInfos",
2823
+ "output_required": true,
2809
2824
  "type": "list",
2810
2825
  "value_allowed_null": false
2811
2826
  },
2812
2827
  {
2813
2828
  "disabled": false,
2814
2829
  "document": "该人员库的人员数量\n注意:此字段可能返回 null,表示取不到有效值。",
2815
- "example": "",
2830
+ "example": "20",
2816
2831
  "member": "uint64",
2817
2832
  "name": "PersonNum",
2833
+ "output_required": true,
2818
2834
  "type": "int",
2819
2835
  "value_allowed_null": true
2820
2836
  },
2821
2837
  {
2822
2838
  "disabled": false,
2823
2839
  "document": "该人员库的人脸数量\n注意:此字段可能返回 null,表示取不到有效值。",
2824
- "example": "",
2840
+ "example": "20",
2825
2841
  "member": "uint64",
2826
2842
  "name": "FaceNum",
2843
+ "output_required": true,
2827
2844
  "type": "int",
2828
2845
  "value_allowed_null": true
2829
2846
  },
2830
2847
  {
2831
2848
  "disabled": false,
2832
2849
  "document": "人脸识别所用的算法模型版本。\n注意:此字段可能返回 null,表示取不到有效值。",
2833
- "example": "",
2850
+ "example": "\"3.0\"",
2834
2851
  "member": "string",
2835
2852
  "name": "FaceModelVersion",
2853
+ "output_required": true,
2836
2854
  "type": "string",
2837
2855
  "value_allowed_null": true
2838
2856
  },
@@ -3012,20 +3030,20 @@
3012
3030
  {
3013
3031
  "disabled": false,
3014
3032
  "document": "人员库ID 。",
3015
- "example": "",
3033
+ "example": "1001",
3016
3034
  "member": "string",
3017
3035
  "name": "GroupId",
3018
- "required": true,
3036
+ "output_required": true,
3019
3037
  "type": "string",
3020
3038
  "value_allowed_null": false
3021
3039
  },
3022
3040
  {
3023
3041
  "disabled": false,
3024
3042
  "document": "识别出的最相似候选人。",
3025
- "example": "",
3043
+ "example": "",
3026
3044
  "member": "Candidate",
3027
3045
  "name": "Candidates",
3028
- "required": true,
3046
+ "output_required": true,
3029
3047
  "type": "list",
3030
3048
  "value_allowed_null": false
3031
3049
  }
@@ -3038,22 +3056,20 @@
3038
3056
  {
3039
3057
  "disabled": false,
3040
3058
  "document": "人员库自定义描述字段Index,从0开始",
3041
- "example": "",
3059
+ "example": "0",
3042
3060
  "member": "uint64",
3043
3061
  "name": "GroupExDescriptionIndex",
3044
3062
  "required": true,
3045
- "type": "int",
3046
- "value_allowed_null": true
3063
+ "type": "int"
3047
3064
  },
3048
3065
  {
3049
3066
  "disabled": false,
3050
3067
  "document": "需要更新的人员库自定义描述字段内容",
3051
- "example": "",
3068
+ "example": "年龄",
3052
3069
  "member": "string",
3053
3070
  "name": "GroupExDescription",
3054
3071
  "required": true,
3055
- "type": "string",
3056
- "value_allowed_null": false
3072
+ "type": "string"
3057
3073
  }
3058
3074
  ],
3059
3075
  "usage": "in"
@@ -3064,60 +3080,60 @@
3064
3080
  {
3065
3081
  "disabled": false,
3066
3082
  "document": "人员库名称",
3067
- "example": "",
3083
+ "example": "人员库",
3068
3084
  "member": "string",
3069
3085
  "name": "GroupName",
3070
- "required": true,
3086
+ "output_required": true,
3071
3087
  "type": "string",
3072
3088
  "value_allowed_null": false
3073
3089
  },
3074
3090
  {
3075
3091
  "disabled": false,
3076
3092
  "document": "人员库ID",
3077
- "example": "",
3093
+ "example": "13",
3078
3094
  "member": "string",
3079
3095
  "name": "GroupId",
3080
- "required": true,
3096
+ "output_required": true,
3081
3097
  "type": "string",
3082
3098
  "value_allowed_null": false
3083
3099
  },
3084
3100
  {
3085
3101
  "disabled": false,
3086
3102
  "document": "人员库自定义描述字段\n注意:此字段可能返回 null,表示取不到有效值。",
3087
- "example": "",
3103
+ "example": "[\"年龄\"]",
3088
3104
  "member": "string",
3089
3105
  "name": "GroupExDescriptions",
3090
- "required": true,
3106
+ "output_required": true,
3091
3107
  "type": "list",
3092
3108
  "value_allowed_null": true
3093
3109
  },
3094
3110
  {
3095
3111
  "disabled": false,
3096
3112
  "document": "人员库信息备注\n注意:此字段可能返回 null,表示取不到有效值。",
3097
- "example": "",
3113
+ "example": "无实习生",
3098
3114
  "member": "string",
3099
3115
  "name": "Tag",
3100
- "required": true,
3116
+ "output_required": true,
3101
3117
  "type": "string",
3102
3118
  "value_allowed_null": true
3103
3119
  },
3104
3120
  {
3105
3121
  "disabled": false,
3106
3122
  "document": "人脸识别所用的算法模型版本。\n注意:此字段可能返回 null,表示取不到有效值。",
3107
- "example": "",
3123
+ "example": "3.0",
3108
3124
  "member": "string",
3109
3125
  "name": "FaceModelVersion",
3110
- "required": true,
3126
+ "output_required": true,
3111
3127
  "type": "string",
3112
3128
  "value_allowed_null": true
3113
3129
  },
3114
3130
  {
3115
3131
  "disabled": false,
3116
3132
  "document": "Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。 \nUnix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。\n注意:此字段可能返回 null,表示取不到有效值。",
3117
- "example": "",
3133
+ "example": "1694139227378",
3118
3134
  "member": "uint64",
3119
3135
  "name": "CreationTimestamp",
3120
- "required": true,
3136
+ "output_required": true,
3121
3137
  "type": "int",
3122
3138
  "value_allowed_null": true
3123
3139
  }
@@ -3228,7 +3244,7 @@
3228
3244
  {
3229
3245
  "disabled": false,
3230
3246
  "document": "人员库ID",
3231
- "example": "",
3247
+ "example": "\"32\"",
3232
3248
  "member": "string",
3233
3249
  "name": "GroupId",
3234
3250
  "required": true,
@@ -3237,7 +3253,7 @@
3237
3253
  {
3238
3254
  "disabled": false,
3239
3255
  "document": "人员库名称",
3240
- "example": "",
3256
+ "example": "人员库名单",
3241
3257
  "member": "string",
3242
3258
  "name": "GroupName",
3243
3259
  "required": false,
@@ -3246,7 +3262,7 @@
3246
3262
  {
3247
3263
  "disabled": false,
3248
3264
  "document": "需要修改的人员库自定义描述字段,key-value",
3249
- "example": "",
3265
+ "example": "",
3250
3266
  "member": "GroupExDescriptionInfo",
3251
3267
  "name": "GroupExDescriptionInfos",
3252
3268
  "required": false,
@@ -3255,7 +3271,7 @@
3255
3271
  {
3256
3272
  "disabled": false,
3257
3273
  "document": "人员库信息备注",
3258
- "example": "",
3274
+ "example": "无实习生",
3259
3275
  "member": "string",
3260
3276
  "name": "Tag",
3261
3277
  "required": false,
@@ -3282,7 +3298,7 @@
3282
3298
  {
3283
3299
  "disabled": false,
3284
3300
  "document": "人员ID",
3285
- "example": "",
3301
+ "example": "2001",
3286
3302
  "member": "string",
3287
3303
  "name": "PersonId",
3288
3304
  "required": true,
@@ -3291,7 +3307,7 @@
3291
3307
  {
3292
3308
  "disabled": false,
3293
3309
  "document": "需要修改的人员名称",
3294
- "example": "",
3310
+ "example": "韦小宝",
3295
3311
  "member": "string",
3296
3312
  "name": "PersonName",
3297
3313
  "required": false,
@@ -3300,7 +3316,7 @@
3300
3316
  {
3301
3317
  "disabled": false,
3302
3318
  "document": "需要修改的人员性别",
3303
- "example": "",
3319
+ "example": "1",
3304
3320
  "member": "int64",
3305
3321
  "name": "Gender",
3306
3322
  "required": false,
@@ -3327,7 +3343,7 @@
3327
3343
  {
3328
3344
  "disabled": false,
3329
3345
  "document": "人员库ID",
3330
- "example": "",
3346
+ "example": "TencentShenZhenEmployee",
3331
3347
  "member": "string",
3332
3348
  "name": "GroupId",
3333
3349
  "required": true,
@@ -3336,7 +3352,7 @@
3336
3352
  {
3337
3353
  "disabled": false,
3338
3354
  "document": "人员ID",
3339
- "example": "",
3355
+ "example": "1001",
3340
3356
  "member": "string",
3341
3357
  "name": "PersonId",
3342
3358
  "required": true,
@@ -3345,7 +3361,7 @@
3345
3361
  {
3346
3362
  "disabled": false,
3347
3363
  "document": "需要修改的人员描述字段内容,key-value",
3348
- "example": "",
3364
+ "example": "",
3349
3365
  "member": "PersonExDescriptionInfo",
3350
3366
  "name": "PersonExDescriptionInfos",
3351
3367
  "required": true,
@@ -3388,22 +3404,20 @@
3388
3404
  {
3389
3405
  "disabled": false,
3390
3406
  "document": "人员描述字段Index,从0开始",
3391
- "example": "",
3407
+ "example": "0",
3392
3408
  "member": "uint64",
3393
3409
  "name": "PersonExDescriptionIndex",
3394
3410
  "required": true,
3395
- "type": "int",
3396
- "value_allowed_null": true
3411
+ "type": "int"
3397
3412
  },
3398
3413
  {
3399
3414
  "disabled": false,
3400
3415
  "document": "需要更新的人员描述字段内容",
3401
- "example": "",
3416
+ "example": "年龄",
3402
3417
  "member": "string",
3403
3418
  "name": "PersonExDescription",
3404
3419
  "required": true,
3405
- "type": "string",
3406
- "value_allowed_null": false
3420
+ "type": "string"
3407
3421
  }
3408
3422
  ],
3409
3423
  "usage": "in"
@@ -3440,60 +3454,60 @@
3440
3454
  {
3441
3455
  "disabled": false,
3442
3456
  "document": "人员名称",
3443
- "example": "",
3457
+ "example": "韦小宝",
3444
3458
  "member": "string",
3445
3459
  "name": "PersonName",
3446
- "required": true,
3460
+ "output_required": true,
3447
3461
  "type": "string",
3448
3462
  "value_allowed_null": false
3449
3463
  },
3450
3464
  {
3451
3465
  "disabled": false,
3452
3466
  "document": "人员Id",
3453
- "example": "",
3467
+ "example": "1001",
3454
3468
  "member": "string",
3455
3469
  "name": "PersonId",
3456
- "required": true,
3470
+ "output_required": true,
3457
3471
  "type": "string",
3458
3472
  "value_allowed_null": false
3459
3473
  },
3460
3474
  {
3461
3475
  "disabled": false,
3462
3476
  "document": "人员性别",
3463
- "example": "",
3477
+ "example": "0",
3464
3478
  "member": "int64",
3465
3479
  "name": "Gender",
3466
- "required": true,
3480
+ "output_required": true,
3467
3481
  "type": "int",
3468
3482
  "value_allowed_null": false
3469
3483
  },
3470
3484
  {
3471
3485
  "disabled": false,
3472
3486
  "document": "人员描述字段内容",
3473
- "example": "",
3487
+ "example": "[\"年龄\"]",
3474
3488
  "member": "string",
3475
3489
  "name": "PersonExDescriptions",
3476
- "required": true,
3490
+ "output_required": true,
3477
3491
  "type": "list",
3478
3492
  "value_allowed_null": false
3479
3493
  },
3480
3494
  {
3481
3495
  "disabled": false,
3482
3496
  "document": "包含的人脸照片列表",
3483
- "example": "",
3497
+ "example": "[\"2877244861637985315\"]",
3484
3498
  "member": "string",
3485
3499
  "name": "FaceIds",
3486
- "required": true,
3500
+ "output_required": true,
3487
3501
  "type": "list",
3488
3502
  "value_allowed_null": false
3489
3503
  },
3490
3504
  {
3491
3505
  "disabled": false,
3492
3506
  "document": "人员的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。 \nUnix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。",
3493
- "example": "",
3507
+ "example": "1594642823572",
3494
3508
  "member": "uint64",
3495
3509
  "name": "CreationTimestamp",
3496
- "required": true,
3510
+ "output_required": true,
3497
3511
  "type": "int",
3498
3512
  "value_allowed_null": false
3499
3513
  }
@@ -3563,35 +3577,35 @@
3563
3577
  "usage": "out"
3564
3578
  },
3565
3579
  "ResultsReturnsByGroup": {
3566
- "document": "识别结果。\n",
3580
+ "document": "识别结果。",
3567
3581
  "members": [
3568
3582
  {
3569
3583
  "disabled": false,
3570
3584
  "document": "检测出的人脸框位置。",
3571
- "example": "",
3585
+ "example": "",
3572
3586
  "member": "FaceRect",
3573
3587
  "name": "FaceRect",
3574
- "required": true,
3588
+ "output_required": true,
3575
3589
  "type": "object",
3576
3590
  "value_allowed_null": false
3577
3591
  },
3578
3592
  {
3579
3593
  "disabled": false,
3580
3594
  "document": "识别结果。",
3581
- "example": "",
3595
+ "example": "",
3582
3596
  "member": "GroupCandidate",
3583
3597
  "name": "GroupCandidates",
3584
- "required": true,
3598
+ "output_required": true,
3585
3599
  "type": "list",
3586
3600
  "value_allowed_null": false
3587
3601
  },
3588
3602
  {
3589
3603
  "disabled": false,
3590
3604
  "document": "检测出的人脸图片状态返回码。0 表示正常。 \n-1601代表不符合图片质量控制要求,此时Candidate内容为空。",
3591
- "example": "",
3605
+ "example": "0",
3592
3606
  "member": "int64",
3593
3607
  "name": "RetCode",
3594
- "required": true,
3608
+ "output_required": true,
3595
3609
  "type": "int",
3596
3610
  "value_allowed_null": false
3597
3611
  }
@@ -3703,7 +3717,7 @@
3703
3717
  {
3704
3718
  "disabled": false,
3705
3719
  "document": "出参Score中,只有超过FaceMatchThreshold值的结果才会返回。默认为0。",
3706
- "example": "0",
3720
+ "example": "30.0",
3707
3721
  "member": "float",
3708
3722
  "name": "FaceMatchThreshold",
3709
3723
  "required": false,
@@ -3747,7 +3761,7 @@
3747
3761
  {
3748
3762
  "disabled": false,
3749
3763
  "document": "人脸识别所用的算法模型版本。",
3750
- "example": "",
3764
+ "example": "\"3.0\"",
3751
3765
  "member": "string",
3752
3766
  "name": "FaceModelVersion",
3753
3767
  "output_required": true,
@@ -4045,7 +4059,7 @@
4045
4059
  {
4046
4060
  "disabled": false,
4047
4061
  "document": "希望搜索的人员库列表,上限60个。",
4048
- "example": "",
4062
+ "example": "[\"TencentShenZhenEmployee\"]",
4049
4063
  "member": "string",
4050
4064
  "name": "GroupIds",
4051
4065
  "required": true,
@@ -4054,7 +4068,7 @@
4054
4068
  {
4055
4069
  "disabled": false,
4056
4070
  "document": "图片 base64 数据,base64 编码后大小不可超过5M。\n支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。",
4057
- "example": "",
4071
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
4058
4072
  "member": "string",
4059
4073
  "name": "Image",
4060
4074
  "required": false,
@@ -4063,7 +4077,7 @@
4063
4077
  {
4064
4078
  "disabled": false,
4065
4079
  "document": "图片的 Url 。对应图片 base64 编码后大小不可超过5M。\nUrl、Image必须提供一个,如果都提供,只使用 Url。\n图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。\n非腾讯云存储的Url速度和稳定性可能受一定影响。\n支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。",
4066
- "example": "",
4080
+ "example": "http://test.image.myqcloud.com/testB.jpg",
4067
4081
  "member": "string",
4068
4082
  "name": "Url",
4069
4083
  "required": false,
@@ -4072,7 +4086,7 @@
4072
4086
  {
4073
4087
  "disabled": false,
4074
4088
  "document": "最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。\nMaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。\n例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。",
4075
- "example": "",
4089
+ "example": "1",
4076
4090
  "member": "uint64",
4077
4091
  "name": "MaxFaceNum",
4078
4092
  "required": false,
@@ -4081,7 +4095,7 @@
4081
4095
  {
4082
4096
  "disabled": false,
4083
4097
  "document": "人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。",
4084
- "example": "",
4098
+ "example": "80",
4085
4099
  "member": "uint64",
4086
4100
  "name": "MinFaceSize",
4087
4101
  "required": false,
@@ -4090,7 +4104,7 @@
4090
4104
  {
4091
4105
  "disabled": false,
4092
4106
  "document": "被检测到的人脸,对应最多返回的最相似人员数目。默认值为5,最大值为10。 \n例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。",
4093
- "example": "",
4107
+ "example": "5",
4094
4108
  "member": "uint64",
4095
4109
  "name": "MaxPersonNumPerGroup",
4096
4110
  "required": false,
@@ -4099,7 +4113,7 @@
4099
4113
  {
4100
4114
  "disabled": false,
4101
4115
  "document": "图片质量控制。 \n0: 不进行控制; \n1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况; \n2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况; \n3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况; \n4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题; \n默认 0。 \n若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。",
4102
- "example": "",
4116
+ "example": "0",
4103
4117
  "member": "uint64",
4104
4118
  "name": "QualityControl",
4105
4119
  "required": false,
@@ -4108,7 +4122,7 @@
4108
4122
  {
4109
4123
  "disabled": false,
4110
4124
  "document": "出参Score中,只有超过FaceMatchThreshold值的结果才会返回。默认为0。",
4111
- "example": "",
4125
+ "example": "0.0",
4112
4126
  "member": "float",
4113
4127
  "name": "FaceMatchThreshold",
4114
4128
  "required": false,
@@ -4117,7 +4131,7 @@
4117
4131
  {
4118
4132
  "disabled": false,
4119
4133
  "document": "是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0",
4120
- "example": "",
4134
+ "example": "0",
4121
4135
  "member": "int64",
4122
4136
  "name": "NeedPersonInfo",
4123
4137
  "required": false,
@@ -4126,7 +4140,7 @@
4126
4140
  {
4127
4141
  "disabled": false,
4128
4142
  "document": "是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。",
4129
- "example": "",
4143
+ "example": "0",
4130
4144
  "member": "uint64",
4131
4145
  "name": "NeedRotateDetection",
4132
4146
  "required": false,
@@ -4141,27 +4155,30 @@
4141
4155
  {
4142
4156
  "disabled": false,
4143
4157
  "document": "搜索的人员库中包含的人员数。若输入图片中所有人脸均不符合质量要求,则返回0。",
4144
- "example": "",
4158
+ "example": "10",
4145
4159
  "member": "uint64",
4146
4160
  "name": "PersonNum",
4161
+ "output_required": true,
4147
4162
  "type": "int",
4148
4163
  "value_allowed_null": false
4149
4164
  },
4150
4165
  {
4151
4166
  "disabled": false,
4152
4167
  "document": "识别结果。",
4153
- "example": "",
4168
+ "example": "",
4154
4169
  "member": "ResultsReturnsByGroup",
4155
4170
  "name": "ResultsReturnsByGroup",
4171
+ "output_required": true,
4156
4172
  "type": "list",
4157
4173
  "value_allowed_null": false
4158
4174
  },
4159
4175
  {
4160
4176
  "disabled": false,
4161
4177
  "document": "人脸识别所用的算法模型版本。",
4162
- "example": "",
4178
+ "example": "\"3.0\"",
4163
4179
  "member": "string",
4164
4180
  "name": "FaceModelVersion",
4181
+ "output_required": true,
4165
4182
  "type": "string",
4166
4183
  "value_allowed_null": false
4167
4184
  },
@@ -4292,7 +4309,7 @@
4292
4309
  {
4293
4310
  "disabled": false,
4294
4311
  "document": "待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。",
4295
- "example": "11111111",
4312
+ "example": "1001",
4296
4313
  "member": "string",
4297
4314
  "name": "PersonId",
4298
4315
  "required": true,
@@ -4301,7 +4318,7 @@
4301
4318
  {
4302
4319
  "disabled": false,
4303
4320
  "document": "图片 base64 数据,base64 编码后大小不可超过5M。\n若图片中包含多张人脸,只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。",
4304
- "example": "",
4321
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
4305
4322
  "member": "string",
4306
4323
  "name": "Image",
4307
4324
  "required": false,
@@ -4343,20 +4360,20 @@
4343
4360
  {
4344
4361
  "disabled": false,
4345
4362
  "document": "给定的人脸图片与 PersonId 对应人脸的相似度。若 PersonId 下有多张人脸(Face),返回相似度最大的分数。\n\n不同算法版本返回的相似度分数不同。\n若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。\n2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。",
4346
- "example": "100",
4363
+ "example": "100.0",
4347
4364
  "member": "float",
4348
4365
  "name": "Score",
4349
- "required": true,
4366
+ "output_required": true,
4350
4367
  "type": "float",
4351
4368
  "value_allowed_null": false
4352
4369
  },
4353
4370
  {
4354
4371
  "disabled": false,
4355
4372
  "document": "是否为同一人判断,固定阈值分数为60分,若想更灵活地调整阈值可取Score参数返回进行判断",
4356
- "example": "1",
4373
+ "example": "true",
4357
4374
  "member": "bool",
4358
4375
  "name": "IsMatch",
4359
- "required": true,
4376
+ "output_required": true,
4360
4377
  "type": "bool",
4361
4378
  "value_allowed_null": false
4362
4379
  },
@@ -4366,7 +4383,7 @@
4366
4383
  "example": "3.0",
4367
4384
  "member": "string",
4368
4385
  "name": "FaceModelVersion",
4369
- "required": true,
4386
+ "output_required": true,
4370
4387
  "type": "string",
4371
4388
  "value_allowed_null": false
4372
4389
  },
@@ -4385,7 +4402,7 @@
4385
4402
  {
4386
4403
  "disabled": false,
4387
4404
  "document": "待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。",
4388
- "example": "",
4405
+ "example": "2001",
4389
4406
  "member": "string",
4390
4407
  "name": "PersonId",
4391
4408
  "required": true,
@@ -4394,7 +4411,7 @@
4394
4411
  {
4395
4412
  "disabled": false,
4396
4413
  "document": "图片 base64 数据。\n若图片中包含多张人脸,只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。",
4397
- "example": "",
4414
+ "example": "/9j/4AAQSkZJRg.....s97n//2Q==",
4398
4415
  "member": "string",
4399
4416
  "name": "Image",
4400
4417
  "required": false,
@@ -4403,7 +4420,7 @@
4403
4420
  {
4404
4421
  "disabled": false,
4405
4422
  "document": "图片的 Url 。 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。 \n图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。 \n非腾讯云存储的Url速度和稳定性可能受一定影响。\n若图片中包含多张人脸,只选取其中人脸面积最大的人脸。\n支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。",
4406
- "example": "",
4423
+ "example": "http://test.image.myqcloud.com/testA.jpg",
4407
4424
  "member": "string",
4408
4425
  "name": "Url",
4409
4426
  "required": false,
@@ -4412,7 +4429,7 @@
4412
4429
  {
4413
4430
  "disabled": false,
4414
4431
  "document": "图片质量控制。 \n0: 不进行控制; \n1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况; \n2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况; \n3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况; \n4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题; \n默认 0。 \n若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。",
4415
- "example": "",
4432
+ "example": "0",
4416
4433
  "member": "uint64",
4417
4434
  "name": "QualityControl",
4418
4435
  "required": false,
@@ -4421,7 +4438,7 @@
4421
4438
  {
4422
4439
  "disabled": false,
4423
4440
  "document": "是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。",
4424
- "example": "",
4441
+ "example": "0",
4425
4442
  "member": "uint64",
4426
4443
  "name": "NeedRotateDetection",
4427
4444
  "required": false,
@@ -4436,27 +4453,30 @@
4436
4453
  {
4437
4454
  "disabled": false,
4438
4455
  "document": "给定的人脸照片与 PersonId 对应的相似度。若 PersonId 下有多张人脸(Face),会融合多张人脸信息进行验证。",
4439
- "example": "",
4456
+ "example": "100.0",
4440
4457
  "member": "float",
4441
4458
  "name": "Score",
4459
+ "output_required": true,
4442
4460
  "type": "float",
4443
4461
  "value_allowed_null": false
4444
4462
  },
4445
4463
  {
4446
4464
  "disabled": false,
4447
4465
  "document": "是否为同一人的判断。",
4448
- "example": "",
4466
+ "example": "false",
4449
4467
  "member": "bool",
4450
4468
  "name": "IsMatch",
4469
+ "output_required": true,
4451
4470
  "type": "bool",
4452
4471
  "value_allowed_null": false
4453
4472
  },
4454
4473
  {
4455
4474
  "disabled": false,
4456
4475
  "document": "人脸识别所用的算法模型版本。",
4457
- "example": "",
4476
+ "example": "\"3.0\"",
4458
4477
  "member": "string",
4459
4478
  "name": "FaceModelVersion",
4479
+ "output_required": true,
4460
4480
  "type": "string",
4461
4481
  "value_allowed_null": false
4462
4482
  },