tencentcloud-sdk-iai 3.0.940 → 3.0.942

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: d8843240ea78e637d3db59edbc29f408060d7121
4
- data.tar.gz: b31e798f3d58f76d83baf3a94e8feef46fb85dda
3
+ metadata.gz: ad1b8098cafdce4d459e00df251d20e6c94d1aed
4
+ data.tar.gz: e3f201050144cbf6927691b7d0262bf1104065c2
5
5
  SHA512:
6
- metadata.gz: 135daf342519db58275f06f999daabb72aaf4fa8634205b2b423633c8001b86d00f8f6128de2a8acdc6c1af3bec9f81c56c5d060e3c45f4e05e7df1fd4d13ba5
7
- data.tar.gz: 8eb0c9799c38baa5109992a0bb00230c434a5744b768b35ff3ff1c966b2050d47047fb4466f2c59000c16584954de604464a828f585c8e57d73cb7400bd609ef
6
+ metadata.gz: 4b7b37cc5399594b0bfc9748a5d117bed7026e304886333104e15c12dd772753c0a89b5c460bcbad8a919cffcd86b28a6388152e492600c53a8feb2e4265e502
7
+ data.tar.gz: ee8b03b1633a758a004fc9f0e9538a57b7fb555058891d393991e909a46b0ed0747c8fb7b18fc82fbd98d1a93276d81c480dbeb581294e6f0641b4e7d85b194b
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.940
1
+ 3.0.942
@@ -19,24 +19,31 @@ module TencentCloud
19
19
  module V20180301
20
20
  # AnalyzeDenseLandmarks请求参数结构体
21
21
  class AnalyzeDenseLandmarksRequest < TencentCloud::Common::AbstractModel
22
- # @param Mode: 检测模式。0 为检测所有出现的人脸, 1 为检测面积最大的人脸。
23
- # 默认为 0
24
- # 最多返回 5 张人脸的五官定位(人脸关键点)具体信息。
22
+ # @param Mode: 检测模式。
23
+ # - 取值范围:0 为检测所有出现的人脸, 1 为检测面积最大的人脸。
24
+ # - 默认为 0。
25
+ # - 最多返回 5 张人脸的五官定位(人脸关键点)具体信息。
25
26
  # @type Mode: Integer
26
- # @param Image: 图片 base64 数据,base64 编码后大小不可超过5M。
27
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
28
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
27
+ # @param Image: 图片 base64 数据。
28
+ # - base64 编码后大小不可超过5M
29
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
30
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
29
31
  # @type Image: String
30
- # @param Url: 图片的 Url 。对应图片 base64 编码后大小不可超过5M
31
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
32
- # Url、Image必须提供一个,如果都提供,只使用 Url
33
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
34
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
35
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
32
+ # @param Url: 图片的 Url 。
33
+ # - 对应图片 base64 编码后大小不可超过5M
34
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
35
+ # - Url、Image必须提供一个,如果都提供,只使用 Url。
36
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
37
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
38
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
36
39
  # @type Url: String
37
40
  # @param FaceModelVersion: 人脸识别服务所用的算法模型版本。本接口仅支持 “3.0“ 输入。
38
41
  # @type FaceModelVersion: String
39
- # @param NeedRotateDetection: 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
42
+ # @param NeedRotateDetection: 是否开启图片旋转识别支持。
43
+ # - 取值范围:0为不开启,1为开启。
44
+ # - 默认为0。
45
+ # - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
46
+ # - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
40
47
  # @type NeedRotateDetection: Integer
41
48
 
42
49
  attr_accessor :Mode, :Image, :Url, :FaceModelVersion, :NeedRotateDetection
@@ -272,52 +272,58 @@ module TencentCloud
272
272
 
273
273
  # CompareFace请求参数结构体
274
274
  class CompareFaceRequest < TencentCloud::Common::AbstractModel
275
- # @param ImageA: A 图片 base64 数据,base64 编码后大小不可超过5M。
276
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
277
- # 若图片中包含多张人脸,只选取其中置信度最高的人脸。
278
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
275
+ # @param ImageA: A 图片 base64 数据。
276
+ # - base64 编码后大小不可超过5M
277
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
278
+ # - 若图片中包含多张人脸,只选取其中置信度最高的人脸。
279
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
279
280
  # @type ImageA: String
280
- # @param ImageB: B 图片 base64 数据,base64 编码后大小不可超过5M。
281
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
282
- # 若图片中包含多张人脸,只选取其中置信度最高的人脸。
283
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
281
+ # @param ImageB: B 图片 base64 数据。
282
+ # - base64 编码后大小不可超过5M
283
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
284
+ # - 若图片中包含多张人脸,只选取其中置信度最高的人脸。
285
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
284
286
  # @type ImageB: String
285
- # @param UrlA: A 图片的 Url ,对应图片 base64 编码后大小不可超过5M
286
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
287
- # A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
288
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
289
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
290
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
291
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
287
+ # @param UrlA: A 图片的 Url。
288
+ # - 对应图片 base64 编码后大小不可超过5M
289
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
290
+ # - A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
291
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
292
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
293
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
294
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
292
295
  # @type UrlA: String
293
- # @param UrlB: B 图片的 Url ,对应图片 base64 编码后大小不可超过5M
294
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
295
- # B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
296
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
297
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
298
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
299
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
296
+ # @param UrlB: B 图片的 Url 。
297
+ # - 对应图片 base64 编码后大小不可超过5M
298
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
299
+ # - B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
300
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
301
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
302
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
303
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
300
304
  # @type UrlB: String
301
305
  # @param FaceModelVersion: 人脸识别服务所用的算法模型版本。
302
-
303
- # 目前入参支持 2.0”和“3.0“ 两个输入。
304
-
305
- # 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
306
-
307
- # 2020年11月26日后开通服务的账号仅支持输入“3.0”。
308
-
309
- # 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
306
+ # - 目前入参支持 “2.0”和“3.0“ 两个输入。
307
+ # - 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
308
+ # - 2020年11月26日后开通服务的账号仅支持输入“3.0”。
309
+ # - 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
310
310
  # @type FaceModelVersion: String
311
311
  # @param QualityControl: 图片质量控制。
312
+ # - 取值范围:
312
313
  # 0: 不进行控制;
313
314
  # 1: 较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
314
315
  # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
315
316
  # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
316
317
  # 4: 很高的质量要求,各个维度均为最好或最多,在某一维度上存在轻微问题;
317
318
  # 默认 0。
318
- # 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
319
+
320
+ # - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
319
321
  # @type QualityControl: Integer
320
- # @param NeedRotateDetection: 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
322
+ # @param NeedRotateDetection: 是否开启图片旋转识别支持。
323
+ # - 取值范围:0为不开启,1为开启。
324
+ # - 默认为0。
325
+ # - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
326
+ # - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
321
327
  # @type NeedRotateDetection: Integer
