tencentcloud-sdk-nodejs 4.0.972 → 4.0.974

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.
Files changed (181) hide show
  1. package/CHANGELOG.md +1155 -0
  2. package/SERVICE_CHANGELOG.md +1431 -35
  3. package/package.json +1 -1
  4. package/products.md +62 -62
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/apm/v20210622/apm_models.ts +36 -0
  7. package/src/services/as/v20180419/as_client.ts +0 -1
  8. package/src/services/as/v20180419/as_models.ts +25 -6
  9. package/src/services/asr/v20190614/asr_models.ts +1 -1
  10. package/src/services/batch/v20170312/batch_models.ts +10 -1
  11. package/src/services/bda/v20200324/bda_client.ts +2 -3
  12. package/src/services/bda/v20200324/bda_models.ts +7 -7
  13. package/src/services/cat/v20180409/cat_models.ts +4 -0
  14. package/src/services/cbs/v20170312/cbs_models.ts +126 -99
  15. package/src/services/ccc/v20200210/ccc_models.ts +28 -0
  16. package/src/services/cdb/v20170320/cdb_client.ts +2 -2
  17. package/src/services/cdb/v20170320/cdb_models.ts +5 -3
  18. package/src/services/cdc/v20201214/cdc_models.ts +78 -104
  19. package/src/services/cdz/v20221123/cdz_client.ts +1 -0
  20. package/src/services/cdz/v20221123/cdz_models.ts +21 -0
  21. package/src/services/ckafka/v20190819/ckafka_models.ts +38 -26
  22. package/src/services/clb/v20180317/clb_client.ts +1 -1
  23. package/src/services/clb/v20180317/clb_models.ts +25 -15
  24. package/src/services/cloudstudio/v20230508/cloudstudio_models.ts +11 -20
  25. package/src/services/cls/v20201016/cls_client.ts +1 -1
  26. package/src/services/cls/v20201016/cls_models.ts +27 -1
  27. package/src/services/cvm/v20170312/cvm_models.ts +52 -24
  28. package/src/services/cwp/v20180228/cwp_client.ts +2 -17
  29. package/src/services/cwp/v20180228/cwp_models.ts +48 -103
  30. package/src/services/dasb/v20191018/dasb_models.ts +40 -0
  31. package/src/services/emr/v20190103/emr_client.ts +14 -12
  32. package/src/services/emr/v20190103/emr_models.ts +164 -76
  33. package/src/services/es/v20180416/es_models.ts +8 -0
  34. package/src/services/ess/v20201111/ess_client.ts +22 -30
  35. package/src/services/ess/v20201111/ess_models.ts +26 -7
  36. package/src/services/essbasic/v20210526/essbasic_client.ts +32 -6
  37. package/src/services/essbasic/v20210526/essbasic_models.ts +35 -14
  38. package/src/services/faceid/v20180301/faceid_models.ts +516 -294
  39. package/src/services/fmu/v20191213/fmu_client.ts +0 -1
  40. package/src/services/fmu/v20191213/fmu_models.ts +4 -4
  41. package/src/services/ft/v20200304/ft_models.ts +10 -10
  42. package/src/services/gme/v20180711/gme_models.ts +5 -1
  43. package/src/services/hai/v20230812/hai_models.ts +1 -1
  44. package/src/services/hunyuan/v20230901/hunyuan_models.ts +8 -0
  45. package/src/services/iai/v20180301/iai_models.ts +20 -13
  46. package/src/services/iai/v20200303/iai_client.ts +2 -3
  47. package/src/services/iai/v20200303/iai_models.ts +380 -273
  48. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +4 -4
  49. package/src/services/iotvideo/v20191126/iotvideo_models.ts +21 -21
  50. package/src/services/lke/v20231130/lke_models.ts +6 -6
  51. package/src/services/monitor/v20180724/monitor_models.ts +19 -14
  52. package/src/services/mrs/v20200910/mrs_models.ts +8 -4
  53. package/src/services/ms/v20180408/ms_client.ts +4 -2
  54. package/src/services/ocr/v20181119/ocr_client.ts +43 -19
  55. package/src/services/ocr/v20181119/ocr_models.ts +291 -144
  56. package/src/services/omics/v20221128/omics_client.ts +1 -0
  57. package/src/services/omics/v20221128/omics_models.ts +28 -117
  58. package/src/services/partners/v20180321/partners_models.ts +68 -113
  59. package/src/services/rce/v20201103/rce_client.ts +14 -0
  60. package/src/services/rce/v20201103/rce_models.ts +79 -0
  61. package/src/services/redis/v20180412/redis_models.ts +1 -3
  62. package/src/services/rum/v20210622/rum_models.ts +4 -0
  63. package/src/services/scf/v20180416/scf_models.ts +14 -14
  64. package/src/services/ssl/v20191205/ssl_models.ts +3 -3
  65. package/src/services/tdmq/v20200217/tdmq_models.ts +13 -5
  66. package/src/services/tds/v20220801/tds_models.ts +4 -4
  67. package/src/services/thpc/v20230321/thpc_models.ts +1 -1
  68. package/src/services/tke/v20180525/tke_models.ts +1 -2
  69. package/src/services/tmt/v20180321/tmt_models.ts +20 -3
  70. package/src/services/trro/v20220325/trro_models.ts +22 -37
  71. package/src/services/trtc/v20190722/trtc_client.ts +1 -0
  72. package/src/services/trtc/v20190722/trtc_models.ts +29 -1
  73. package/src/services/vclm/v20240523/vclm_client.ts +52 -52
  74. package/src/services/vclm/v20240523/vclm_models.ts +61 -41
  75. package/src/services/vod/v20180717/vod_client.ts +2 -1
  76. package/src/services/vod/v20180717/vod_models.ts +33 -1
  77. package/src/services/vod/v20240718/vod_models.ts +8 -8
  78. package/src/services/vpc/v20170312/vpc_client.ts +9 -5
  79. package/src/services/vpc/v20170312/vpc_models.ts +108 -70
  80. package/src/services/waf/v20180125/waf_client.ts +45 -7
  81. package/src/services/waf/v20180125/waf_models.ts +195 -26
  82. package/src/services/wav/v20210129/wav_models.ts +38 -38
  83. package/src/services/wedata/v20210820/wedata_models.ts +2 -2
  84. package/tencentcloud/common/sdk_version.d.ts +1 -1
  85. package/tencentcloud/common/sdk_version.js +1 -1
  86. package/tencentcloud/services/apm/v20210622/apm_models.d.ts +36 -0
  87. package/tencentcloud/services/as/v20180419/as_client.d.ts +0 -1
  88. package/tencentcloud/services/as/v20180419/as_client.js +0 -1
  89. package/tencentcloud/services/as/v20180419/as_models.d.ts +25 -6
  90. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +1 -1
  91. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +10 -1
  92. package/tencentcloud/services/bda/v20200324/bda_client.d.ts +0 -1
  93. package/tencentcloud/services/bda/v20200324/bda_client.js +0 -1
  94. package/tencentcloud/services/bda/v20200324/bda_models.d.ts +7 -7
  95. package/tencentcloud/services/cat/v20180409/cat_models.d.ts +4 -0
  96. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +126 -99
  97. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +28 -0
  98. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +2 -2
  99. package/tencentcloud/services/cdb/v20170320/cdb_client.js +2 -2
  100. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +5 -3
  101. package/tencentcloud/services/cdc/v20201214/cdc_models.d.ts +78 -104
  102. package/tencentcloud/services/cdz/v20221123/cdz_models.d.ts +20 -0
  103. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +38 -26
  104. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +1 -1
  105. package/tencentcloud/services/clb/v20180317/clb_client.js +1 -1
  106. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +25 -15
  107. package/tencentcloud/services/cloudstudio/v20230508/cloudstudio_models.d.ts +11 -20
  108. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +1 -1
  109. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +27 -1
  110. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +52 -24
  111. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +1 -7
  112. package/tencentcloud/services/cwp/v20180228/cwp_client.js +0 -8
  113. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +48 -100
  114. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +40 -0
  115. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +10 -10
  116. package/tencentcloud/services/emr/v20190103/emr_client.js +9 -9
  117. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +162 -76
  118. package/tencentcloud/services/es/v20180416/es_models.d.ts +8 -0
  119. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +22 -30
  120. package/tencentcloud/services/ess/v20201111/ess_client.js +22 -30
  121. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +26 -7
  122. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +32 -6
  123. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +32 -6
  124. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +35 -14
  125. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +516 -294
  126. package/tencentcloud/services/fmu/v20191213/fmu_client.d.ts +0 -1
  127. package/tencentcloud/services/fmu/v20191213/fmu_client.js +0 -1
  128. package/tencentcloud/services/fmu/v20191213/fmu_models.d.ts +4 -4
  129. package/tencentcloud/services/ft/v20200304/ft_models.d.ts +10 -10
  130. package/tencentcloud/services/gme/v20180711/gme_models.d.ts +5 -1
  131. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +1 -1
  132. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +8 -0
  133. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +20 -13
  134. package/tencentcloud/services/iai/v20200303/iai_client.d.ts +0 -1
  135. package/tencentcloud/services/iai/v20200303/iai_client.js +0 -1
  136. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +380 -273
  137. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +4 -4
  138. package/tencentcloud/services/iotvideo/v20191126/iotvideo_models.d.ts +21 -21
  139. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +6 -6
  140. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +19 -14
  141. package/tencentcloud/services/mrs/v20200910/mrs_models.d.ts +8 -4
  142. package/tencentcloud/services/ms/v20180408/ms_client.d.ts +3 -1
  143. package/tencentcloud/services/ms/v20180408/ms_client.js +3 -1
  144. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +16 -8
  145. package/tencentcloud/services/ocr/v20181119/ocr_client.js +21 -9
  146. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +287 -144
  147. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +26 -116
  148. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +68 -113
  149. package/tencentcloud/services/rce/v20201103/rce_client.d.ts +5 -1
  150. package/tencentcloud/services/rce/v20201103/rce_client.js +6 -0
  151. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +75 -0
  152. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +1 -3
  153. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +4 -0
  154. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +14 -14
  155. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +3 -3
  156. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +13 -5
  157. package/tencentcloud/services/tds/v20220801/tds_models.d.ts +4 -4
  158. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +1 -1
  159. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +1 -2
  160. package/tencentcloud/services/tmt/v20180321/tmt_models.d.ts +20 -3
  161. package/tencentcloud/services/trro/v20220325/trro_models.d.ts +22 -37
  162. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +28 -1
  163. package/tencentcloud/services/vclm/v20240523/vclm_client.d.ts +52 -52
  164. package/tencentcloud/services/vclm/v20240523/vclm_client.js +52 -52
  165. package/tencentcloud/services/vclm/v20240523/vclm_models.d.ts +61 -41
  166. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -1
  167. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -1
  168. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +32 -1
  169. package/tencentcloud/services/vod/v20240718/vod_models.d.ts +8 -8
  170. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +7 -3
  171. package/tencentcloud/services/vpc/v20170312/vpc_client.js +7 -3
  172. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +108 -70
  173. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +15 -3
  174. package/tencentcloud/services/waf/v20180125/waf_client.js +21 -3
  175. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +187 -26
  176. package/tencentcloud/services/wav/v20210129/wav_models.d.ts +38 -38
  177. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +2 -2
  178. package/test/cwp.v20180228.test.js +0 -10
  179. package/test/ocr.v20181119.test.js +24 -4
  180. package/test/rce.v20201103.test.js +10 -0
  181. package/test/waf.v20180125.test.js +32 -2