322
328
 
323
329
  attr_accessor :ImageA, :ImageB, :UrlA, :UrlB, :FaceModelVersion, :QualityControl, :NeedRotateDetection
@@ -346,10 +352,10 @@ module TencentCloud
346
352
  # CompareFace返回参数结构体
347
353
  class CompareFaceResponse < TencentCloud::Common::AbstractModel
348
354
  # @param Score: 两张图片中人脸的相似度分数。
349
- # 不同算法版本返回的相似度分数不同。
350
- # 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
351
- # 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
352
- # 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
355
+ # - 不同算法版本返回的相似度分数不同。
356
+ # - 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
357
+ # - 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
358
+ # - 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
353
359
  # @type Score: Float
354
360
  # @param FaceModelVersion: 人脸识别所用的算法模型版本。
355
361
  # @type FaceModelVersion: String
@@ -373,42 +379,47 @@ module TencentCloud
373
379
 
374
380
  # CompareMaskFace请求参数结构体
375
381
  class CompareMaskFaceRequest < TencentCloud::Common::AbstractModel
376
- # @param ImageA: A 图片 base64 数据,base64 编码后大小不可超过5M。
377
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
378
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
379
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
382
+ # @param ImageA: A 图片 base64 数据。
383
+ # - base64 编码后大小不可超过5M
384
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
385
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
386
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
380
387
  # @type ImageA: String
381
- # @param ImageB: B 图片 base64 数据,base64 编码后大小不可超过5M。
382
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
383
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
384
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
388
+ # @param ImageB: B 图片 base64 数据。
389
+ # - base64 编码后大小不可超过5M
390
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
391
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
392
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
385
393
  # @type ImageB: String
386
- # @param UrlA: A 图片的 Url ,对应图片 base64 编码后大小不可超过5M
387
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
388
- # A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
389
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
390
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
391
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
392
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
394
+ # @param UrlA: A 图片的 Url 。
395
+ # - 对应图片 base64 编码后大小不可超过5M
396
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
397
+ # - A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
398
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
399
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
400
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
401
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
393
402
  # @type UrlA: String
394
- # @param UrlB: B 图片的 Url ,对应图片 base64 编码后大小不可超过5M
395
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
396
- # B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
397
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
398
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
399
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
400
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
403
+ # @param UrlB: B 图片的 Url 。
404
+ # - 对应图片 base64 编码后大小不可超过5M
405
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
406
+ # - B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
407
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
408
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
409
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
410
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
401
411
  # @type UrlB: String
402
412
  # @param FaceModelVersion: 人脸识别服务所用的算法模型版本。该接口只支持"3.0"
403
413
  # @type FaceModelVersion: String
404
414
  # @param QualityControl: 图片质量控制。
415
+ # - 取值范围:
405
416
  # 0: 不进行控制;
406
417
  # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
407
418
  # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
408
419
  # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
409
420
  # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
410
- # 默认 0。
411
- # 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
421
+ # - 默认 0。
422
+ # - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
412
423
  # @type QualityControl: Integer
413
424
 
414
425
  attr_accessor :ImageA, :ImageB, :UrlA, :UrlB, :FaceModelVersion, :QualityControl
@@ -435,10 +446,10 @@ module TencentCloud
435
446
  # CompareMaskFace返回参数结构体
436
447
  class CompareMaskFaceResponse < TencentCloud::Common::AbstractModel
437
448
  # @param Score: 两张图片中人脸的相似度分数。
438
- # 不同算法版本返回的相似度分数不同。
439
- # 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
440
- # 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
441
- # 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
449
+ # - 不同算法版本返回的相似度分数不同。
450
+ # - 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
451
+ # - 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
452
+ # - 若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
442
453
  # @type Score: Float
443
454
  # @param FaceModelVersion: 人脸识别所用的算法模型版本。
444
455
  # @type FaceModelVersion: String
@@ -462,9 +473,9 @@ module TencentCloud
462
473
 
463
474
  # CopyPerson请求参数结构体
464
475
  class CopyPersonRequest < TencentCloud::Common::AbstractModel
465
- # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
476
+ # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
466
477
  # @type PersonId: String
467
- # @param GroupIds: 待加入的人员库列表,数组元素取值为创建人员库接口中的GroupId
478
+ # @param GroupIds: 待加入的人员库列表,数组元素取值为创建人员库接口中的GroupId
468
479
  # @type GroupIds: Array
469
480
 
470
481
  attr_accessor :PersonId, :GroupIds
@@ -482,9 +493,9 @@ module TencentCloud
482
493
 
483
494
  # CopyPerson返回参数结构体
484
495
  class CopyPersonResponse < TencentCloud::Common::AbstractModel
485
- # @param SucGroupNum: 成功加入的人员库数量
496
+ # @param SucGroupNum: 成功加入的人员库数量。
486
497
  # @type SucGroupNum: Integer
487
- # @param SucGroupIds: 成功加入的人员库列表
498
+ # @param SucGroupIds: 成功加入的人员库列表。
488
499
  # @type SucGroupIds: Array
489
500
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
490
501
  # @type RequestId: String
@@ -506,36 +517,44 @@ module TencentCloud
506
517
 
507
518
  # CreateFace请求参数结构体
508
519
  class CreateFaceRequest < TencentCloud::Common::AbstractModel
509
- # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
520
+ # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
510
521
  # @type PersonId: String
511
- # @param Images: 图片 base64 数据,base64 编码后大小不可超过5M。
512
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
513
- # 人员人脸总数量不可超过5张。
514
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
515
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
522
+ # @param Images: 图片 base64 数据。
523
+ # - base64 编码后大小不可超过5M
524
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
525
+ # - 人员人脸总数量不可超过5张。
526
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
527
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
516
528
  # @type Images: Array
517
- # @param Urls: 图片的 Url 。对应图片 base64 编码后大小不可超过5M
518
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
519
- # Url、Image必须提供一个,如果都提供,只使用 Url
520
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
521
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
522
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
523
- # 人员人脸总数量不可超过5张。
524
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
529
+ # @param Urls: 图片的 Url 。
530
+ # - 对应图片 base64 编码后大小不可超过5M
531
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
532
+ # - Url、Image必须提供一个,如果都提供,只使用 Url。
533
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
534
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
535
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
536
+ # - 人员人脸总数量不可超过5张。
537
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
525
538
  # @type Urls: Array
526
539
  # @param FaceMatchThreshold: 只有和该人员已有的人脸相似度超过FaceMatchThreshold值的人脸,才能增加人脸成功。
527
- # 默认值60分。取值范围[0,100] 。
540
+ # - 默认值60分。
541
+ # - 取值范围:[0,100] 。
528
542
  # @type FaceMatchThreshold: Float
529
543
  # @param QualityControl: 图片质量控制。
544
+ # - 取值范围:
530
545
  # 0: 不进行控制;
531
546
  # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
532
547
  # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
533
548
  # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
534
549
  # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
535
- # 默认 0。
536
- # 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
550
+ # - 默认 0。
551
+ # - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
537
552
  # @type QualityControl: Integer
538
- # @param NeedRotateDetection: 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
553
+ # @param NeedRotateDetection: 是否开启图片旋转识别支持。
554
+ # - 取值范围:0为不开启,1为开启。
555
+ # - 默认为0。
556
+ # - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
557
+ # - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
539
558
  # @type NeedRotateDetection: Integer
540
559
 
541
560
  attr_accessor :PersonId, :Images, :Urls, :FaceMatchThreshold, :QualityControl, :NeedRotateDetection
@@ -561,17 +580,22 @@ module TencentCloud
561
580
 
562
581
  # CreateFace返回参数结构体
563
582
  class CreateFaceResponse < TencentCloud::Common::AbstractModel
564
- # @param SucFaceNum: 加入成功的人脸数量
583
+ # @param SucFaceNum: 加入成功的人脸数量。
565
584
  # @type SucFaceNum: Integer
566
- # @param SucFaceIds: 加入成功的人脸ID列表
585
+ # @param SucFaceIds: 加入成功的人脸ID列表。
567
586
  # @type SucFaceIds: Array
568
- # @param RetCode: 每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,-1109 代表图片尺寸过大或者过小,
569
- # -1601代表不符合图片质量控制要求, -1604 代表人脸相似度没有超过FaceMatchThreshold。
570
- # 其他非 0 值代表算法服务异常。
571
- # RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
587
+ # @param RetCode: 每张人脸图片添加结果。
588
+ # - 其他非 0 值代表算法服务异常,取值范围:
589
+ # -1101 代表未检测到人脸。
590
+ # -1102 代表图片解码失败。
591
+ # -1109 代表图片尺寸过大或者过小。
592
+ # -1601代表不符合图片质量控制要求。
593
+ # -1604 代表人脸相似度没有超过FaceMatchThreshold。
594
+ # - RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
572
595
  # @type RetCode: Array
573
- # @param SucIndexes: 加入成功的人脸索引。索引顺序和入参中 Images 或 Urls 的顺序一致。
574
- # 例如, Urls 3 个 url,第二个 url 失败,则 SucIndexes 值为 [0,2] 。
596
+ # @param SucIndexes: 加入成功的人脸索引。
597
+ # - 索引顺序和入参中 Images Urls 的顺序一致。
598
+ # - 例如, Urls 中 有 3 个 url,第二个 url 失败,则 SucIndexes 值为 [0,2] 。
575
599
  # @type SucIndexes: Array
576
600
  # @param SucFaceRects: 加入成功的人脸框位置。顺序和入参中 Images 或 Urls 的顺序一致。
577
601
  # @type SucFaceRects: Array
@@ -617,20 +641,18 @@ module TencentCloud
617
641
  # @param GroupId: 人员库 ID,不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B。
618
642
  # @type GroupId: String
619
643
  # @param GroupExDescriptions: 人员库自定义描述字段,用于描述人员库中人员属性,该人员库下所有人员将拥有此描述字段。
620
- # 最多可以创建5个。
621
- # 每个自定义描述字段支持[1,30]个字符。
622
- # 在同一人员库中自定义描述字段不可重复。
623
- # 例: 设置某人员库“自定义描述字段”为["学号","工号","手机号"],
624
- # 则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段,
625
- # 可在对应人员描述字段中填写内容,登记该人员的学号、工号、手机号等信息。
644
+ # - 最多可以创建5个。
645
+ # - 每个自定义描述字段支持[1,30]个字符。
646
+ # - 在同一人员库中自定义描述字段不可重复。
647
+ # - 例: 设置某人员库“自定义描述字段”为["学号","工号","手机号"], 则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段, 可在对应人员描述字段中填写内容,登记该人员的学号、工号、手机号等信息。
626
648
  # @type GroupExDescriptions: Array
627
649
  # @param Tag: 人员库信息备注,[0,40]个字符。
628
650
  # @type Tag: String
629
651
  # @param FaceModelVersion: 人脸识别服务所用的算法模型版本。
630
- # 目前入参支持 “2.0”和“3.0“ 两个输入。
631
- # 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
632
- # 2020年11月26日后开通服务的账号仅支持输入“3.0”。
633
- # 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
652
+ # - 目前入参支持 “2.0”和“3.0“ 两个输入。
653
+ # - 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
654
+ # - 2020年11月26日后开通服务的账号仅支持输入“3.0”。
655
+ # - 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
634
656
  # @type FaceModelVersion: String
635
657
 
636
658
  attr_accessor :GroupName, :GroupId, :GroupExDescriptions, :Tag, :FaceModelVersion
@@ -674,48 +696,59 @@ module TencentCloud
674
696
 
675
697
  # CreatePerson请求参数结构体
676
698
  class CreatePersonRequest < TencentCloud::Common::AbstractModel
677
- # @param GroupId: 待加入的人员库ID,取值为创建人员库接口中的GroupId
699
+ # @param GroupId: 待加入的人员库ID,取值为创建人员库接口中的GroupId
678
700
  # @type GroupId: String
679
701
  # @param PersonName: 人员名称。[1,60]个字符,可修改,可重复。
680
702
  # @type PersonName: String
681
- # @param PersonId: 人员ID,单个腾讯云账号下不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B
703
+ # @param PersonId: 人员ID。
704
+ # - 单个腾讯云账号下不可修改,不可重复。
705
+ # - 支持英文、数字、-%@#&_,长度限制64B。
682
706
  # @type PersonId: String
683
- # @param Gender: 0代表未填写,1代表男性,2代表女性。
707
+ # @param Gender: 性别。
708
+ # - 取值范围:0代表未填写,1代表男性,2代表女性。
684
709
  # @type Gender: Integer
685
710
  # @param PersonExDescriptionInfos: 人员描述字段内容,key-value。[0,60]个字符,可修改,可重复。
686
711
  # @type PersonExDescriptionInfos: Array
687
- # @param Image: 图片 base64 数据,base64 编码后大小不可超过5M。
688
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
689
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
712
+ # @param Image: 图片 base64 数据。
713
+ # - base64 编码后大小不可超过5M
714
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
715
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
690
716
  # @type Image: String