@@ -163,7 +163,7 @@ AttributeItem对应的Type为 —— 0:不戴帽子,1:红色系,2:黄
163
163
  */
164
164
  export interface CreatePersonRequest {
165
165
  /**
166
- * 待加入的人员库ID,取值为创建人员库接口中的GroupId
166
+ * 待加入的人员库ID,取值为创建人员库接口中的GroupId
167
167
  */
168
168
  GroupId: string
169
169
  /**
@@ -171,11 +171,14 @@ export interface CreatePersonRequest {
171
171
  */
172
172
  PersonName: string
173
173
  /**
174
- * 人员ID,单个腾讯云账号下不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B
174
+ * 人员ID。
175
+ - 单个腾讯云账号下不可修改,不可重复。
176
+ - 支持英文、数字、-%@#&_,长度限制64B。
175
177
  */
176
178
  PersonId: string
177
179
  /**
178
- * 0代表未填写,1代表男性,2代表女性。
180
+ * 性别。
181
+ - 取值范围:0代表未填写,1代表男性,2代表女性。
179
182
  */
180
183
  Gender?: number
181
184
  /**
@@ -183,46 +186,54 @@ export interface CreatePersonRequest {
183
186
  */
184
187
  PersonExDescriptionInfos?: Array<PersonExDescriptionInfo>
185
188
  /**
186
- * 图片 base64 数据,base64 编码后大小不可超过5M。
187
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
188
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
189
+ * 图片 base64 数据。
190
+ - base64 编码后大小不可超过5M
191
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
192
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
189
193
  */
190
194
  Image?: string
191
195
  /**
192
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
193
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
194
- Url、Image必须提供一个,如果都提供,只使用 Url
195
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
196
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
197
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
196
+ * 图片的 Url 。
197
+ - 对应图片 base64 编码后大小不可超过5M
198
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
199
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
200
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
201
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
202
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
198
203
  */
199
204
  Url?: string
200
205
  /**
201
206
  * 此参数用于控制判断 Image 或 Url 中图片包含的人脸,是否在人员库中已有疑似的同一人。
202
- 如果判断为已有相同人在人员库中,则不会创建新的人员,返回疑似同一人的人员信息。
203
- 如果判断没有,则完成创建人员。
207
+ - 如果判断为已有相同人在人员库中,则不会创建新的人员,返回疑似同一人的人员信息。
208
+ - 如果判断没有,则完成创建人员。
209
+ - 取值范围:
204
210
  0: 不进行判断,无论是否有疑似同一人在库中均完成入库;
205
211
  1:较低的同一人判断要求(百一误识别率);
206
212
  2: 一般的同一人判断要求(千一误识别率);
207
213
  3: 较高的同一人判断要求(万一误识别率);
208
214
  4: 很高的同一人判断要求(十万一误识别率)。
209
- 默认 0。
210
- 注: 要求越高,则疑似同一人的概率越小。不同要求对应的误识别率仅为参考值,您可以根据实际情况调整。
215
+ - 默认 0。
216
+ - 注: 要求越高,则疑似同一人的概率越小。不同要求对应的误识别率仅为参考值,您可以根据实际情况调整。
211
217
  */
212
218
  UniquePersonControl?: number
213
219
  /**
214
220
  * 图片质量控制。
221
+ - 取值范围:
215
222
  0: 不进行控制;
216
223
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
217
224
  2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
218
225
  3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
219
226
  4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
220
- 默认 0。
221
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
227
+ - 默认 0。
228
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
222
229
  */
223
230
  QualityControl?: number
224
231
  /**
225
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
232
+ * 是否开启图片旋转识别支持。
233
+ - 取值范围:0为不开启,1为开启。
234
+ - 默认为0。
235
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
236
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
226
237
  */
227
238
  NeedRotateDetection?: number
228
239
  }