691
- # @param Url: 图片的 Url 。对应图片 base64 编码后大小不可超过5M
692
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
693
- # Url、Image必须提供一个,如果都提供,只使用 Url
694
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
695
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
696
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
717
+ # @param Url: 图片的 Url 。
718
+ # - 对应图片 base64 编码后大小不可超过5M
719
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
720
+ # - Url、Image必须提供一个,如果都提供,只使用 Url。
721
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
722
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
723
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
697
724
  # @type Url: String
698
725
  # @param UniquePersonControl: 此参数用于控制判断 Image 或 Url 中图片包含的人脸,是否在人员库中已有疑似的同一人。
699
- # 如果判断为已有相同人在人员库中,则不会创建新的人员,返回疑似同一人的人员信息。
700
- # 如果判断没有,则完成创建人员。
726
+ # - 如果判断为已有相同人在人员库中,则不会创建新的人员,返回疑似同一人的人员信息。
727
+ # - 如果判断没有,则完成创建人员。
728
+ # - 取值范围:
701
729
  # 0: 不进行判断,无论是否有疑似同一人在库中均完成入库;
702
730
  # 1:较低的同一人判断要求(百一误识别率);
703
731
  # 2: 一般的同一人判断要求(千一误识别率);
704
732
  # 3: 较高的同一人判断要求(万一误识别率);
705
733
  # 4: 很高的同一人判断要求(十万一误识别率)。
706
- # 默认 0。
707
- # 注: 要求越高,则疑似同一人的概率越小。不同要求对应的误识别率仅为参考值,您可以根据实际情况调整。
734
+ # - 默认 0。
735
+ # - 注: 要求越高,则疑似同一人的概率越小。不同要求对应的误识别率仅为参考值,您可以根据实际情况调整。
708
736
  # @type UniquePersonControl: Integer
709
737
  # @param QualityControl: 图片质量控制。
738
+ # - 取值范围:
710
739
  # 0: 不进行控制;
711
740
  # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
712
741
  # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
713
742
  # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
714
743
  # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
715
- # 默认 0。
716
- # 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
744
+ # - 默认 0。
745
+ # - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
717
746
  # @type QualityControl: Integer
718
- # @param NeedRotateDetection: 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
747
+ # @param NeedRotateDetection: 是否开启图片旋转识别支持。
748
+ # - 取值范围:0为不开启,1为开启。
749
+ # - 默认为0。
750
+ # - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
751
+ # - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
719
752
  # @type NeedRotateDetection: Integer
720
753
 
721
754
  attr_accessor :GroupId, :PersonName, :PersonId, :Gender, :PersonExDescriptionInfos, :Image, :Url, :UniquePersonControl, :QualityControl, :NeedRotateDetection
@@ -762,7 +795,7 @@ module TencentCloud
762
795
  # 注意:此字段可能返回 null,表示取不到有效值。
763
796
  # @type FaceRect: :class:`Tencentcloud::Iai.v20200303.models.FaceRect`
764
797
  # @param SimilarPersonId: 疑似同一人的PersonId。
765
- # 当 UniquePersonControl 参数不为0且人员库中有疑似的同一人,此参数才有意义。
798
+ # - 当 UniquePersonControl 参数不为0且人员库中有疑似的同一人,此参数才有意义。
766
799
  # @type SimilarPersonId: String
767
800
  # @param FaceModelVersion: 人脸识别所用的算法模型版本。
768
801
  # @type FaceModelVersion: String
@@ -793,9 +826,9 @@ module TencentCloud
793
826
 
794
827
  # DeleteFace请求参数结构体
795
828
  class DeleteFaceRequest < TencentCloud::Common::AbstractModel
796
- # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
829
+ # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
797
830
  # @type PersonId: String
798
- # @param FaceIds: 待删除的人脸ID列表,数组元素取值为增加人脸接口返回的FaceId
831
+ # @param FaceIds: 待删除的人脸ID列表,数组元素取值为增加人脸接口返回的FaceId
799
832
  # @type FaceIds: Array
800
833
 
801
834
  attr_accessor :PersonId, :FaceIds
@@ -813,9 +846,9 @@ module TencentCloud
813
846
 
814
847
  # DeleteFace返回参数结构体
815
848
  class DeleteFaceResponse < TencentCloud::Common::AbstractModel
816
- # @param SucDeletedNum: 删除成功的人脸数量
849
+ # @param SucDeletedNum: 删除成功的人脸数量.
817
850
  # @type SucDeletedNum: Integer
818
- # @param SucFaceIds: 删除成功的人脸ID列表
851
+ # @param SucFaceIds: 删除成功的人脸ID列表。
819
852
  # @type SucFaceIds: Array
820
853
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
821
854
  # @type RequestId: String
@@ -837,7 +870,7 @@ module TencentCloud
837
870
 
838
871
  # DeleteGroup请求参数结构体
839
872
  class DeleteGroupRequest < TencentCloud::Common::AbstractModel
840
- # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
873
+ # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
841
874
  # @type GroupId: String
842
875
 
843
876
  attr_accessor :GroupId
@@ -869,9 +902,9 @@ module TencentCloud
869
902
 
870
903
  # DeletePersonFromGroup请求参数结构体
871
904
  class DeletePersonFromGroupRequest < TencentCloud::Common::AbstractModel
872
- # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
905
+ # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
873
906
  # @type PersonId: String
874
- # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
907
+ # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
875
908
  # @type GroupId: String
876
909
 
877
910
  attr_accessor :PersonId, :GroupId
@@ -905,7 +938,7 @@ module TencentCloud
905
938
 
906
939
  # DeletePerson请求参数结构体
907
940
  class DeletePersonRequest < TencentCloud::Common::AbstractModel
908
- # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
941
+ # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
909
942
  # @type PersonId: String
910
943
 
911
944
  attr_accessor :PersonId
@@ -2133,7 +2166,7 @@ module TencentCloud
2133
2166
 
2134
2167
  # GetGroupInfo请求参数结构体
2135
2168
  class GetGroupInfoRequest < TencentCloud::Common::AbstractModel
2136
- # @param GroupId: 人员库 ID,取值为创建人员库接口中的GroupId
2169
+ # @param GroupId: 人员库 ID,取值为创建人员库接口中的GroupId
2137
2170
  # @type GroupId: String
2138
2171
 
2139
2172
  attr_accessor :GroupId
@@ -2149,13 +2182,13 @@ module TencentCloud
2149
2182
 
2150
2183
  # GetGroupInfo返回参数结构体
2151
2184
  class GetGroupInfoResponse < TencentCloud::Common::AbstractModel
2152
- # @param GroupName: 人员库名称
2185
+ # @param GroupName: 人员库名称。
2153
2186
  # @type GroupName: String
2154
- # @param GroupId: 人员库ID
2187
+ # @param GroupId: 人员库ID
2155
2188
  # @type GroupId: String
2156
- # @param GroupExDescriptions: 人员库自定义描述字段
2189
+ # @param GroupExDescriptions: 人员库自定义描述字段。
2157
2190
  # @type GroupExDescriptions: Array
2158
- # @param Tag: 人员库信息备注
2191
+ # @param Tag: 人员库信息备注。
2159
2192
  # @type Tag: String
2160
2193
  # @param FaceModelVersion: 人脸识别所用的算法模型版本。
2161
2194
  # @type FaceModelVersion: String
@@ -2241,7 +2274,7 @@ module TencentCloud
2241
2274
 
2242
2275
  # GetPersonBaseInfo请求参数结构体
2243
2276
  class GetPersonBaseInfoRequest < TencentCloud::Common::AbstractModel
2244
- # @param PersonId: 人员ID,创建人员接口中的PersonId
2277
+ # @param PersonId: 人员ID,创建人员接口中的PersonId
2245
2278
  # @type PersonId: String
2246
2279
 
2247
2280
  attr_accessor :PersonId
@@ -2257,11 +2290,12 @@ module TencentCloud
2257
2290
 
2258
2291
  # GetPersonBaseInfo返回参数结构体
2259
2292
  class GetPersonBaseInfoResponse < TencentCloud::Common::AbstractModel
2260
- # @param PersonName: 人员名称
2293
+ # @param PersonName: 人员名称。
2261
2294
  # @type PersonName: String
2262
- # @param Gender: 人员性别,0代表未填写,1代表男性,2代表女性
2295
+ # @param Gender: 人员性别。
2296
+ # - 取值范围:0代表未填写,1代表男性,2代表女性。
2263
2297
  # @type Gender: Integer
2264
- # @param FaceIds: 包含的人脸 ID 列表
2298
+ # @param FaceIds: 包含的人脸 ID 列表。
2265
2299
  # @type FaceIds: Array
2266
2300
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2267
2301
  # @type RequestId: String
@@ -2285,11 +2319,11 @@ module TencentCloud
2285
2319
 
2286
2320
  # GetPersonGroupInfo请求参数结构体
2287
2321
  class GetPersonGroupInfoRequest < TencentCloud::Common::AbstractModel
2288
- # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
2322
+ # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
2289
2323
  # @type PersonId: String
2290
- # @param Offset: 起始序号,默认值为0
2324
+ # @param Offset: 起始序号,默认值为0
2291
2325
  # @type Offset: Integer
2292
- # @param Limit: 返回数量,默认值为10,最大值为100
2326
+ # @param Limit: 返回数量,默认值为10,最大值为100
2293
2327
  # @type Limit: Integer
2294
2328
 
2295
2329
  attr_accessor :PersonId, :Offset, :Limit
@@ -2309,9 +2343,9 @@ module TencentCloud
2309
2343
 
2310
2344
  # GetPersonGroupInfo返回参数结构体
2311
2345
  class GetPersonGroupInfoResponse < TencentCloud::Common::AbstractModel
2312
- # @param PersonGroupInfos: 包含此人员的人员库及描述字段内容列表
2346
+ # @param PersonGroupInfos: 包含此人员的人员库及描述字段内容列表。
2313
2347
  # @type PersonGroupInfos: Array
2314
- # @param GroupNum: 人员库总数量
2348
+ # @param GroupNum: 人员库总数量。
2315
2349
  # 注意:此字段可能返回 null,表示取不到有效值。
2316
2350
  # @type GroupNum: Integer
2317
2351
  # @param FaceModelVersion: 人脸识别服务所用的算法模型版本。
@@ -2346,7 +2380,7 @@ module TencentCloud
2346
2380
 
2347
2381
  # GetPersonListNum请求参数结构体
2348
2382
  class GetPersonListNumRequest < TencentCloud::Common::AbstractModel
2349
- # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
2383
+ # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
2350
2384
  # @type GroupId: String
2351
2385
 
2352
2386
  attr_accessor :GroupId
@@ -2362,9 +2396,9 @@ module TencentCloud
2362
2396
 
2363
2397
  # GetPersonListNum返回参数结构体
2364
2398
  class GetPersonListNumResponse < TencentCloud::Common::AbstractModel
2365
- # @param PersonNum: 人员数量
2399
+ # @param PersonNum: 人员数量。
2366
2400
  # @type PersonNum: Integer
2367
- # @param FaceNum: 人脸数量
2401
+ # @param FaceNum: 人脸数量。
2368
2402
  # @type FaceNum: Integer
2369
2403
  # @param RequestId: 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2370
2404
  # @type RequestId: String
@@ -2386,11 +2420,11 @@ module TencentCloud
2386
2420
 
2387
2421
  # GetPersonList请求参数结构体
2388
2422
  class GetPersonListRequest < TencentCloud::Common::AbstractModel
2389
- # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
2423
+ # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
2390
2424
  # @type GroupId: String
2391
- # @param Offset: 起始序号,默认值为0
2425
+ # @param Offset: 起始序号,默认值为0
2392
2426
  # @type Offset: Integer
2393
- # @param Limit: 返回数量,默认值为10,最大值为1000
2427
+ # @param Limit: 返回数量,默认值为10,最大值为1000
2394
2428
  # @type Limit: Integer
2395
2429
 
2396
2430
  attr_accessor :GroupId, :Offset, :Limit
@@ -2410,12 +2444,12 @@ module TencentCloud
2410
2444
 
2411
2445
  # GetPersonList返回参数结构体
2412
2446
  class GetPersonListResponse < TencentCloud::Common::AbstractModel
2413
- # @param PersonInfos: 返回的人员信息
2447
+ # @param PersonInfos: 返回的人员信息。
2414
2448
  # @type PersonInfos: Array
2415
- # @param PersonNum: 该人员库的人员数量
2449
+ # @param PersonNum: 该人员库的人员数量。
2416
2450
  # 注意:此字段可能返回 null,表示取不到有效值。
2417
2451
  # @type PersonNum: Integer
2418
- # @param FaceNum: 该人员库的人脸数量
2452
+ # @param FaceNum: 该人员库的人脸数量。
2419
2453
  # 注意:此字段可能返回 null,表示取不到有效值。
2420
2454
  # @type FaceNum: Integer
2421
2455
  # @param FaceModelVersion: 人脸识别所用的算法模型版本。
@@ -2750,13 +2784,13 @@ module TencentCloud
2750
2784
 
2751
2785
  # ModifyGroup请求参数结构体
2752
2786
  class ModifyGroupRequest < TencentCloud::Common::AbstractModel
2753
- # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
2787
+ # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
2754
2788
  # @type GroupId: String
2755
- # @param GroupName: 人员库名称
2789
+ # @param GroupName: 人员库名称。
2756
2790
  # @type GroupName: String