@@ -232,23 +243,28 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
232
243
  */
233
244
  export interface CreateFaceResponse {
234
245
  /**
235
- * 加入成功的人脸数量
246
+ * 加入成功的人脸数量。
236
247
  */
237
248
  SucFaceNum?: number
238
249
  /**
239
- * 加入成功的人脸ID列表
250
+ * 加入成功的人脸ID列表。
240
251
  */
241
252
  SucFaceIds?: Array<string>
242
253
  /**
243
- * 每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,-1109 代表图片尺寸过大或者过小,
244
- -1601代表不符合图片质量控制要求, -1604 代表人脸相似度没有超过FaceMatchThreshold。
245
- 其他非 0 值代表算法服务异常。
246
- RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
254
+ * 每张人脸图片添加结果。
255
+ - 其他非 0 值代表算法服务异常,取值范围:
256
+ -1101 代表未检测到人脸。
257
+ -1102 代表图片解码失败。
258
+ -1109 代表图片尺寸过大或者过小。
259
+ -1601代表不符合图片质量控制要求。
260
+ -1604 代表人脸相似度没有超过FaceMatchThreshold。
261
+ - RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
247
262
  */
248
263
  RetCode?: Array<number | bigint>
249
264
  /**
250
- * 加入成功的人脸索引。索引顺序和入参中 Images 或 Urls 的顺序一致。
251
- 例如, Urls 3 url,第二个 url 失败,则 SucIndexes 值为 [0,2] 。
265
+ * 加入成功的人脸索引。
266
+ - 索引顺序和入参中 Images Urls 的顺序一致。
267
+ - 例如, Urls 中 有 3 个 url,第二个 url 失败,则 SucIndexes 值为 [0,2] 。
252
268
  */
253
269
  SucIndexes?: Array<number | bigint>
254
270
  /**
@@ -291,46 +307,54 @@ export interface FaceHairAttributesInfo {
291
307
  */
292
308
  export interface CreateFaceRequest {
293
309
  /**
294
- * 人员ID,取值为创建人员接口中的PersonId
310
+ * 人员ID,取值为创建人员接口中的PersonId
295
311
  */
296
312
  PersonId: string
297
313
  /**
298
- * 图片 base64 数据,base64 编码后大小不可超过5M。
299
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
300
- 人员人脸总数量不可超过5张。
301
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
302
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
314
+ * 图片 base64 数据。
315
+ - base64 编码后大小不可超过5M
316
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
317
+ - 人员人脸总数量不可超过5张。
318
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
319
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
303
320
  */
304
321
  Images?: Array<string>
305
322
  /**
306
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
307
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
308
- Url、Image必须提供一个,如果都提供,只使用 Url
309
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
310
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
311
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
312
- 人员人脸总数量不可超过5张。
313
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
323
+ * 图片的 Url 。
324
+ - 对应图片 base64 编码后大小不可超过5M
325
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
326
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
327
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
328
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
329
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
330
+ - 人员人脸总数量不可超过5张。
331
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
314
332
  */
315
333
  Urls?: Array<string>
316
334
  /**
317
335
  * 只有和该人员已有的人脸相似度超过FaceMatchThreshold值的人脸,才能增加人脸成功。
318
- 默认值60分。取值范围[0,100] 。
336
+ - 默认值60分。
337
+ - 取值范围:[0,100] 。
319
338
  */
320
339
  FaceMatchThreshold?: number
321
340
  /**
322
341
  * 图片质量控制。
342
+ - 取值范围:
323
343
  0: 不进行控制;
324
344
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
325
345
  2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
326
346
  3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
327
347
  4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
328
- 默认 0。
329
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
348
+ - 默认 0。
349
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
330
350
  */
331
351
  QualityControl?: number
332
352
  /**
333
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
353
+ * 是否开启图片旋转识别支持。
354
+ - 取值范围:0为不开启,1为开启。
355
+ - 默认为0。
356
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
357
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
334
358
  */
335
359
  NeedRotateDetection?: number
336
360
  }
@@ -349,12 +373,10 @@ export interface CreateGroupRequest {
349
373
  GroupId: string
350
374
  /**
351
375
  * 人员库自定义描述字段,用于描述人员库中人员属性,该人员库下所有人员将拥有此描述字段。
352
- 最多可以创建5个。
353
- 每个自定义描述字段支持[1,30]个字符。
354
- 在同一人员库中自定义描述字段不可重复。
355
- 例: 设置某人员库“自定义描述字段”为["学号","工号","手机号"],
356
- 则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段,
357
- 可在对应人员描述字段中填写内容,登记该人员的学号、工号、手机号等信息。
376
+ - 最多可以创建5个。
377
+ - 每个自定义描述字段支持[1,30]个字符。
378
+ - 在同一人员库中自定义描述字段不可重复。
379
+ - 例: 设置某人员库“自定义描述字段”为["学号","工号","手机号"], 则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段, 可在对应人员描述字段中填写内容,登记该人员的学号、工号、手机号等信息。
358
380
  */
359
381
  GroupExDescriptions?: Array<string>
360
382
  /**
@@ -363,10 +385,10 @@ export interface CreateGroupRequest {
363
385
  Tag?: string
364
386
  /**
365
387
  * 人脸识别服务所用的算法模型版本。
366
- 目前入参支持 “2.0”和“3.0“ 两个输入。
367
- 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
368
- 2020年11月26日后开通服务的账号仅支持输入“3.0”。
369
- 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
388
+ - 目前入参支持 “2.0”和“3.0“ 两个输入。
389
+ - 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
390
+ - 2020年11月26日后开通服务的账号仅支持输入“3.0”。
391
+ - 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
370
392
  */
371
393
  FaceModelVersion?: string
372
394
  }
@@ -376,15 +398,15 @@ export interface CreateGroupRequest {
376
398
  */
377
399
  export interface GetPersonGroupInfoRequest {
378
400
  /**
379
- * 人员ID,取值为创建人员接口中的PersonId
401
+ * 人员ID,取值为创建人员接口中的PersonId
380
402
  */
381
403
  PersonId: string
382
404
  /**
383
- * 起始序号,默认值为0
405
+ * 起始序号,默认值为0
384
406
  */
385
407
  Offset?: number
386
408
  /**
387
- * 返回数量,默认值为10,最大值为100
409
+ * 返回数量,默认值为10,最大值为100
388
410
  */
389
411
  Limit?: number
390
412
  }
@@ -650,7 +672,7 @@ export interface CreatePersonResponse {
650
672
  FaceRect?: FaceRect
651
673
  /**
652
674
  * 疑似同一人的PersonId。
653
- 当 UniquePersonControl 参数不为0且人员库中有疑似的同一人,此参数才有意义。
675
+ - 当 UniquePersonControl 参数不为0且人员库中有疑似的同一人,此参数才有意义。
654
676
  */
655
677
  SimilarPersonId?: string
656
678
  /**
@@ -690,11 +712,11 @@ export interface SearchFacesResponse {
690
712
  */
691
713
  export interface CopyPersonResponse {
692
714
  /**
693
- * 成功加入的人员库数量
715
+ * 成功加入的人员库数量。
694
716
  */
695
717
  SucGroupNum?: number
696
718
  /**
697
- * 成功加入的人员库列表
719
+ * 成功加入的人员库列表。
698
720
  */
699
721
  SucGroupIds?: Array<string>
700
722
  /**
@@ -722,11 +744,11 @@ export interface GroupCandidate {
722
744
  */
723
745
  export interface DeleteFaceResponse {
724
746
  /**
725
- * 删除成功的人脸数量
747
+ * 删除成功的人脸数量.
726
748
  */
727
749
  SucDeletedNum?: number
728
750
  /**
729
- * 删除成功的人脸ID列表
751
+ * 删除成功的人脸ID列表。
730
752
  */
731
753
  SucFaceIds?: Array<string>
732
754
  /**
@@ -740,7 +762,7 @@ export interface DeleteFaceResponse {
740
762
  */
741
763
  export interface DeletePersonRequest {
742
764
  /**
743
- * 人员ID,取值为创建人员接口中的PersonId
765
+ * 人员ID,取值为创建人员接口中的PersonId
744
766
  */
745
767
  PersonId: string
746
768
  }
@@ -774,11 +796,11 @@ export interface DetectLiveFaceResponse {
774
796
  */
775
797
  export interface DeleteFaceRequest {
776
798
  /**
777
- * 人员ID,取值为创建人员接口中的PersonId
799
+ * 人员ID,取值为创建人员接口中的PersonId
778
800
  */
779
801
  PersonId: string
780
802
  /**
781
- * 待删除的人脸ID列表,数组元素取值为增加人脸接口返回的FaceId
803
+ * 待删除的人脸ID列表,数组元素取值为增加人脸接口返回的FaceId
782
804
  */
783
805
  FaceIds: Array<string>
784
806
  }
@@ -788,19 +810,19 @@ export interface DeleteFaceRequest {
788
810
  */
789
811
  export interface ModifyGroupRequest {
790
812
  /**
791
- * 人员库ID,取值为创建人员库接口中的GroupId
813
+ * 人员库ID,取值为创建人员库接口中的GroupId
792
814
  */
793
815
  GroupId: string
794
816
  /**
795
- * 人员库名称
817
+ * 人员库名称。
796
818
  */
797
819
  GroupName?: string
798
820
  /**
799
- * 需要修改的人员库自定义描述字段,key-value
821
+ * 需要修改的人员库自定义描述字段,key-value
800
822
  */
801
823
  GroupExDescriptionInfos?: Array<GroupExDescriptionInfo>
802
824
  /**
803
- * 人员库信息备注
825
+ * 人员库信息备注。
804
826
  */
805
827
  Tag?: string
806
828
  }
@@ -810,7 +832,7 @@ export interface ModifyGroupRequest {
810
832
  */
811
833
  export interface DeleteGroupRequest {
812
834
  /**
813
- * 人员库ID,取值为创建人员库接口中的GroupId
835
+ * 人员库ID,取值为创建人员库接口中的GroupId
814
836
  */
815
837
  GroupId: string
816
838
  }
@@ -868,15 +890,16 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
868
890
  */
869
891
  export interface GetPersonBaseInfoResponse {
870
892
  /**
871
- * 人员名称
893
+ * 人员名称。
872
894
  */
873
895
  PersonName?: string
874
896
  /**
875
- * 人员性别,0代表未填写,1代表男性,2代表女性
897
+ * 人员性别。
898
+ - 取值范围:0代表未填写,1代表男性,2代表女性。
876
899
  */
877
900
  Gender?: number
878
901
  /**
879
- * 包含的人脸 ID 列表
902
+ * 包含的人脸 ID 列表。
880
903
  */
881
904
  FaceIds?: Array<string>
882
905
  /**
@@ -1018,11 +1041,11 @@ export interface SearchFacesReturnsByGroupResponse {
1018
1041
  */
1019
1042
  export interface CopyPersonRequest {
1020
1043
  /**
1021
- * 人员ID,取值为创建人员接口中的PersonId
1044
+ * 人员ID,取值为创建人员接口中的PersonId
1022
1045
  */
1023
1046
  PersonId: string
1024
1047
  /**
1025
- * 待加入的人员库列表,数组元素取值为创建人员库接口中的GroupId
1048
+ * 待加入的人员库列表,数组元素取值为创建人员库接口中的GroupId
1026
1049
  */
1027
1050
  GroupIds: Array<string>
1028
1051
  }
@@ -1032,48 +1055,58 @@ export interface CopyPersonRequest {
1032
1055
  */
1033
1056
  export interface SearchPersonsReturnsByGroupRequest {
1034
1057
  /**
1035
- * 希望搜索的人员库列表,上限60个。数组元素取值为创建人员库接口中的GroupId
1058
+ * 希望搜索的人员库列表,上限60个。数组元素取值为创建人员库接口中的GroupId
1036
1059
  */
1037
1060
  GroupIds: Array<string>
1038
1061
  /**
1039
- * 图片 base64 数据,base64 编码后大小不可超过5M。
1040
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
1041
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1062
+ * 图片 base64 数据。
1063
+ - base64 编码后大小不可超过5M
1064
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
1065
+ - 所有格式的图片短边像素不小于64。
1066
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1042
1067
  */
1043
1068
  Image?: string
1044
1069
  /**
1045
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
1046
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
1047
- Url、Image必须提供一个,如果都提供,只使用 Url
1048
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1049
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
1050
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1070
+ * 图片的 Url 。
1071
+ - 对应图片 base64 编码后大小不可超过5M
1072
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1073
+ - 所有格式的图片短边像素不小于64。
1074
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
1075
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1076
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
1077
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1051
1078
  */
1052
1079
  Url?: string
1053
1080
  /**
1054
- * 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1055
- MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1056
- 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1081
+ * 最多识别的人脸数目。
1082
+ - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1083
+ - MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1084
+ - 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1057
1085
  */
1058
1086
  MaxFaceNum?: number
1059
1087
  /**
1060
- * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
1088
+ * 人脸长和宽的最小尺寸,单位为像素。
1089
+ - 默认为34。
1090
+ - 低于34将影响搜索精度。
1091
+ - 建议设置为80。
1061
1092
  */
1062
1093
  MinFaceSize?: number
1063
1094
  /**
1064
- * 被检测到的人脸,对应最多返回的最相似人员数目。默认值为5,最大值为10。
1065
- 例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
1095
+ * 被检测到的人脸,对应最多返回的最相似人员数目。
1096
+ - 默认值为5,最大值为10。
1097
+ - 例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
1066
1098
  */
1067
1099
  MaxPersonNumPerGroup?: number
1068
1100
  /**
1069
1101
  * 图片质量控制。
1070
- 0: 不进行控制;
1071
- 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
1072
- 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
1073
- 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
1074
- 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
1075
- 默认 0。
1076
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1102
+ - 取值范围:
1103
+ 0: 不进行控制。
1104
+ 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
1105
+ 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
1106
+ 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
1107
+ 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
1108
+ - 默认 0。
1109
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1077
1110
  */
1078
1111
  QualityControl?: number
1079
1112
  /**
@@ -1081,11 +1114,18 @@ MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要
1081
1114
  */
1082
1115
  FaceMatchThreshold?: number
1083
1116
  /**
1084
- * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1117
+ * 是否返回人员具体信息。
1118
+ - 取值范围:0 为关闭,1 为开启。
1119
+ - 默认为 0。
1120
+ - 其他非0非1值默认为0。
1085
1121
  */
1086
1122
  NeedPersonInfo?: number
1087
1123
  /**
1088
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1124
+ * 是否开启图片旋转识别支持。
1125
+ - 取值范围:0为不开启,1为开启。
1126
+ - 默认为0。
1127
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
1128
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1089
1129
  */
1090
1130
  NeedRotateDetection?: number
1091
1131
  }
@@ -1217,11 +1257,11 @@ export interface Point {
1217
1257
  */
1218
1258
  export interface GetPersonListNumResponse {
1219
1259
  /**
1220
- * 人员数量
1260
+ * 人员数量。
1221
1261
  */
1222
1262
  PersonNum?: number
1223
1263
  /**
1224
- * 人脸数量
1264
+ * 人脸数量。
1225
1265
  */
1226
1266
  FaceNum?: number
1227
1267
  /**
@@ -1235,11 +1275,11 @@ export interface GetPersonListNumResponse {
1235
1275
  */
1236
1276
  export interface DeletePersonFromGroupRequest {
1237
1277
  /**
1238
- * 人员ID,取值为创建人员接口中的PersonId
1278
+ * 人员ID,取值为创建人员接口中的PersonId
1239
1279
  */
1240
1280
  PersonId: string
1241
1281
  /**
1242
- * 人员库ID,取值为创建人员库接口中的GroupId
1282
+ * 人员库ID,取值为创建人员库接口中的GroupId
1243
1283
  */
1244
1284
  GroupId: string
1245
1285
  }
@@ -1300,16 +1340,16 @@ export interface VerifyFaceRequest {
1300
1340
  */
1301
1341
  export interface GetPersonListResponse {
1302
1342
  /**
1303
- * 返回的人员信息
1343
+ * 返回的人员信息。
1304
1344
  */
1305
1345
  PersonInfos?: Array<PersonInfo>
1306
1346
  /**
1307
- * 该人员库的人员数量
1347
+ * 该人员库的人员数量。
1308
1348
  注意:此字段可能返回 null,表示取不到有效值。
1309
1349
  */
1310
1350
  PersonNum?: number
1311
1351
  /**
1312
- * 该人员库的人脸数量
1352
+ * 该人员库的人脸数量。
1313
1353
  注意:此字段可能返回 null,表示取不到有效值。
1314
1354
  */
1315
1355
  FaceNum?: number
@@ -1370,11 +1410,11 @@ export interface Result {
1370
1410
  */
1371
1411
  export interface GetPersonGroupInfoResponse {
1372
1412
  /**
1373
- * 包含此人员的人员库及描述字段内容列表
1413
+ * 包含此人员的人员库及描述字段内容列表。
1374
1414
  */
1375
1415
  PersonGroupInfos?: Array<PersonGroupInfo>
1376
1416
  /**
1377
- * 人员库总数量
1417
+ * 人员库总数量。
1378
1418
  注意:此字段可能返回 null,表示取不到有效值。
1379
1419
  */
1380
1420
  GroupNum?: number
@@ -1408,63 +1448,81 @@ export interface UpgradeGroupFaceModelVersionResponse {
1408
1448
  */
1409
1449
  export interface SearchFacesReturnsByGroupRequest {
1410
1450
  /**
1411
- * 希望搜索的人员库列表,上限60个。数组元素取值为创建人员库接口中的GroupId。
1412
- 不可同时搜索不同算法模型版本(FaceModelVersion)的人员库。
1451
+ * 希望搜索的人员库列表,上限60个。
1452
+ - 数组元素取值为创建人员库接口中的GroupId。
1453
+ - 不可同时搜索不同算法模型版本(FaceModelVersion)的人员库。
1413
1454
  */
1414
1455
  GroupIds: Array<string>
1415
1456
  /**
1416
- * 图片 base64 数据,base64 编码后大小不可超过5M。
1417
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
1418
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1457
+ * 图片 base64 数据。
1458
+ - base64 编码后大小不可超过5M
1459
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
1460
+ - 所有格式的图片短边像素不小于64。
1461
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1419
1462
  */
1420
1463
  Image?: string
1421
1464
  /**
1422
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
1423
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
1424
- Url、Image必须提供一个,如果都提供,只使用 Url
1425
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1426
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
1427
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1465
+ * 图片的 Url 。
1466
+ - 对应图片 base64 编码后大小不可超过5M
1467
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1468
+ - 所有格式的图片短边像素不小于64。
1469
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
1470
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1471
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
1472
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1428
1473
  */
1429
1474
  Url?: string
1430
1475
  /**
1431
- * 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1432
- MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1433
- 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1476
+ * 最多识别的人脸数目。
1477
+ - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1478
+ - MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1479
+ - 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1434
1480
  */
1435
1481
  MaxFaceNum?: number
1436
1482
  /**
1437
- * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
1483
+ * 人脸长和宽的最小尺寸,单位为像素。
1484
+ - 默认为34。
1485
+ - 低于34将影响搜索精度。
1486
+ - 建议设置为80。
1438
1487
  */
1439
1488
  MinFaceSize?: number
1440
1489
  /**
1441
- * 被检测到的人脸,对应最多返回的最相似人员数目。默认值为5,最大值为10。
1442
- 例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
1490
+ * 被检测到的人脸,对应最多返回的最相似人员数目。
1491
+ - 默认值为5,最大值为10。
1492
+ - 例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
1443
1493
  */
1444
1494
  MaxPersonNumPerGroup?: number
1445
1495
  /**
1446
- * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1496
+ * 是否返回人员具体信息。
1497
+ - 取值范围:0 为关闭,1 为开启。
1498
+ - 默认为 0。
1499
+ - 其他非0非1值默认为0
1447
1500
  */
1448
1501
  NeedPersonInfo?: number
1449
1502
  /**
1450
1503
  * 图片质量控制。
1451
- 0: 不进行控制;
1452
- 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
1453
- 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
1454
- 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
1455
- 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
1456
- 默认 0。
1457
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1504
+ - 取值范围:
1505
+ 0: 不进行控制。
1506
+ 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
1507
+ 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
1508
+ 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
1509
+ 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
1510
+ - 默认 0。
1511
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1458
1512
  */
1459
1513
  QualityControl?: number
1460
1514
  /**
1461
1515
  * 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。
1462
- 默认为0。
1463
- 取值范围[0.0,100.0) 。
1516
+ - 默认为0。
1517
+ - 取值范围:[0.0,100.0) 。
1464
1518
  */
1465
1519
  FaceMatchThreshold?: number
1466
1520
  /**
1467
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1521
+ * 是否开启图片旋转识别支持。
1522
+ - 取值范围:0为不开启,1为开启。
1523
+ - 默认为0。
1524
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
1525
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1468
1526
  */
1469
1527
  NeedRotateDetection?: number
1470
1528
  }
@@ -1510,15 +1568,15 @@ export interface ModifyPersonBaseInfoResponse {
1510
1568
  */
1511
1569
  export interface ModifyPersonGroupInfoRequest {
1512
1570
  /**
1513
- * 人员库ID,取值为创建人员库接口中的GroupId
1571
+ * 人员库ID,取值为创建人员库接口中的GroupId
1514
1572
  */
1515
1573
  GroupId: string
1516
1574
  /**
1517
- * 人员ID,取值为创建人员接口中的PersonId
1575
+ * 人员ID,取值为创建人员接口中的PersonId
1518
1576
  */
1519
1577
  PersonId: string
1520
1578
  /**
1521
- * 需要修改的人员描述字段内容,key-value
1579
+ * 需要修改的人员描述字段内容,key-value
1522
1580
  */
1523
1581
  PersonExDescriptionInfos: Array<PersonExDescriptionInfo>
1524
1582
  }
@@ -1722,10 +1780,10 @@ export interface VerifyPersonRequest {
1722
1780
  export interface CompareMaskFaceResponse {
1723
1781
  /**
1724
1782
  * 两张图片中人脸的相似度分数。
1725
- 不同算法版本返回的相似度分数不同。
1726
- 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
1727
- 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
1728
- 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
1783
+ - 不同算法版本返回的相似度分数不同。
1784
+ - 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
1785
+ - 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
1786
+ - 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
1729
1787
  */
1730
1788
  Score?: number
1731
1789
  /**
@@ -1743,15 +1801,15 @@ export interface CompareMaskFaceResponse {
1743
1801
  */
1744
1802
  export interface ModifyPersonBaseInfoRequest {
1745
1803
  /**
1746
- * 人员ID,取值为创建人员接口中的PersonId
1804
+ * 人员ID,取值为创建人员接口中的PersonId
1747
1805
  */
1748
1806
  PersonId: string
1749
1807
  /**
1750
- * 需要修改的人员名称
1808
+ * 需要修改的人员名称。
1751
1809
  */
1752
1810
  PersonName?: string
1753
1811
  /**
1754
- * 需要修改的人员性别,1代表男性,2代表女性
1812
+ * 需要修改的人员性别,1代表男性,2代表女性。
1755
1813
  */
1756
1814
  Gender?: number
1757
1815
  }
@@ -1834,54 +1892,69 @@ export interface FaceDetailInfo {
1834
1892
  */
1835
1893
  export interface SearchFacesRequest {
1836
1894
  /**
1837
- * 希望搜索的人员库列表,上限100个。数组元素取值为创建人员库接口中的GroupId。
1838
- 不可同时搜索不同算法模型版本(FaceModelVersion)的人员库。
1895
+ * 希望搜索的人员库列表,上限100个。
1896
+ - 数组元素取值为创建人员库接口中的GroupId。
1897
+ - 不可同时搜索不同算法模型版本(FaceModelVersion)的人员库。
1839
1898
  */
1840
1899
  GroupIds: Array<string>
1841
1900
  /**
1842
- * 图片 base64 数据,base64 编码后大小不可超过5M。
1843
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
1844
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1901
+ * 图片 base64 数据。
1902
+ - base64 编码后大小不可超过5M
1903
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
1904
+ - 所有格式的图片短边像素不小于64。
1905
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1845
1906
  */
1846
1907
  Image?: string
1847
1908
  /**
1848
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
1849
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
1850
- Url、Image必须提供一个,如果都提供,只使用 Url
1851
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1852
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
1853
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1909
+ * 图片的 Url 。
1910
+ - 对应图片 base64 编码后大小不可超过5M
1911
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1912
+ - 所有格式的图片短边像素不小于64。
1913
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
1914
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1915
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
1916
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1854
1917
  */
1855
1918
  Url?: string
1856
1919
  /**
1857
- * 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1858
- MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1859
- 例如:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1920
+ * 最多识别的人脸数目。
1921
+ - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1922
+ - MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1923
+ - 例如:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1860
1924
  */
1861
1925
  MaxFaceNum?: number
1862
1926
  /**
1863
- * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
1927
+ * 人脸长和宽的最小尺寸,单位为像素。
1928
+ - 默认为34。
1929
+ - 低于34的人脸图片无法被识别。
1930
+ - 建议设置为80。
1864
1931
  */
1865
1932
  MinFaceSize?: number
1866
1933
  /**
1867
- * 单张被识别的人脸返回的最相似人员数量。默认值为5,最大值为100。
1868
- 例如,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
1869
- 值越大,需要处理的时间越长。建议不要超过10。
1934
+ * 单张被识别的人脸返回的最相似人员数量。
1935
+ - 默认值为5,最大值为100。
1936
+ - 例如,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
1937
+ - 值越大,需要处理的时间越长。
1938
+ - 建议不要超过10。
1870
1939
  */
1871
1940
  MaxPersonNum?: number
1872
1941
  /**
1873
- * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1942
+ * 是否返回人员具体信息。
1943
+ - 取值范围:0 为关闭,1 为开启。
1944
+ - 默认为 0。
1945
+ - 其他非0非1值默认为0。
1874
1946
  */
1875
1947
  NeedPersonInfo?: number
1876
1948
  /**
1877
1949
  * 图片质量控制。
1878
- 0: 不进行控制;
1879
- 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
1880
- 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
1881
- 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
1882
- 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
1883
- 默认 0。
1884
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1950
+ - 取值范围:
1951
+ 0: 不进行控制。
1952
+ 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
1953
+ 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
1954
+ 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
1955
+ 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
1956
+ - 默认 0。
1957
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1885
1958
  */
1886
1959
  QualityControl?: number
1887
1960
  /**
@@ -1889,7 +1962,11 @@ MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要
1889
1962
  */
1890
1963
  FaceMatchThreshold?: number
1891
1964
  /**
1892
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1965
+ * 是否开启图片旋转识别支持。
1966
+ - 取值范围:0为不开启,1为开启。
1967
+ - 默认为0。
1968
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
1969
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1893
1970
  */
1894
1971
  NeedRotateDetection?: number
1895
1972
  }
@@ -1899,62 +1976,81 @@ MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要
1899
1976
  */
1900
1977
  export interface SearchPersonsRequest {
1901
1978
  /**
1902
- * 希望搜索的人员库列表,上限100个。数组元素取值为创建人员库接口中的GroupId
1979
+ * 希望搜索的人员库列表,上限100个。数组元素取值为创建人员库接口中的GroupId
1903
1980
  */
1904
1981
  GroupIds: Array<string>
1905
1982
  /**
1906
- * 图片 base64 数据,base64 编码后大小不可超过5M。
1907
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
1908
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1909
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1983
+ * 图片 base64 数据。
1984
+ - base64 编码后大小不可超过5M
1985
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
1986
+ - 所有格式的图片短边像素不小于64。
1987
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1988
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1910
1989
  */
1911
1990
  Image?: string
1912
1991
  /**
1913
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
1914
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
1915
- Url、Image必须提供一个,如果都提供,只使用 Url
1916
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1917
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
1918
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1992
+ * 图片的 Url 。
1993
+ - 对应图片 base64 编码后大小不可超过5M
1994
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1995
+ - 所有格式的图片短边像素不小于64。
1996
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
1997
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1998
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
1999
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1919
2000
  */
1920
2001
  Url?: string
1921
2002
  /**
1922
- * 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1923
- MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1924
- 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
2003
+ * 最多识别的人脸数目。
2004
+ - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
2005
+ - MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
2006
+ - 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1925
2007
  */
1926
2008
  MaxFaceNum?: number
1927
2009
  /**
1928
- * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
2010
+ * 人脸长和宽的最小尺寸,单位为像素。
2011
+ - 默认为34。
2012
+ - 低于34将影响搜索精度。
2013
+ - 建议设置为80。
1929
2014
  */
1930
2015
  MinFaceSize?: number
1931
2016
  /**
1932
- * 单张被识别的人脸返回的最相似人员数量。默认值为5,最大值为100。
1933
- 例,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
1934
- 值越大,需要处理的时间越长。建议不要超过10。
2017
+ * 单张被识别的人脸返回的最相似人员数量。
2018
+ - 默认值为5,最大值为100。
2019
+ - 例,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
2020
+ - 值越大,需要处理的时间越长。建议不要超过10。
1935
2021
  */
1936
2022
  MaxPersonNum?: number
1937
2023
  /**
1938
2024
  * 图片质量控制。
1939
- 0: 不进行控制;
1940
- 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
1941
- 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
1942
- 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
1943
- 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
1944
- 默认 0。
1945
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
2025
+ - 取值范围:
2026
+ 0: 不进行控制。
2027
+ 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
2028
+ 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
2029
+ 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
2030
+ 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
2031
+ - 默认 0。
2032
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1946
2033
  */
1947
2034
  QualityControl?: number
1948
2035
  /**
1949
- * 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。默认为0。取值范围[0.0,100.0) 。
2036
+ * 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。
2037
+ - 默认为0。
2038
+ - 取值范围:[0.0,100.0) 。
1950
2039
  */
1951
2040
  FaceMatchThreshold?: number
1952
2041
  /**
1953
- * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
2042
+ * 是否返回人员具体信息。
2043
+ - 取值范围:0 为关闭,1 为开启。
2044
+ - 默认为 0。
2045
+ - 其他非0非1值默认为0
1954
2046
  */
1955
2047
  NeedPersonInfo?: number
1956
2048
  /**
1957
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2049
+ * 是否开启图片旋转识别支持。
2050
+ - 取值范围:0为不开启,1为开启。
2051
+ - 默认为0。
2052
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
2053
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1958
2054
  */
1959
2055
  NeedRotateDetection?: number
1960
2056
  }
@@ -2011,37 +2107,41 @@ export interface GroupExDescriptionInfo {
2011
2107
  */
2012
2108
  export interface CompareMaskFaceRequest {
2013
2109
  /**
2014
- * A 图片 base64 数据,base64 编码后大小不可超过5M。
2015
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2016
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2017
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2110
+ * A 图片 base64 数据。
2111
+ - base64 编码后大小不可超过5M
2112
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
2113
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2114
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2018
2115
  */
2019
2116
  ImageA?: string
2020
2117
  /**
2021
- * B 图片 base64 数据,base64 编码后大小不可超过5M。
2022
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2023
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2024
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2118
+ * B 图片 base64 数据。
2119
+ - base64 编码后大小不可超过5M
2120
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
2121
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2122
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2025
2123
  */
2026
2124
  ImageB?: string
2027
2125
  /**
2028
- * A 图片的 Url ,对应图片 base64 编码后大小不可超过5M
2029
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2030
- A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
2031
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2032
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
2033
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2034
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2126
+ * A 图片的 Url 。
2127
+ - 对应图片 base64 编码后大小不可超过5M
2128
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2129
+ - A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2130
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2131
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
2132
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2133
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2035
2134
  */
2036
2135
  UrlA?: string
2037
2136
  /**
2038
- * B 图片的 Url ,对应图片 base64 编码后大小不可超过5M
2039
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2040
- B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
2041
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2042
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
2043
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2044
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2137
+ * B 图片的 Url 。
2138
+ - 对应图片 base64 编码后大小不可超过5M
2139
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2140
+ - B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2141
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2142
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
2143
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2144
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2045
2145
  */
2046
2146
  UrlB?: string
2047
2147
  /**
@@ -2050,13 +2150,14 @@ B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2050
2150
  FaceModelVersion?: string
2051
2151
  /**
2052
2152
  * 图片质量控制。
2153
+ - 取值范围:
2053
2154
  0: 不进行控制;
2054
2155
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
2055
2156
  2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
2056
2157
  3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
2057
2158
  4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
2058
- 默认 0。
2059
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
2159
+ - 默认 0。
2160
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
2060
2161
  */
2061
2162
  QualityControl?: number
2062
2163
  }
@@ -2162,7 +2263,7 @@ export interface DetectFaceRequest {
2162
2263
  */
2163
2264
  export interface GetPersonBaseInfoRequest {
2164
2265
  /**
2165
- * 人员ID,创建人员接口中的PersonId
2266
+ * 人员ID,创建人员接口中的PersonId
2166
2267
  */
2167
2268
  PersonId: string
2168
2269
  }
@@ -2303,19 +2404,19 @@ export interface DetectFaceAttributesRequest {
2303
2404
  */
2304
2405
  export interface GetGroupInfoResponse {
2305
2406
  /**
2306
- * 人员库名称
2407
+ * 人员库名称。
2307
2408
  */
2308
2409
  GroupName?: string
2309
2410
  /**
2310
- * 人员库ID
2411
+ * 人员库ID
2311
2412
  */
2312
2413
  GroupId?: string
2313
2414
  /**
2314
- * 人员库自定义描述字段
2415
+ * 人员库自定义描述字段。
2315
2416
  */
2316
2417
  GroupExDescriptions?: Array<string>
2317
2418
  /**
2318
- * 人员库信息备注
2419
+ * 人员库信息备注。
2319
2420
  */
2320
2421
  Tag?: string
2321
2422
  /**
@@ -2338,10 +2439,10 @@ export interface GetGroupInfoResponse {
2338
2439
  export interface CompareFaceResponse {
2339
2440
  /**
2340
2441
  * 两张图片中人脸的相似度分数。
2341
- 不同算法版本返回的相似度分数不同。
2342
- 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
2343
- 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
2344
- 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
2442
+ - 不同算法版本返回的相似度分数不同。
2443
+ - 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
2444
+ - 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
2445
+ - 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
2345
2446
  */
2346
2447
  Score?: number
2347
2448
  /**
@@ -2432,64 +2533,70 @@ export interface FaceShape {
2432
2533
  */
2433
2534
  export interface CompareFaceRequest {
2434
2535
  /**
2435
- * A 图片 base64 数据,base64 编码后大小不可超过5M。
2436
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2437
- 若图片中包含多张人脸,只选取其中置信度最高的人脸。
2438
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2536
+ * A 图片 base64 数据。
2537
+ - base64 编码后大小不可超过5M
2538
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
2539
+ - 若图片中包含多张人脸,只选取其中置信度最高的人脸。
2540
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2439
2541
  */
2440
2542
  ImageA?: string
2441
2543
  /**
2442
- * B 图片 base64 数据,base64 编码后大小不可超过5M。
2443
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2444
- 若图片中包含多张人脸,只选取其中置信度最高的人脸。
2445
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2544
+ * B 图片 base64 数据。
2545
+ - base64 编码后大小不可超过5M
2546
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
2547
+ - 若图片中包含多张人脸,只选取其中置信度最高的人脸。
2548
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2446
2549
  */
2447
2550
  ImageB?: string
2448
2551
  /**
2449
- * A 图片的 Url ,对应图片 base64 编码后大小不可超过5M
2450
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2451
- A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
2452
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2453
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
2454
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2455
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2552
+ * A 图片的 Url。
2553
+ - 对应图片 base64 编码后大小不可超过5M
2554
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2555
+ - A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2556
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2557
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
2558
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2559
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2456
2560
  */
2457
2561
  UrlA?: string
2458
2562
  /**
2459
- * B 图片的 Url ,对应图片 base64 编码后大小不可超过5M
2460
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2461
- B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
2462
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2463
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
2464
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2465
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2563
+ * B 图片的 Url 。
2564
+ - 对应图片 base64 编码后大小不可超过5M
2565
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2566
+ - B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2567
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2568
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
2569
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2570
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2466
2571
  */
2467
2572
  UrlB?: string
2468
2573
  /**
2469
2574
  * 人脸识别服务所用的算法模型版本。
2470
-
2471
- 目前入参支持 2.0”和“3.0“ 两个输入。
2472
-
2473
- 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
2474
-
2475
- 2020年11月26日后开通服务的账号仅支持输入“3.0”。
2476
-
2477
- 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
2575
+ - 目前入参支持 “2.0”和“3.0“ 两个输入。
2576
+ - 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
2577
+ - 2020年11月26日后开通服务的账号仅支持输入“3.0”。
2578
+ - 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
2478
2579
  */
2479
2580
  FaceModelVersion?: string
2480
2581
  /**
2481
2582
  * 图片质量控制。
2583
+ - 取值范围:
2482
2584
  0: 不进行控制;
2483
2585
  1: 较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
2484
2586
  2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
2485
2587
  3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
2486
2588
  4: 很高的质量要求,各个维度均为最好或最多,在某一维度上存在轻微问题;
2487
2589
  默认 0。
2488
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
2590
+
2591
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
2489
2592
  */
2490
2593
  QualityControl?: number
2491
2594
  /**
2492
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2595
+ * 是否开启图片旋转识别支持。
2596
+ - 取值范围:0为不开启,1为开启。
2597
+ - 默认为0。
2598
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
2599
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2493
2600
  */
2494
2601
  NeedRotateDetection?: number
2495
2602
  }
@@ -2549,7 +2656,7 @@ export interface DetectFaceResponse {
2549
2656
  */
2550
2657
  export interface GetPersonListNumRequest {
2551
2658
  /**
2552
- * 人员库ID,取值为创建人员库接口中的GroupId
2659
+ * 人员库ID,取值为创建人员库接口中的GroupId
2553
2660
  */
2554
2661
  GroupId: string
2555
2662
  }
@@ -2559,7 +2666,7 @@ export interface GetPersonListNumRequest {
2559
2666
  */
2560
2667
  export interface GetGroupInfoRequest {
2561
2668
  /**
2562
- * 人员库 ID,取值为创建人员库接口中的GroupId
2669
+ * 人员库 ID,取值为创建人员库接口中的GroupId
2563
2670
  */
2564
2671
  GroupId: string
2565
2672
  }
@@ -2612,15 +2719,15 @@ export interface ModifyGroupResponse {
2612
2719
  */
2613
2720
  export interface GetPersonListRequest {
2614
2721
  /**
2615
- * 人员库ID,取值为创建人员库接口中的GroupId
2722
+ * 人员库ID,取值为创建人员库接口中的GroupId
2616
2723
  */
2617
2724
  GroupId: string
2618
2725
  /**
2619
- * 起始序号,默认值为0
2726
+ * 起始序号,默认值为0
2620
2727
  */
2621
2728
  Offset?: number
2622
2729
  /**
2623
- * 返回数量,默认值为10,最大值为1000
2730
+ * 返回数量,默认值为10,最大值为1000
2624
2731
  */
2625
2732
  Limit?: number
2626
2733
  }