2757
- # @param GroupExDescriptionInfos: 需要修改的人员库自定义描述字段,key-value
2791
+ # @param GroupExDescriptionInfos: 需要修改的人员库自定义描述字段,key-value
2758
2792
  # @type GroupExDescriptionInfos: Array
2759
- # @param Tag: 人员库信息备注
2793
+ # @param Tag: 人员库信息备注。
2760
2794
  # @type Tag: String
2761
2795
 
2762
2796
  attr_accessor :GroupId, :GroupName, :GroupExDescriptionInfos, :Tag
@@ -2801,11 +2835,11 @@ module TencentCloud
2801
2835
 
2802
2836
  # ModifyPersonBaseInfo请求参数结构体
2803
2837
  class ModifyPersonBaseInfoRequest < TencentCloud::Common::AbstractModel
2804
- # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
2838
+ # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
2805
2839
  # @type PersonId: String
2806
- # @param PersonName: 需要修改的人员名称
2840
+ # @param PersonName: 需要修改的人员名称。
2807
2841
  # @type PersonName: String
2808
- # @param Gender: 需要修改的人员性别,1代表男性,2代表女性
2842
+ # @param Gender: 需要修改的人员性别,1代表男性,2代表女性。
2809
2843
  # @type Gender: Integer
2810
2844
 
2811
2845
  attr_accessor :PersonId, :PersonName, :Gender
@@ -2841,11 +2875,11 @@ module TencentCloud
2841
2875
 
2842
2876
  # ModifyPersonGroupInfo请求参数结构体
2843
2877
  class ModifyPersonGroupInfoRequest < TencentCloud::Common::AbstractModel
2844
- # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
2878
+ # @param GroupId: 人员库ID,取值为创建人员库接口中的GroupId
2845
2879
  # @type GroupId: String
2846
- # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
2880
+ # @param PersonId: 人员ID,取值为创建人员接口中的PersonId
2847
2881
  # @type PersonId: String
2848
- # @param PersonExDescriptionInfos: 需要修改的人员描述字段内容,key-value
2882
+ # @param PersonExDescriptionInfos: 需要修改的人员描述字段内容,key-value
2849
2883
  # @type PersonExDescriptionInfos: Array
2850
2884
 
2851
2885
  attr_accessor :GroupId, :PersonId, :PersonExDescriptionInfos
@@ -3111,44 +3145,63 @@ module TencentCloud
3111
3145
 
3112
3146
  # SearchFaces请求参数结构体
3113
3147
  class SearchFacesRequest < TencentCloud::Common::AbstractModel
3114
- # @param GroupIds: 希望搜索的人员库列表,上限100个。数组元素取值为创建人员库接口中的GroupId。
3115
- # 不可同时搜索不同算法模型版本(FaceModelVersion)的人员库。
3148
+ # @param GroupIds: 希望搜索的人员库列表,上限100个。
3149
+ # - 数组元素取值为创建人员库接口中的GroupId。
3150
+ # - 不可同时搜索不同算法模型版本(FaceModelVersion)的人员库。
3116
3151
  # @type GroupIds: Array
3117
- # @param Image: 图片 base64 数据,base64 编码后大小不可超过5M。
3118
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
3119
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3152
+ # @param Image: 图片 base64 数据。
3153
+ # - base64 编码后大小不可超过5M
3154
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
3155
+ # - 所有格式的图片短边像素不小于64。
3156
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3120
3157
  # @type Image: String
3121
- # @param Url: 图片的 Url 。对应图片 base64 编码后大小不可超过5M
3122
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
3123
- # Url、Image必须提供一个,如果都提供,只使用 Url
3124
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
3125
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
3126
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3158
+ # @param Url: 图片的 Url 。
3159
+ # - 对应图片 base64 编码后大小不可超过5M
3160
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
3161
+ # - 所有格式的图片短边像素不小于64。
3162
+ # - Url、Image必须提供一个,如果都提供,只使用 Url。
3163
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
3164
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
3165
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3127
3166
  # @type Url: String
3128
- # @param MaxFaceNum: 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
3129
- # MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
3130
- # 例如:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
3167
+ # @param MaxFaceNum: 最多识别的人脸数目。
3168
+ # - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
3169
+ # - MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
3170
+ # - 例如:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
3131
3171
  # @type MaxFaceNum: Integer
3132
- # @param MinFaceSize: 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
3172
+ # @param MinFaceSize: 人脸长和宽的最小尺寸,单位为像素。
3173
+ # - 默认为34。
3174
+ # - 低于34的人脸图片无法被识别。
3175
+ # - 建议设置为80。
3133
3176
  # @type MinFaceSize: Integer
3134
- # @param MaxPersonNum: 单张被识别的人脸返回的最相似人员数量。默认值为5,最大值为100。
3135
- # 例如,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
3136
- # 值越大,需要处理的时间越长。建议不要超过10。
3177
+ # @param MaxPersonNum: 单张被识别的人脸返回的最相似人员数量。
3178
+ # - 默认值为5,最大值为100。
3179
+ # - 例如,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
3180
+ # - 值越大,需要处理的时间越长。
3181
+ # - 建议不要超过10。
3137
3182
  # @type MaxPersonNum: Integer
3138
- # @param NeedPersonInfo: 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
3183
+ # @param NeedPersonInfo: 是否返回人员具体信息。
3184
+ # - 取值范围:0 为关闭,1 为开启。
3185
+ # - 默认为 0。
3186
+ # - 其他非0非1值默认为0。
3139
3187
  # @type NeedPersonInfo: Integer
3140
3188
  # @param QualityControl: 图片质量控制。
3141
- # 0: 不进行控制;
3142
- # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
3143
- # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
3144
- # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
3145
- # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
3146
- # 默认 0。
3147
- # 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
3189
+ # - 取值范围:
3190
+ # 0: 不进行控制。
3191
+ # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
3192
+ # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
3193
+ # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
3194
+ # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
3195
+ # - 默认 0。
3196
+ # - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
3148
3197
  # @type QualityControl: Integer
3149
3198
  # @param FaceMatchThreshold: 出参Score中,只有超过FaceMatchThreshold值的结果才会返回。默认为0。
3150
3199
  # @type FaceMatchThreshold: Float
3151
- # @param NeedRotateDetection: 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
3200
+ # @param NeedRotateDetection: 是否开启图片旋转识别支持。
3201
+ # - 取值范围:0为不开启,1为开启。
3202
+ # - 默认为0。
3203
+ # - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
3204
+ # - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
3152
3205
  # @type NeedRotateDetection: Integer
3153
3206
 
3154
3207
  attr_accessor :GroupIds, :Image, :Url, :MaxFaceNum, :MinFaceSize, :MaxPersonNum, :NeedPersonInfo, :QualityControl, :FaceMatchThreshold, :NeedRotateDetection
@@ -3217,45 +3270,63 @@ module TencentCloud
3217
3270
 
3218
3271
  # SearchFacesReturnsByGroup请求参数结构体
3219
3272
  class SearchFacesReturnsByGroupRequest < TencentCloud::Common::AbstractModel
3220
- # @param GroupIds: 希望搜索的人员库列表,上限60个。数组元素取值为创建人员库接口中的GroupId。
3221
- # 不可同时搜索不同算法模型版本(FaceModelVersion)的人员库。
3273
+ # @param GroupIds: 希望搜索的人员库列表,上限60个。
3274
+ # - 数组元素取值为创建人员库接口中的GroupId。
3275
+ # - 不可同时搜索不同算法模型版本(FaceModelVersion)的人员库。
3222
3276
  # @type GroupIds: Array
3223
- # @param Image: 图片 base64 数据,base64 编码后大小不可超过5M。
3224
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
3225
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3277
+ # @param Image: 图片 base64 数据。
3278
+ # - base64 编码后大小不可超过5M
3279
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
3280
+ # - 所有格式的图片短边像素不小于64。
3281
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3226
3282
  # @type Image: String
3227
- # @param Url: 图片的 Url 。对应图片 base64 编码后大小不可超过5M
3228
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
3229
- # Url、Image必须提供一个,如果都提供,只使用 Url
3230
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
3231
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
3232
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3283
+ # @param Url: 图片的 Url 。
3284
+ # - 对应图片 base64 编码后大小不可超过5M
3285
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
3286
+ # - 所有格式的图片短边像素不小于64。
3287
+ # - Url、Image必须提供一个,如果都提供,只使用 Url。
3288
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
3289
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
3290
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3233
3291
  # @type Url: String
3234
- # @param MaxFaceNum: 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
3235
- # MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
3236
- # 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
3292
+ # @param MaxFaceNum: 最多识别的人脸数目。
3293
+ # - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
3294
+ # - MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
3295
+ # - 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
3237
3296
  # @type MaxFaceNum: Integer
3238
- # @param MinFaceSize: 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
3297
+ # @param MinFaceSize: 人脸长和宽的最小尺寸,单位为像素。
3298
+ # - 默认为34。
3299
+ # - 低于34将影响搜索精度。
3300
+ # - 建议设置为80。
3239
3301
  # @type MinFaceSize: Integer
3240
- # @param MaxPersonNumPerGroup: 被检测到的人脸,对应最多返回的最相似人员数目。默认值为5,最大值为10。
3241
- # 例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
3302
+ # @param MaxPersonNumPerGroup: 被检测到的人脸,对应最多返回的最相似人员数目。
3303
+ # - 默认值为5,最大值为10。
3304
+ # - 例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
3242
3305
  # @type MaxPersonNumPerGroup: Integer
3243
- # @param NeedPersonInfo: 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
3306
+ # @param NeedPersonInfo: 是否返回人员具体信息。
3307
+ # - 取值范围:0 为关闭,1 为开启。
3308
+ # - 默认为 0。
3309
+ # - 其他非0非1值默认为0
3244
3310
  # @type NeedPersonInfo: Integer
3245
3311
  # @param QualityControl: 图片质量控制。
3246
- # 0: 不进行控制;
3247
- # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
3248
- # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
3249
- # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
3250
- # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
3251
- # 默认 0。
3252
- # 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
3312
+ # - 取值范围:
3313
+ # 0: 不进行控制。
3314
+ # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
3315
+ # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
3316
+ # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
3317
+ # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
3318
+ # - 默认 0。
3319
+ # - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
3253
3320
  # @type QualityControl: Integer
3254
3321
  # @param FaceMatchThreshold: 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。
3255
- # 默认为0。
3256
- # 取值范围[0.0,100.0) 。
3322
+ # - 默认为0。
3323
+ # - 取值范围:[0.0,100.0) 。
3257
3324
  # @type FaceMatchThreshold: Float
3258
- # @param NeedRotateDetection: 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
3325
+ # @param NeedRotateDetection: 是否开启图片旋转识别支持。
3326
+ # - 取值范围:0为不开启,1为开启。
3327
+ # - 默认为0。
3328
+ # - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
3329
+ # - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
3259
3330
  # @type NeedRotateDetection: Integer
3260
3331
 
3261
3332
  attr_accessor :GroupIds, :Image, :Url, :MaxFaceNum, :MinFaceSize, :MaxPersonNumPerGroup, :NeedPersonInfo, :QualityControl, :FaceMatchThreshold, :NeedRotateDetection
@@ -3324,44 +3395,63 @@ module TencentCloud
3324
3395
 
3325
3396
  # SearchPersons请求参数结构体
3326
3397
  class SearchPersonsRequest < TencentCloud::Common::AbstractModel
3327
- # @param GroupIds: 希望搜索的人员库列表,上限100个。数组元素取值为创建人员库接口中的GroupId
3398
+ # @param GroupIds: 希望搜索的人员库列表,上限100个。数组元素取值为创建人员库接口中的GroupId
3328
3399
  # @type GroupIds: Array
3329
- # @param Image: 图片 base64 数据,base64 编码后大小不可超过5M。
3330
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
3331
- # 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
3332
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3400
+ # @param Image: 图片 base64 数据。
3401
+ # - base64 编码后大小不可超过5M
3402
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
3403
+ # - 所有格式的图片短边像素不小于64。
3404
+ # - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
3405
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3333
3406
  # @type Image: String
3334
- # @param Url: 图片的 Url 。对应图片 base64 编码后大小不可超过5M
3335
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
3336
- # Url、Image必须提供一个,如果都提供,只使用 Url
3337
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
3338
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
3339
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3407
+ # @param Url: 图片的 Url 。
3408
+ # - 对应图片 base64 编码后大小不可超过5M
3409
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
3410
+ # - 所有格式的图片短边像素不小于64。
3411
+ # - Url、Image必须提供一个,如果都提供,只使用 Url。
3412
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
3413
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
3414
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3340
3415
  # @type Url: String
3341
- # @param MaxFaceNum: 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
3342
- # MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
3343
- # 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
3416
+ # @param MaxFaceNum: 最多识别的人脸数目。
3417
+ # - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
3418
+ # - MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
3419
+ # - 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
3344
3420
  # @type MaxFaceNum: Integer
3345
- # @param MinFaceSize: 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
3421
+ # @param MinFaceSize: 人脸长和宽的最小尺寸,单位为像素。
3422
+ # - 默认为34。
3423
+ # - 低于34将影响搜索精度。
3424
+ # - 建议设置为80。
3346
3425
  # @type MinFaceSize: Integer
3347
- # @param MaxPersonNum: 单张被识别的人脸返回的最相似人员数量。默认值为5,最大值为100。
3348
- # 例,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
3349
- # 值越大,需要处理的时间越长。建议不要超过10。
3426
+ # @param MaxPersonNum: 单张被识别的人脸返回的最相似人员数量。
3427
+ # - 默认值为5,最大值为100。
3428
+ # - 例,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
3429
+ # - 值越大,需要处理的时间越长。建议不要超过10。
3350
3430
  # @type MaxPersonNum: Integer
3351
3431
  # @param QualityControl: 图片质量控制。
3352
- # 0: 不进行控制;
3353
- # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
3354
- # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
3355
- # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
3356
- # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
3357
- # 默认 0。
3358
- # 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
3432
+ # - 取值范围:
3433
+ # 0: 不进行控制。
3434
+ # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
3435
+ # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
3436
+ # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
3437
+ # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
3438
+ # - 默认 0。
3439
+ # - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
3359
3440
  # @type QualityControl: Integer
3360
- # @param FaceMatchThreshold: 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。默认为0。取值范围[0.0,100.0) 。
3441
+ # @param FaceMatchThreshold: 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。
3442
+ # - 默认为0。
3443
+ # - 取值范围:[0.0,100.0) 。
3361
3444
  # @type FaceMatchThreshold: Float
3362
- # @param NeedPersonInfo: 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
3445
+ # @param NeedPersonInfo: 是否返回人员具体信息。
3446
+ # - 取值范围:0 为关闭,1 为开启。
3447
+ # - 默认为 0。
3448
+ # - 其他非0非1值默认为0
3363
3449
  # @type NeedPersonInfo: Integer
3364
- # @param NeedRotateDetection: 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
3450
+ # @param NeedRotateDetection: 是否开启图片旋转识别支持。
3451
+ # - 取值范围:0为不开启,1为开启。
3452
+ # - 默认为0。
3453
+ # - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
3454
+ # - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
3365
3455
  # @type NeedRotateDetection: Integer
3366
3456
 
3367
3457
  attr_accessor :GroupIds, :Image, :Url, :MaxFaceNum, :MinFaceSize, :MaxPersonNum, :QualityControl, :FaceMatchThreshold, :NeedPersonInfo, :NeedRotateDetection
@@ -3431,42 +3521,59 @@ module TencentCloud
3431
3521
 
3432
3522
  # SearchPersonsReturnsByGroup请求参数结构体
3433
3523
  class SearchPersonsReturnsByGroupRequest < TencentCloud::Common::AbstractModel
3434
- # @param GroupIds: 希望搜索的人员库列表,上限60个。数组元素取值为创建人员库接口中的GroupId
3524
+ # @param GroupIds: 希望搜索的人员库列表,上限60个。数组元素取值为创建人员库接口中的GroupId
3435
3525
  # @type GroupIds: Array
3436
- # @param Image: 图片 base64 数据,base64 编码后大小不可超过5M。
3437
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
3438
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3526
+ # @param Image: 图片 base64 数据。
3527
+ # - base64 编码后大小不可超过5M
3528
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
3529
+ # - 所有格式的图片短边像素不小于64。
3530
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3439
3531
  # @type Image: String
3440
- # @param Url: 图片的 Url 。对应图片 base64 编码后大小不可超过5M
3441
- # jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
3442
- # Url、Image必须提供一个,如果都提供,只使用 Url
3443
- # 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
3444
- # 非腾讯云存储的Url速度和稳定性可能受一定影响。
3445
- # 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3532
+ # @param Url: 图片的 Url 。
3533
+ # - 对应图片 base64 编码后大小不可超过5M
3534
+ # - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
3535
+ # - 所有格式的图片短边像素不小于64。
3536
+ # - Url、Image必须提供一个,如果都提供,只使用 Url。
3537
+ # - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
3538
+ # - 非腾讯云存储的Url速度和稳定性可能受一定影响。
3539
+ # - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
3446
3540
  # @type Url: String
3447
- # @param MaxFaceNum: 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
3448
- # MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
3449
- # 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
3541
+ # @param MaxFaceNum: 最多识别的人脸数目。
3542
+ # - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
3543
+ # - MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
3544
+ # - 例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
3450
3545
  # @type MaxFaceNum: Integer
3451
- # @param MinFaceSize: 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
3546
+ # @param MinFaceSize: 人脸长和宽的最小尺寸,单位为像素。
3547
+ # - 默认为34。
3548
+ # - 低于34将影响搜索精度。
3549
+ # - 建议设置为80。
3452
3550
  # @type MinFaceSize: Integer
3453
- # @param MaxPersonNumPerGroup: 被检测到的人脸,对应最多返回的最相似人员数目。默认值为5,最大值为10。
3454
- # 例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
3551
+ # @param MaxPersonNumPerGroup: 被检测到的人脸,对应最多返回的最相似人员数目。
3552
+ # - 默认值为5,最大值为10。
3553
+ # - 例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
3455
3554
  # @type MaxPersonNumPerGroup: Integer
3456
3555
  # @param QualityControl: 图片质量控制。
3457
- # 0: 不进行控制;
3458
- # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
3459
- # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
3460
- # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
3461
- # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
3462
- # 默认 0。
3463
- # 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
3556
+ # - 取值范围:
3557
+ # 0: 不进行控制。
3558
+ # 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
3559
+ # 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
3560
+ # 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
3561
+ # 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
3562
+ # - 默认 0。
3563
+ # - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
3464
3564
  # @type QualityControl: Integer
3465
3565
  # @param FaceMatchThreshold: 出参Score中,只有超过FaceMatchThreshold值的结果才会返回。默认为0。
3466
3566
  # @type FaceMatchThreshold: Float
3467
- # @param NeedPersonInfo: 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
3567
+ # @param NeedPersonInfo: 是否返回人员具体信息。
3568
+ # - 取值范围:0 为关闭,1 为开启。
3569
+ # - 默认为 0。
3570
+ # - 其他非0非1值默认为0。
3468
3571
  # @type NeedPersonInfo: Integer
3469
- # @param NeedRotateDetection: 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
3572
+ # @param NeedRotateDetection: 是否开启图片旋转识别支持。
3573
+ # - 取值范围:0为不开启,1为开启。
3574
+ # - 默认为0。
3575
+ # - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
3576
+ # - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
3470
3577
  # @type NeedRotateDetection: Integer
3471
3578
 
3472
3579
  attr_accessor :GroupIds, :Image, :Url, :MaxFaceNum, :MinFaceSize, :MaxPersonNumPerGroup, :QualityControl, :FaceMatchThreshold, :NeedPersonInfo, :NeedRotateDetection
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-iai
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.940
4
+ version: 3.0.942
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-11-12 00:00:00.000000000 Z
11
+ date: 2024-11-15 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common