tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1077__py2.py3-none-any.whl

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

Potentially problematic release.


This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.

Files changed (126) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/advisor/v20200721/models.py +120 -0
  3. tencentcloud/aiart/v20221229/models.py +95 -0
  4. tencentcloud/ams/v20201229/models.py +432 -0
  5. tencentcloud/antiddos/v20200309/models.py +2806 -0
  6. tencentcloud/apigateway/v20180808/models.py +3945 -0
  7. tencentcloud/autoscaling/v20180419/autoscaling_client.py +16 -10
  8. tencentcloud/autoscaling/v20180419/errorcodes.py +3 -0
  9. tencentcloud/autoscaling/v20180419/models.py +2472 -7
  10. tencentcloud/batch/v20170312/models.py +1566 -0
  11. tencentcloud/billing/v20180709/models.py +2418 -0
  12. tencentcloud/cam/v20190116/models.py +1697 -0
  13. tencentcloud/captcha/v20190722/models.py +70 -0
  14. tencentcloud/car/v20220110/models.py +803 -0
  15. tencentcloud/cbs/v20170312/models.py +1245 -0
  16. tencentcloud/ccc/v20200210/models.py +1949 -1
  17. tencentcloud/cdb/v20170320/models.py +4821 -0
  18. tencentcloud/cdn/v20180606/models.py +4870 -8
  19. tencentcloud/cdwdoris/v20211228/models.py +3337 -0
  20. tencentcloud/cfg/v20210820/models.py +1194 -0
  21. tencentcloud/cfs/v20190719/models.py +1178 -0
  22. tencentcloud/cfw/v20190904/models.py +2378 -0
  23. tencentcloud/chdfs/v20201112/models.py +513 -0
  24. tencentcloud/ciam/v20210420/models.py +49 -0
  25. tencentcloud/ciam/v20220331/models.py +789 -0
  26. tencentcloud/ckafka/v20190819/models.py +2576 -0
  27. tencentcloud/clb/v20180317/models.py +3220 -1
  28. tencentcloud/cloudaudit/v20190319/models.py +519 -0
  29. tencentcloud/cls/v20201016/models.py +3652 -1
  30. tencentcloud/cmq/v20190304/models.py +571 -0
  31. tencentcloud/controlcenter/v20230110/models.py +15 -0
  32. tencentcloud/csip/v20221121/models.py +2881 -2
  33. tencentcloud/cvm/v20170312/models.py +2827 -0
  34. tencentcloud/cwp/v20180228/models.py +16412 -0
  35. tencentcloud/cynosdb/v20190107/models.py +4263 -0
  36. tencentcloud/dataintegration/v20220613/models.py +18 -0
  37. tencentcloud/dayu/v20180709/models.py +3541 -12
  38. tencentcloud/dbbrain/v20191016/models.py +1056 -0
  39. tencentcloud/dbbrain/v20210527/models.py +1763 -0
  40. tencentcloud/dc/v20180410/models.py +767 -0
  41. tencentcloud/dcdb/v20180411/models.py +2335 -0
  42. tencentcloud/dlc/v20210125/models.py +3985 -5
  43. tencentcloud/dms/v20200819/models.py +51 -0
  44. tencentcloud/dnspod/v20210323/models.py +1286 -0
  45. tencentcloud/domain/v20180808/models.py +855 -0
  46. tencentcloud/dts/v20180330/models.py +791 -0
  47. tencentcloud/dts/v20211206/models.py +2317 -1
  48. tencentcloud/eb/v20210416/models.py +858 -0
  49. tencentcloud/ecdn/v20191012/models.py +811 -0
  50. tencentcloud/ecm/v20190719/models.py +3972 -1
  51. tencentcloud/eiam/v20210420/models.py +1265 -0
  52. tencentcloud/emr/v20190103/models.py +2926 -7
  53. tencentcloud/es/v20180416/models.py +1523 -0
  54. tencentcloud/facefusion/v20220927/models.py +211 -0
  55. tencentcloud/faceid/v20180301/models.py +2071 -0
  56. tencentcloud/gaap/v20180529/models.py +3103 -8
  57. tencentcloud/gme/v20180711/models.py +388 -0
  58. tencentcloud/gpm/v20200820/models.py +674 -0
  59. tencentcloud/gse/v20191112/models.py +972 -0
  60. tencentcloud/iai/v20200303/models.py +1430 -0
  61. tencentcloud/ims/v20201229/models.py +329 -0
  62. tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
  63. tencentcloud/iotcloud/v20210408/models.py +585 -0
  64. tencentcloud/ip/v20210409/models.py +178 -0
  65. tencentcloud/kms/v20190118/models.py +869 -0
  66. tencentcloud/lcic/v20220817/models.py +1658 -0
  67. tencentcloud/lighthouse/v20200324/models.py +2088 -0
  68. tencentcloud/live/v20180801/models.py +4287 -0
  69. tencentcloud/mariadb/v20170312/models.py +1905 -0
  70. tencentcloud/mdc/v20200828/models.py +1104 -0
  71. tencentcloud/mdl/v20200326/models.py +1911 -1
  72. tencentcloud/mdp/v20200527/models.py +452 -0
  73. tencentcloud/mongodb/v20190725/models.py +1234 -0
  74. tencentcloud/monitor/v20180724/models.py +5798 -2
  75. tencentcloud/mps/v20190612/models.py +8135 -0
  76. tencentcloud/msp/v20180319/models.py +183 -0
  77. tencentcloud/ocr/v20181119/models.py +3160 -1
  78. tencentcloud/omics/v20221128/models.py +1086 -0
  79. tencentcloud/organization/v20181225/models.py +285 -0
  80. tencentcloud/organization/v20210331/models.py +2267 -0
  81. tencentcloud/postgres/v20170312/models.py +3248 -0
  82. tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
  83. tencentcloud/privatedns/v20201028/models.py +1700 -0
  84. tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
  85. tencentcloud/redis/v20180412/models.py +3298 -3
  86. tencentcloud/rum/v20210622/models.py +2114 -0
  87. tencentcloud/scf/v20180416/models.py +1561 -0
  88. tencentcloud/ses/v20201002/models.py +649 -0
  89. tencentcloud/sms/v20190711/models.py +575 -0
  90. tencentcloud/sms/v20210111/models.py +593 -0
  91. tencentcloud/sqlserver/v20180328/models.py +2780 -0
  92. tencentcloud/ssl/v20191205/models.py +2267 -0
  93. tencentcloud/ssm/v20190923/models.py +675 -11
  94. tencentcloud/sts/v20180813/models.py +161 -0
  95. tencentcloud/tag/v20180813/models.py +784 -0
  96. tencentcloud/tat/v20201028/models.py +806 -0
  97. tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
  98. tencentcloud/tchd/v20230306/models.py +41 -0
  99. tencentcloud/tcmpp/v20240801/models.py +3761 -1
  100. tencentcloud/tcr/v20190924/models.py +1851 -0
  101. tencentcloud/tcss/v20201101/models.py +12523 -0
  102. tencentcloud/tdid/v20210519/models.py +1258 -0
  103. tencentcloud/tdmq/v20200217/models.py +3495 -0
  104. tencentcloud/tem/v20201221/models.py +803 -0
  105. tencentcloud/tem/v20210701/models.py +2551 -1
  106. tencentcloud/teo/v20220106/models.py +4731 -0
  107. tencentcloud/teo/v20220901/models.py +6066 -0
  108. tencentcloud/tiw/v20190919/models.py +1678 -1
  109. tencentcloud/tke/v20180525/models.py +3662 -0
  110. tencentcloud/tms/v20201229/models.py +176 -0
  111. tencentcloud/tmt/v20180321/models.py +65 -0
  112. tencentcloud/trtc/v20190722/models.py +1698 -8
  113. tencentcloud/tts/v20190823/models.py +72 -0
  114. tencentcloud/vm/v20201229/models.py +568 -0
  115. tencentcloud/vm/v20210922/models.py +636 -0
  116. tencentcloud/vod/v20180717/models.py +13490 -1
  117. tencentcloud/vpc/v20170312/errorcodes.py +3 -0
  118. tencentcloud/vpc/v20170312/models.py +6622 -1
  119. tencentcloud/vpc/v20170312/vpc_client.py +23 -0
  120. tencentcloud/waf/v20180125/models.py +4814 -0
  121. tencentcloud/wedata/v20210820/models.py +12594 -0
  122. tencentcloud/yunjing/v20180228/models.py +1867 -0
  123. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/METADATA +1 -1
  124. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/RECORD +126 -126
  125. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/WHEEL +0 -0
  126. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1077.dist-info}/top_level.txt +0 -0
@@ -59,6 +59,9 @@ Different algorithm model versions correspond to different face recognition algo
59
59
 
60
60
  @property
61
61
  def Mode(self):
62
+ """Detection mode. 0: detect all faces that appear; 1: detect the largest face. Default value: 0. The facial feature localization information (facial keypoints) of up to 10 faces can be returned.
63
+ :rtype: int
64
+ """
62
65
  return self._Mode
63
66
 
64
67
  @Mode.setter
@@ -67,6 +70,11 @@ Different algorithm model versions correspond to different face recognition algo
67
70
 
68
71
  @property
69
72
  def Image(self):
73
+ """Base64-encoded image data, which cannot exceed 5 MB.
74
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
75
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
76
+ :rtype: str
77
+ """
70
78
  return self._Image
71
79
 
72
80
  @Image.setter
@@ -75,6 +83,14 @@ Different algorithm model versions correspond to different face recognition algo
75
83
 
76
84
  @property
77
85
  def Url(self):
86
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
87
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
88
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
89
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
90
+ The download speed and stability of non-Tencent Cloud URLs may be low.
91
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
92
+ :rtype: str
93
+ """
78
94
  return self._Url
79
95
 
80
96
  @Url.setter
@@ -83,6 +99,17 @@ Different algorithm model versions correspond to different face recognition algo
83
99
 
84
100
  @property
85
101
  def FaceModelVersion(self):
102
+ """Algorithm model version used by the Face Recognition service.
103
+
104
+ Currently, `2.0` and `3.0` are supported.
105
+
106
+ This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default.
107
+
108
+ The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020.
109
+
110
+ Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.
111
+ :rtype: str
112
+ """
86
113
  return self._FaceModelVersion
87
114
 
88
115
  @FaceModelVersion.setter
@@ -91,6 +118,9 @@ Different algorithm model versions correspond to different face recognition algo
91
118
 
92
119
  @property
93
120
  def NeedRotateDetection(self):
121
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
122
+ :rtype: int
123
+ """
94
124
  return self._NeedRotateDetection
95
125
 
96
126
  @NeedRotateDetection.setter
@@ -140,6 +170,9 @@ class AnalyzeFaceResponse(AbstractModel):
140
170
 
141
171
  @property
142
172
  def ImageWidth(self):
173
+ """Width of requested image.
174
+ :rtype: int
175
+ """
143
176
  return self._ImageWidth
144
177
 
145
178
  @ImageWidth.setter
@@ -148,6 +181,9 @@ class AnalyzeFaceResponse(AbstractModel):
148
181
 
149
182
  @property
150
183
  def ImageHeight(self):
184
+ """Height of requested image.
185
+ :rtype: int
186
+ """
151
187
  return self._ImageHeight
152
188
 
153
189
  @ImageHeight.setter
@@ -156,6 +192,9 @@ class AnalyzeFaceResponse(AbstractModel):
156
192
 
157
193
  @property
158
194
  def FaceShapeSet(self):
195
+ """Specific information of facial feature localization (facial keypoints).
196
+ :rtype: list of FaceShape
197
+ """
159
198
  return self._FaceShapeSet
160
199
 
161
200
  @FaceShapeSet.setter
@@ -164,6 +203,9 @@ class AnalyzeFaceResponse(AbstractModel):
164
203
 
165
204
  @property
166
205
  def FaceModelVersion(self):
206
+ """Algorithm model version used for face recognition.
207
+ :rtype: str
208
+ """
167
209
  return self._FaceModelVersion
168
210
 
169
211
  @FaceModelVersion.setter
@@ -172,6 +214,9 @@ class AnalyzeFaceResponse(AbstractModel):
172
214
 
173
215
  @property
174
216
  def RequestId(self):
217
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
218
+ :rtype: str
219
+ """
175
220
  return self._RequestId
176
221
 
177
222
  @RequestId.setter
@@ -209,6 +254,9 @@ class AttributeItem(AbstractModel):
209
254
 
210
255
  @property
211
256
  def Type(self):
257
+ """Attribute value
258
+ :rtype: int
259
+ """
212
260
  return self._Type
213
261
 
214
262
  @Type.setter
@@ -217,6 +265,9 @@ class AttributeItem(AbstractModel):
217
265
 
218
266
  @property
219
267
  def Probability(self):
268
+ """Probability of recognizing `Type`, which indicates the probability of correct recognition. Value range: [0,1].
269
+ :rtype: float
270
+ """
220
271
  return self._Probability
221
272
 
222
273
  @Probability.setter
@@ -275,6 +326,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
275
326
 
276
327
  @property
277
328
  def PersonId(self):
329
+ """Person ID
330
+ :rtype: str
331
+ """
278
332
  return self._PersonId
279
333
 
280
334
  @PersonId.setter
@@ -283,6 +337,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
283
337
 
284
338
  @property
285
339
  def FaceId(self):
340
+ """Face ID, which is valid only when returned by the `SearchFaces` or `SearchFacesReturnsByGroup` API. User search APIs use facial feature fusion to search for users, for which this field is meaningless.
341
+ :rtype: str
342
+ """
286
343
  return self._FaceId
287
344
 
288
345
  @FaceId.setter
@@ -291,6 +348,15 @@ Note: this field may return null, indicating that no valid values can be obtaine
291
348
 
292
349
  @property
293
350
  def Score(self):
351
+ """Match score of candidate.
352
+
353
+ In a face base library containing 10,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 70, 80, and 90, respectively;
354
+ In a face base library containing 100,000 faces, the 1%, 0.1%, and 0.01% FARs correspond to scores of 80, 90, and 100, respectively;
355
+ In a face base library containing 300,000 faces, the 1% and 0.1% FARs correspond to scores of 85 and 95, respectively.
356
+
357
+ Generally, the score of 80 is suitable for most scenarios. We recommend choosing an appropriate score based on the actual situation, preferably no more than 90.
358
+ :rtype: float
359
+ """
294
360
  return self._Score
295
361
 
296
362
  @Score.setter
@@ -299,6 +365,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
299
365
 
300
366
  @property
301
367
  def PersonName(self):
368
+ """Person name
369
+ Note: this field may return null, indicating that no valid values can be obtained.
370
+ :rtype: str
371
+ """
302
372
  return self._PersonName
303
373
 
304
374
  @PersonName.setter
@@ -307,6 +377,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
307
377
 
308
378
  @property
309
379
  def Gender(self):
380
+ """Person gender
381
+ Note: this field may return null, indicating that no valid values can be obtained.
382
+ :rtype: int
383
+ """
310
384
  return self._Gender
311
385
 
312
386
  @Gender.setter
@@ -315,6 +389,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
315
389
 
316
390
  @property
317
391
  def PersonGroupInfos(self):
392
+ """List of groups containing this person and their description fields
393
+ Note: this field may return null, indicating that no valid values can be obtained.
394
+ :rtype: list of PersonGroupInfo
395
+ """
318
396
  return self._PersonGroupInfos
319
397
 
320
398
  @PersonGroupInfos.setter
@@ -409,6 +487,12 @@ If the image quality does not meet the requirement, the returned result will pro
409
487
 
410
488
  @property
411
489
  def ImageA(self):
490
+ """Base64-encoded data of image A, which cannot exceed 5 MB.
491
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
492
+ If there are multiple faces in the image, only the face with the largest size will be selected.
493
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
494
+ :rtype: str
495
+ """
412
496
  return self._ImageA
413
497
 
414
498
  @ImageA.setter
@@ -417,6 +501,12 @@ If the image quality does not meet the requirement, the returned result will pro
417
501
 
418
502
  @property
419
503
  def ImageB(self):
504
+ """Base64-encoded data of image B, which cannot exceed 5 MB.
505
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
506
+ If there are multiple faces in the image, only the face with the largest size will be selected.
507
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
508
+ :rtype: str
509
+ """
420
510
  return self._ImageB
421
511
 
422
512
  @ImageB.setter
@@ -425,6 +515,15 @@ If the image quality does not meet the requirement, the returned result will pro
425
515
 
426
516
  @property
427
517
  def UrlA(self):
518
+ """URL of image A. The image cannot exceed 5 MB in size after being Base64-encoded.
519
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
520
+ Either `Url` or `Image` of image A must be provided; if both are provided, only `Url` will be used.
521
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
522
+ The download speed and stability of non-Tencent Cloud URLs may be low.
523
+ If there are multiple faces in the image, only the face with the largest size will be selected.
524
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
525
+ :rtype: str
526
+ """
428
527
  return self._UrlA
429
528
 
430
529
  @UrlA.setter
@@ -433,6 +532,15 @@ If the image quality does not meet the requirement, the returned result will pro
433
532
 
434
533
  @property
435
534
  def UrlB(self):
535
+ """URL of image B. The image cannot exceed 5 MB in size after being Base64-encoded.
536
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
537
+ Either `Url` or `Image` of image B must be provided; if both are provided, only `Url` will be used.
538
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
539
+ The download speed and stability of non-Tencent Cloud URLs may be low.
540
+ If there are multiple faces in the image, only the face with the largest size will be selected.
541
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
542
+ :rtype: str
543
+ """
436
544
  return self._UrlB
437
545
 
438
546
  @UrlB.setter
@@ -441,6 +549,17 @@ If the image quality does not meet the requirement, the returned result will pro
441
549
 
442
550
  @property
443
551
  def FaceModelVersion(self):
552
+ """Algorithm model version used by the Face Recognition service.
553
+
554
+ Currently, `2.0` and `3.0` are supported.
555
+
556
+ This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default.
557
+
558
+ The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020.
559
+
560
+ Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.
561
+ :rtype: str
562
+ """
444
563
  return self._FaceModelVersion
445
564
 
446
565
  @FaceModelVersion.setter
@@ -449,6 +568,16 @@ If the image quality does not meet the requirement, the returned result will pro
449
568
 
450
569
  @property
451
570
  def QualityControl(self):
571
+ """Image quality control.
572
+ 0: no control.
573
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
574
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
575
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
576
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
577
+ Default value: 0.
578
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
579
+ :rtype: int
580
+ """
452
581
  return self._QualityControl
453
582
 
454
583
  @QualityControl.setter
@@ -457,6 +586,9 @@ If the image quality does not meet the requirement, the returned result will pro
457
586
 
458
587
  @property
459
588
  def NeedRotateDetection(self):
589
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
590
+ :rtype: int
591
+ """
460
592
  return self._NeedRotateDetection
461
593
 
462
594
  @NeedRotateDetection.setter
@@ -506,6 +638,13 @@ If you need to verify whether the faces in the two images are the same person, w
506
638
 
507
639
  @property
508
640
  def Score(self):
641
+ """Face similarity score between two images.
642
+ The returned similarity score varies by algorithm version.
643
+ If you need to verify whether the faces in the two images are the same person, then the 0.1%, 0.01%, and 0.001% FARs on v3.0 correspond to scores of 40, 50, and 60, respectively. Generally, if the score is above 50, it can be judged that they are the same person.
644
+ The 0.1%, 0.01%, and 0.001% FARs on v2.0 correspond to scores of 70, 80, and 90, respectively. Generally, if the score is above 80, it can be judged that they are the same person.
645
+ If you need to verify whether the faces in the two images are the same person, we recommend using the `VerifyFace` API.
646
+ :rtype: float
647
+ """
509
648
  return self._Score
510
649
 
511
650
  @Score.setter
@@ -514,6 +653,9 @@ If you need to verify whether the faces in the two images are the same person, w
514
653
 
515
654
  @property
516
655
  def FaceModelVersion(self):
656
+ """Algorithm model version used for face recognition.
657
+ :rtype: str
658
+ """
517
659
  return self._FaceModelVersion
518
660
 
519
661
  @FaceModelVersion.setter
@@ -522,6 +664,9 @@ If you need to verify whether the faces in the two images are the same person, w
522
664
 
523
665
  @property
524
666
  def RequestId(self):
667
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
668
+ :rtype: str
669
+ """
525
670
  return self._RequestId
526
671
 
527
672
  @RequestId.setter
@@ -552,6 +697,9 @@ class CopyPersonRequest(AbstractModel):
552
697
 
553
698
  @property
554
699
  def PersonId(self):
700
+ """Person ID, which is the `PersonId` in the `CreatePerson` API.
701
+ :rtype: str
702
+ """
555
703
  return self._PersonId
556
704
 
557
705
  @PersonId.setter
@@ -560,6 +708,9 @@ class CopyPersonRequest(AbstractModel):
560
708
 
561
709
  @property
562
710
  def GroupIds(self):
711
+ """List of groups to join. The array element value is the `GroupId` in the `CreateGroup` API.
712
+ :rtype: list of str
713
+ """
563
714
  return self._GroupIds
564
715
 
565
716
  @GroupIds.setter
@@ -600,6 +751,9 @@ class CopyPersonResponse(AbstractModel):
600
751
 
601
752
  @property
602
753
  def SucGroupNum(self):
754
+ """Number of groups successfully added to.
755
+ :rtype: int
756
+ """
603
757
  return self._SucGroupNum
604
758
 
605
759
  @SucGroupNum.setter
@@ -608,6 +762,9 @@ class CopyPersonResponse(AbstractModel):
608
762
 
609
763
  @property
610
764
  def SucGroupIds(self):
765
+ """List of groups successfully added to.
766
+ :rtype: list of str
767
+ """
611
768
  return self._SucGroupIds
612
769
 
613
770
  @SucGroupIds.setter
@@ -616,6 +773,9 @@ class CopyPersonResponse(AbstractModel):
616
773
 
617
774
  @property
618
775
  def RequestId(self):
776
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
777
+ :rtype: str
778
+ """
619
779
  return self._RequestId
620
780
 
621
781
  @RequestId.setter
@@ -677,6 +837,9 @@ If the image quality does not meet the requirement, the returned result will pro
677
837
 
678
838
  @property
679
839
  def PersonId(self):
840
+ """Person ID, which is the `PersonId` in the `CreatePerson` API.
841
+ :rtype: str
842
+ """
680
843
  return self._PersonId
681
844
 
682
845
  @PersonId.setter
@@ -685,6 +848,13 @@ If the image quality does not meet the requirement, the returned result will pro
685
848
 
686
849
  @property
687
850
  def Images(self):
851
+ """Base64-encoded image data, which cannot exceed 5 MB.
852
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
853
+ A person can have up to 5 face images.
854
+ If there are multiple faces in the image, only the face with the largest size will be selected.
855
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
856
+ :rtype: list of str
857
+ """
688
858
  return self._Images
689
859
 
690
860
  @Images.setter
@@ -693,6 +863,16 @@ If the image quality does not meet the requirement, the returned result will pro
693
863
 
694
864
  @property
695
865
  def Urls(self):
866
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
867
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
868
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
869
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
870
+ The download speed and stability of non-Tencent Cloud URLs may be low.
871
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
872
+ A person can have up to 5 face images.
873
+ If there are multiple faces in the image, only the face with the largest size will be selected.
874
+ :rtype: list of str
875
+ """
696
876
  return self._Urls
697
877
 
698
878
  @Urls.setter
@@ -701,6 +881,10 @@ If the image quality does not meet the requirement, the returned result will pro
701
881
 
702
882
  @property
703
883
  def FaceMatchThreshold(self):
884
+ """Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully.
885
+ Default value: 60. Value range: [0,100].
886
+ :rtype: float
887
+ """
704
888
  return self._FaceMatchThreshold
705
889
 
706
890
  @FaceMatchThreshold.setter
@@ -709,6 +893,16 @@ If the image quality does not meet the requirement, the returned result will pro
709
893
 
710
894
  @property
711
895
  def QualityControl(self):
896
+ """Image quality control.
897
+ 0: no control.
898
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
899
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
900
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
901
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
902
+ Default value: 0.
903
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
904
+ :rtype: int
905
+ """
712
906
  return self._QualityControl
713
907
 
714
908
  @QualityControl.setter
@@ -717,6 +911,9 @@ If the image quality does not meet the requirement, the returned result will pro
717
911
 
718
912
  @property
719
913
  def NeedRotateDetection(self):
914
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
915
+ :rtype: int
916
+ """
720
917
  return self._NeedRotateDetection
721
918
 
722
919
  @NeedRotateDetection.setter
@@ -777,6 +974,9 @@ For example, if there are 3 URLs in `Urls`, and the second URL fails, then the v
777
974
 
778
975
  @property
779
976
  def SucFaceNum(self):
977
+ """Number of successfully added faces
978
+ :rtype: int
979
+ """
780
980
  return self._SucFaceNum
781
981
 
782
982
  @SucFaceNum.setter
@@ -785,6 +985,9 @@ For example, if there are 3 URLs in `Urls`, and the second URL fails, then the v
785
985
 
786
986
  @property
787
987
  def SucFaceIds(self):
988
+ """List of IDs of successfully added faces
989
+ :rtype: list of str
990
+ """
788
991
  return self._SucFaceIds
789
992
 
790
993
  @SucFaceIds.setter
@@ -793,6 +996,12 @@ For example, if there are 3 URLs in `Urls`, and the second URL fails, then the v
793
996
 
794
997
  @property
795
998
  def RetCode(self):
999
+ """Adding result for each face image. -1101: no face detected; -1102: image decoding failed;
1000
+ -1601: the image quality control requirement is not met; -1604: the face similarity is not above `FaceMatchThreshold`.
1001
+ Other non-zero values: algorithm service exception.
1002
+ The order of `RetCode` values is the same as the order of `Images` or `Urls` in the input parameter.
1003
+ :rtype: list of int
1004
+ """
796
1005
  return self._RetCode
797
1006
 
798
1007
  @RetCode.setter
@@ -801,6 +1010,10 @@ For example, if there are 3 URLs in `Urls`, and the second URL fails, then the v
801
1010
 
802
1011
  @property
803
1012
  def SucIndexes(self):
1013
+ """Indexes of successfully added faces. The order of indexes is the same as the order of `Images` or `Urls` in the input parameter.
1014
+ For example, if there are 3 URLs in `Urls`, and the second URL fails, then the value of `SucIndexes` will be [0,2].
1015
+ :rtype: list of int non-negative
1016
+ """
804
1017
  return self._SucIndexes
805
1018
 
806
1019
  @SucIndexes.setter
@@ -809,6 +1022,9 @@ For example, if there are 3 URLs in `Urls`, and the second URL fails, then the v
809
1022
 
810
1023
  @property
811
1024
  def SucFaceRects(self):
1025
+ """Frame positions of successfully added faces. The order is the same as the order of `Images` or `Urls` in the input parameter.
1026
+ :rtype: list of FaceRect
1027
+ """
812
1028
  return self._SucFaceRects
813
1029
 
814
1030
  @SucFaceRects.setter
@@ -817,6 +1033,9 @@ For example, if there are 3 URLs in `Urls`, and the second URL fails, then the v
817
1033
 
818
1034
  @property
819
1035
  def FaceModelVersion(self):
1036
+ """Algorithm model version used for face recognition.
1037
+ :rtype: str
1038
+ """
820
1039
  return self._FaceModelVersion
821
1040
 
822
1041
  @FaceModelVersion.setter
@@ -825,6 +1044,9 @@ For example, if there are 3 URLs in `Urls`, and the second URL fails, then the v
825
1044
 
826
1045
  @property
827
1046
  def RequestId(self):
1047
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1048
+ :rtype: str
1049
+ """
828
1050
  return self._RequestId
829
1051
 
830
1052
  @RequestId.setter
@@ -887,6 +1109,9 @@ Different algorithm model versions correspond to different face recognition algo
887
1109
 
888
1110
  @property
889
1111
  def GroupName(self):
1112
+ """Group name, which is modifiable, must be unique, and can contain 1 to 60 characters.
1113
+ :rtype: str
1114
+ """
890
1115
  return self._GroupName
891
1116
 
892
1117
  @GroupName.setter
@@ -895,6 +1120,9 @@ Different algorithm model versions correspond to different face recognition algo
895
1120
 
896
1121
  @property
897
1122
  def GroupId(self):
1123
+ """Group ID, which is unmodifiable, must be unique, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.
1124
+ :rtype: str
1125
+ """
898
1126
  return self._GroupId
899
1127
 
900
1128
  @GroupId.setter
@@ -903,6 +1131,15 @@ Different algorithm model versions correspond to different face recognition algo
903
1131
 
904
1132
  @property
905
1133
  def GroupExDescriptions(self):
1134
+ """Custom group description field that describes the person attributes in the group, which will be applied to all persons in the group.
1135
+ Up to 5 ones can be created.
1136
+ Each custom description field can contain 1 to 30 characters.
1137
+ The custom description field must be unique in the group.
1138
+ Example: if you set the "custom description field" of a group to ["student ID","employee ID","mobile number"],
1139
+ then all the persons in the group will have description fields named "student ID", "employee ID", and "mobile number".
1140
+ You can enter content in the corresponding field to register a person's student ID, employee ID, and mobile number.
1141
+ :rtype: list of str
1142
+ """
906
1143
  return self._GroupExDescriptions
907
1144
 
908
1145
  @GroupExDescriptions.setter
@@ -911,6 +1148,9 @@ Different algorithm model versions correspond to different face recognition algo
911
1148
 
912
1149
  @property
913
1150
  def Tag(self):
1151
+ """Group remarks, which can contain 0 to 40 characters.
1152
+ :rtype: str
1153
+ """
914
1154
  return self._Tag
915
1155
 
916
1156
  @Tag.setter
@@ -919,6 +1159,17 @@ Different algorithm model versions correspond to different face recognition algo
919
1159
 
920
1160
  @property
921
1161
  def FaceModelVersion(self):
1162
+ """Algorithm model version used by the Face Recognition service.
1163
+
1164
+ Currently, `2.0` and `3.0` are supported.
1165
+
1166
+ This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default.
1167
+
1168
+ The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020.
1169
+
1170
+ Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.
1171
+ :rtype: str
1172
+ """
922
1173
  return self._FaceModelVersion
923
1174
 
924
1175
  @FaceModelVersion.setter
@@ -959,6 +1210,9 @@ class CreateGroupResponse(AbstractModel):
959
1210
 
960
1211
  @property
961
1212
  def FaceModelVersion(self):
1213
+ """Algorithm model version used for face recognition.
1214
+ :rtype: str
1215
+ """
962
1216
  return self._FaceModelVersion
963
1217
 
964
1218
  @FaceModelVersion.setter
@@ -967,6 +1221,9 @@ class CreateGroupResponse(AbstractModel):
967
1221
 
968
1222
  @property
969
1223
  def RequestId(self):
1224
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1225
+ :rtype: str
1226
+ """
970
1227
  return self._RequestId
971
1228
 
972
1229
  @RequestId.setter
@@ -1043,6 +1300,9 @@ If the image quality does not meet the requirement, the returned result will pro
1043
1300
 
1044
1301
  @property
1045
1302
  def GroupId(self):
1303
+ """ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
1304
+ :rtype: str
1305
+ """
1046
1306
  return self._GroupId
1047
1307
 
1048
1308
  @GroupId.setter
@@ -1051,6 +1311,9 @@ If the image quality does not meet the requirement, the returned result will pro
1051
1311
 
1052
1312
  @property
1053
1313
  def PersonName(self):
1314
+ """Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
1315
+ :rtype: str
1316
+ """
1054
1317
  return self._PersonName
1055
1318
 
1056
1319
  @PersonName.setter
@@ -1059,6 +1322,9 @@ If the image quality does not meet the requirement, the returned result will pro
1059
1322
 
1060
1323
  @property
1061
1324
  def PersonId(self):
1325
+ """Person ID, which is unmodifiable, must be unique under a Tencent Cloud account, and can contain letters, digits, and special symbols (-%@#&_) of up to 64 B.
1326
+ :rtype: str
1327
+ """
1062
1328
  return self._PersonId
1063
1329
 
1064
1330
  @PersonId.setter
@@ -1067,6 +1333,9 @@ If the image quality does not meet the requirement, the returned result will pro
1067
1333
 
1068
1334
  @property
1069
1335
  def Gender(self):
1336
+ """0: empty; 1: male; 2: female.
1337
+ :rtype: int
1338
+ """
1070
1339
  return self._Gender
1071
1340
 
1072
1341
  @Gender.setter
@@ -1075,6 +1344,9 @@ If the image quality does not meet the requirement, the returned result will pro
1075
1344
 
1076
1345
  @property
1077
1346
  def PersonExDescriptionInfos(self):
1347
+ """Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
1348
+ :rtype: list of PersonExDescriptionInfo
1349
+ """
1078
1350
  return self._PersonExDescriptionInfos
1079
1351
 
1080
1352
  @PersonExDescriptionInfos.setter
@@ -1083,6 +1355,11 @@ If the image quality does not meet the requirement, the returned result will pro
1083
1355
 
1084
1356
  @property
1085
1357
  def Image(self):
1358
+ """Base64-encoded image data, which cannot exceed 5 MB.
1359
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
1360
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
1361
+ :rtype: str
1362
+ """
1086
1363
  return self._Image
1087
1364
 
1088
1365
  @Image.setter
@@ -1091,6 +1368,14 @@ If the image quality does not meet the requirement, the returned result will pro
1091
1368
 
1092
1369
  @property
1093
1370
  def Url(self):
1371
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
1372
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
1373
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
1374
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
1375
+ The download speed and stability of non-Tencent Cloud URLs may be low.
1376
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
1377
+ :rtype: str
1378
+ """
1094
1379
  return self._Url
1095
1380
 
1096
1381
  @Url.setter
@@ -1099,6 +1384,18 @@ If the image quality does not meet the requirement, the returned result will pro
1099
1384
 
1100
1385
  @property
1101
1386
  def UniquePersonControl(self):
1387
+ """This parameter is used to control the judgment whether the face contained in the image in `Image` or `Url` corresponds to an existing person in the group.
1388
+ If it is judged that a duplicate person exists in the group, no new person will be created, and information of the suspected duplicate person will be returned.
1389
+ Otherwise, the new person will be created.
1390
+ 0: do not judge, i.e., the person will be created no matter whether a duplicate person exists in the group.
1391
+ 1: low duplicate person judgment requirement (1% FAR);
1392
+ 2: average duplicate person judgment requirement (0.1% FAR);
1393
+ 3: high duplicate person judgment requirement (0.01% FAR);
1394
+ 4: very high duplicate person judgment requirement (0.001% FAR).
1395
+ Default value: 0.
1396
+ Note: the higher the requirement, the lower the probability of duplicate person. The FARs corresponding to different requirements are for reference only and can be adjusted as needed.
1397
+ :rtype: int
1398
+ """
1102
1399
  return self._UniquePersonControl
1103
1400
 
1104
1401
  @UniquePersonControl.setter
@@ -1107,6 +1404,16 @@ If the image quality does not meet the requirement, the returned result will pro
1107
1404
 
1108
1405
  @property
1109
1406
  def QualityControl(self):
1407
+ """Image quality control.
1408
+ 0: no control.
1409
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
1410
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
1411
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
1412
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
1413
+ Default value: 0.
1414
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
1415
+ :rtype: int
1416
+ """
1110
1417
  return self._QualityControl
1111
1418
 
1112
1419
  @QualityControl.setter
@@ -1115,6 +1422,9 @@ If the image quality does not meet the requirement, the returned result will pro
1115
1422
 
1116
1423
  @property
1117
1424
  def NeedRotateDetection(self):
1425
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
1426
+ :rtype: int
1427
+ """
1118
1428
  return self._NeedRotateDetection
1119
1429
 
1120
1430
  @NeedRotateDetection.setter
@@ -1176,6 +1486,9 @@ This parameter is meaningful only if the `UniquePersonControl` parameter is not
1176
1486
 
1177
1487
  @property
1178
1488
  def FaceId(self):
1489
+ """Unique ID of face image.
1490
+ :rtype: str
1491
+ """
1179
1492
  return self._FaceId
1180
1493
 
1181
1494
  @FaceId.setter
@@ -1184,6 +1497,10 @@ This parameter is meaningful only if the `UniquePersonControl` parameter is not
1184
1497
 
1185
1498
  @property
1186
1499
  def FaceRect(self):
1500
+ """Position of detected face frame.
1501
+ Note: this field may return null, indicating that no valid values can be obtained.
1502
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceRect`
1503
+ """
1187
1504
  return self._FaceRect
1188
1505
 
1189
1506
  @FaceRect.setter
@@ -1192,6 +1509,10 @@ This parameter is meaningful only if the `UniquePersonControl` parameter is not
1192
1509
 
1193
1510
  @property
1194
1511
  def SimilarPersonId(self):
1512
+ """`PersonId` of suspected duplicate person.
1513
+ This parameter is meaningful only if the `UniquePersonControl` parameter is not 0 and there is a suspected duplicate person in the group.
1514
+ :rtype: str
1515
+ """
1195
1516
  return self._SimilarPersonId
1196
1517
 
1197
1518
  @SimilarPersonId.setter
@@ -1200,6 +1521,9 @@ This parameter is meaningful only if the `UniquePersonControl` parameter is not
1200
1521
 
1201
1522
  @property
1202
1523
  def FaceModelVersion(self):
1524
+ """Algorithm model version used for face recognition.
1525
+ :rtype: str
1526
+ """
1203
1527
  return self._FaceModelVersion
1204
1528
 
1205
1529
  @FaceModelVersion.setter
@@ -1208,6 +1532,9 @@ This parameter is meaningful only if the `UniquePersonControl` parameter is not
1208
1532
 
1209
1533
  @property
1210
1534
  def RequestId(self):
1535
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1536
+ :rtype: str
1537
+ """
1211
1538
  return self._RequestId
1212
1539
 
1213
1540
  @RequestId.setter
@@ -1242,6 +1569,9 @@ class DeleteFaceRequest(AbstractModel):
1242
1569
 
1243
1570
  @property
1244
1571
  def PersonId(self):
1572
+ """Person ID, which is the `PersonId` in the `CreatePerson` API.
1573
+ :rtype: str
1574
+ """
1245
1575
  return self._PersonId
1246
1576
 
1247
1577
  @PersonId.setter
@@ -1250,6 +1580,9 @@ class DeleteFaceRequest(AbstractModel):
1250
1580
 
1251
1581
  @property
1252
1582
  def FaceIds(self):
1583
+ """List of IDs of the faces to be deleted. The array element value is the `FaceId` returned by the `CreateFace` API.
1584
+ :rtype: list of str
1585
+ """
1253
1586
  return self._FaceIds
1254
1587
 
1255
1588
  @FaceIds.setter
@@ -1290,6 +1623,9 @@ class DeleteFaceResponse(AbstractModel):
1290
1623
 
1291
1624
  @property
1292
1625
  def SucDeletedNum(self):
1626
+ """Number of successfully deleted faces
1627
+ :rtype: int
1628
+ """
1293
1629
  return self._SucDeletedNum
1294
1630
 
1295
1631
  @SucDeletedNum.setter
@@ -1298,6 +1634,9 @@ class DeleteFaceResponse(AbstractModel):
1298
1634
 
1299
1635
  @property
1300
1636
  def SucFaceIds(self):
1637
+ """List of IDs of successfully deleted faces
1638
+ :rtype: list of str
1639
+ """
1301
1640
  return self._SucFaceIds
1302
1641
 
1303
1642
  @SucFaceIds.setter
@@ -1306,6 +1645,9 @@ class DeleteFaceResponse(AbstractModel):
1306
1645
 
1307
1646
  @property
1308
1647
  def RequestId(self):
1648
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1649
+ :rtype: str
1650
+ """
1309
1651
  return self._RequestId
1310
1652
 
1311
1653
  @RequestId.setter
@@ -1333,6 +1675,9 @@ class DeleteGroupRequest(AbstractModel):
1333
1675
 
1334
1676
  @property
1335
1677
  def GroupId(self):
1678
+ """Group ID, which is the `GroupId` in the `CreateGroup` API.
1679
+ :rtype: str
1680
+ """
1336
1681
  return self._GroupId
1337
1682
 
1338
1683
  @GroupId.setter
@@ -1366,6 +1711,9 @@ class DeleteGroupResponse(AbstractModel):
1366
1711
 
1367
1712
  @property
1368
1713
  def RequestId(self):
1714
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1715
+ :rtype: str
1716
+ """
1369
1717
  return self._RequestId
1370
1718
 
1371
1719
  @RequestId.setter
@@ -1394,6 +1742,9 @@ class DeletePersonFromGroupRequest(AbstractModel):
1394
1742
 
1395
1743
  @property
1396
1744
  def PersonId(self):
1745
+ """Person ID, which is the `PersonId` in the `CreatePerson` API.
1746
+ :rtype: str
1747
+ """
1397
1748
  return self._PersonId
1398
1749
 
1399
1750
  @PersonId.setter
@@ -1402,6 +1753,9 @@ class DeletePersonFromGroupRequest(AbstractModel):
1402
1753
 
1403
1754
  @property
1404
1755
  def GroupId(self):
1756
+ """Group ID, which is the `GroupId` in the `CreateGroup` API.
1757
+ :rtype: str
1758
+ """
1405
1759
  return self._GroupId
1406
1760
 
1407
1761
  @GroupId.setter
@@ -1436,6 +1790,9 @@ class DeletePersonFromGroupResponse(AbstractModel):
1436
1790
 
1437
1791
  @property
1438
1792
  def RequestId(self):
1793
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1794
+ :rtype: str
1795
+ """
1439
1796
  return self._RequestId
1440
1797
 
1441
1798
  @RequestId.setter
@@ -1461,6 +1818,9 @@ class DeletePersonRequest(AbstractModel):
1461
1818
 
1462
1819
  @property
1463
1820
  def PersonId(self):
1821
+ """Person ID, which is the `PersonId` in the `CreatePerson` API.
1822
+ :rtype: str
1823
+ """
1464
1824
  return self._PersonId
1465
1825
 
1466
1826
  @PersonId.setter
@@ -1494,6 +1854,9 @@ class DeletePersonResponse(AbstractModel):
1494
1854
 
1495
1855
  @property
1496
1856
  def RequestId(self):
1857
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1858
+ :rtype: str
1859
+ """
1497
1860
  return self._RequestId
1498
1861
 
1499
1862
  @RequestId.setter
@@ -1550,6 +1913,11 @@ The face attribute information of up to 5 largest faces in the image will be ret
1550
1913
 
1551
1914
  @property
1552
1915
  def MaxFaceNum(self):
1916
+ """Maximum number of processable faces.
1917
+ Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 120.
1918
+ This parameter is used to control the number of faces in the image to be detected. The smaller the value, the faster the processing.
1919
+ :rtype: int
1920
+ """
1553
1921
  return self._MaxFaceNum
1554
1922
 
1555
1923
  @MaxFaceNum.setter
@@ -1558,6 +1926,11 @@ The face attribute information of up to 5 largest faces in the image will be ret
1558
1926
 
1559
1927
  @property
1560
1928
  def Image(self):
1929
+ """Base64-encoded image data, which cannot exceed 5 MB.
1930
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
1931
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
1932
+ :rtype: str
1933
+ """
1561
1934
  return self._Image
1562
1935
 
1563
1936
  @Image.setter
@@ -1566,6 +1939,15 @@ The face attribute information of up to 5 largest faces in the image will be ret
1566
1939
 
1567
1940
  @property
1568
1941
  def Url(self):
1942
+ """Image URL.
1943
+ The image cannot exceed 5 MB in size after being Base64-encoded.
1944
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
1945
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
1946
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
1947
+ The download speed and stability of non-Tencent Cloud URLs may be low.
1948
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
1949
+ :rtype: str
1950
+ """
1569
1951
  return self._Url
1570
1952
 
1571
1953
  @Url.setter
@@ -1574,6 +1956,15 @@ The face attribute information of up to 5 largest faces in the image will be ret
1574
1956
 
1575
1957
  @property
1576
1958
  def FaceAttributesType(self):
1959
+ """Whether to return attributes such as age, gender, and emotion.
1960
+ Valid values (case-insensitive): None, Age, Beauty, Emotion, Eye, Eyebrow, Gender, Hair, Hat, Headpose, Mask, Mouth, Moustache, Nose, Shape, Skin, Smile.
1961
+
1962
+ `None` indicates that no attributes need to be returned, which is the default value; that is, if the `FaceAttributesType` attribute is empty, the values of all attributes will be `0`.
1963
+ You need to combine the attributes into a string and separate them by comma. The sequence of the attributes is not limited.
1964
+ For more information on the attributes, see the output parameters as described below.
1965
+ The face attribute information of up to 5 largest faces in the image will be returned, and `AttributesInfo` of the 6th and rest faces is meaningless.
1966
+ :rtype: str
1967
+ """
1577
1968
  return self._FaceAttributesType
1578
1969
 
1579
1970
  @FaceAttributesType.setter
@@ -1582,6 +1973,9 @@ The face attribute information of up to 5 largest faces in the image will be ret
1582
1973
 
1583
1974
  @property
1584
1975
  def NeedRotateDetection(self):
1976
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image is not rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
1977
+ :rtype: int
1978
+ """
1585
1979
  return self._NeedRotateDetection
1586
1980
 
1587
1981
  @NeedRotateDetection.setter
@@ -1590,6 +1984,9 @@ The face attribute information of up to 5 largest faces in the image will be ret
1590
1984
 
1591
1985
  @property
1592
1986
  def FaceModelVersion(self):
1987
+ """Algorithm model version used by the Face Recognition service. You can enter only `3.0` for this API.
1988
+ :rtype: str
1989
+ """
1593
1990
  return self._FaceModelVersion
1594
1991
 
1595
1992
  @FaceModelVersion.setter
@@ -1640,6 +2037,9 @@ class DetectFaceAttributesResponse(AbstractModel):
1640
2037
 
1641
2038
  @property
1642
2039
  def ImageWidth(self):
2040
+ """Width of requested image.
2041
+ :rtype: int
2042
+ """
1643
2043
  return self._ImageWidth
1644
2044
 
1645
2045
  @ImageWidth.setter
@@ -1648,6 +2048,9 @@ class DetectFaceAttributesResponse(AbstractModel):
1648
2048
 
1649
2049
  @property
1650
2050
  def ImageHeight(self):
2051
+ """Height of requested image.
2052
+ :rtype: int
2053
+ """
1651
2054
  return self._ImageHeight
1652
2055
 
1653
2056
  @ImageHeight.setter
@@ -1656,6 +2059,9 @@ class DetectFaceAttributesResponse(AbstractModel):
1656
2059
 
1657
2060
  @property
1658
2061
  def FaceDetailInfos(self):
2062
+ """Face information list.
2063
+ :rtype: list of FaceDetailInfo
2064
+ """
1659
2065
  return self._FaceDetailInfos
1660
2066
 
1661
2067
  @FaceDetailInfos.setter
@@ -1664,6 +2070,9 @@ class DetectFaceAttributesResponse(AbstractModel):
1664
2070
 
1665
2071
  @property
1666
2072
  def FaceModelVersion(self):
2073
+ """Algorithm model version used for face recognition.
2074
+ :rtype: str
2075
+ """
1667
2076
  return self._FaceModelVersion
1668
2077
 
1669
2078
  @FaceModelVersion.setter
@@ -1672,6 +2081,9 @@ class DetectFaceAttributesResponse(AbstractModel):
1672
2081
 
1673
2082
  @property
1674
2083
  def RequestId(self):
2084
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2085
+ :rtype: str
2086
+ """
1675
2087
  return self._RequestId
1676
2088
 
1677
2089
  @RequestId.setter
@@ -1751,6 +2163,10 @@ Different algorithm model versions correspond to different face recognition algo
1751
2163
 
1752
2164
  @property
1753
2165
  def MaxFaceNum(self):
2166
+ """Maximum number of processable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 120.
2167
+ This parameter is used to control the number of faces in the image to be detected. The smaller the value, the faster the processing.
2168
+ :rtype: int
2169
+ """
1754
2170
  return self._MaxFaceNum
1755
2171
 
1756
2172
  @MaxFaceNum.setter
@@ -1759,6 +2175,11 @@ Different algorithm model versions correspond to different face recognition algo
1759
2175
 
1760
2176
  @property
1761
2177
  def MinFaceSize(self):
2178
+ """Minimum height and width of face in px.
2179
+ Default value: 34. We recommend keeping it at or above 34.
2180
+ Faces below the `MinFaceSize` value will not be detected.
2181
+ :rtype: int
2182
+ """
1762
2183
  return self._MinFaceSize
1763
2184
 
1764
2185
  @MinFaceSize.setter
@@ -1767,6 +2188,11 @@ Different algorithm model versions correspond to different face recognition algo
1767
2188
 
1768
2189
  @property
1769
2190
  def Image(self):
2191
+ """Base64-encoded image data, which cannot exceed 5 MB.
2192
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
2193
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
2194
+ :rtype: str
2195
+ """
1770
2196
  return self._Image
1771
2197
 
1772
2198
  @Image.setter
@@ -1775,6 +2201,14 @@ Different algorithm model versions correspond to different face recognition algo
1775
2201
 
1776
2202
  @property
1777
2203
  def Url(self):
2204
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
2205
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
2206
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
2207
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
2208
+ The download speed and stability of non-Tencent Cloud URLs may be low.
2209
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
2210
+ :rtype: str
2211
+ """
1778
2212
  return self._Url
1779
2213
 
1780
2214
  @Url.setter
@@ -1783,6 +2217,12 @@ Different algorithm model versions correspond to different face recognition algo
1783
2217
 
1784
2218
  @property
1785
2219
  def NeedFaceAttributes(self):
2220
+ """Whether the face attribute information (FaceAttributesInfo) needs to be returned. 0: no; 1: yes. Default value: 0.
2221
+ If the value is not 1, it will be deemed as no need to return, and `FaceAttributesInfo` is meaningless in this case.
2222
+ The face attribute information of up to 5 largest faces in the image will be returned, and `FaceAttributesInfo` of the 6th and rest faces is meaningless.
2223
+ Extracting face attribute information is quite time-consuming. If face attribute information is not required, we recommend disabling this feature to speed up face detection.
2224
+ :rtype: int
2225
+ """
1786
2226
  return self._NeedFaceAttributes
1787
2227
 
1788
2228
  @NeedFaceAttributes.setter
@@ -1791,6 +2231,12 @@ Different algorithm model versions correspond to different face recognition algo
1791
2231
 
1792
2232
  @property
1793
2233
  def NeedQualityDetection(self):
2234
+ """Whether to enable quality detection. 0: no; 1: yes. Default value: 0.
2235
+ If the value is not 1, it will be deemed not to perform quality detection.
2236
+ The face quality score information of up to 30 largest faces in the image will be returned, and `FaceQualityInfo` of the 31st and rest faces is meaningless.
2237
+ We recommend enabling this feature for the face adding operation.
2238
+ :rtype: int
2239
+ """
1794
2240
  return self._NeedQualityDetection
1795
2241
 
1796
2242
  @NeedQualityDetection.setter
@@ -1799,6 +2245,17 @@ Different algorithm model versions correspond to different face recognition algo
1799
2245
 
1800
2246
  @property
1801
2247
  def FaceModelVersion(self):
2248
+ """Algorithm model version used by the Face Recognition service.
2249
+
2250
+ Currently, `2.0` and `3.0` are supported.
2251
+
2252
+ This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default.
2253
+
2254
+ The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020.
2255
+
2256
+ Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.
2257
+ :rtype: str
2258
+ """
1802
2259
  return self._FaceModelVersion
1803
2260
 
1804
2261
  @FaceModelVersion.setter
@@ -1807,6 +2264,9 @@ Different algorithm model versions correspond to different face recognition algo
1807
2264
 
1808
2265
  @property
1809
2266
  def NeedRotateDetection(self):
2267
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
2268
+ :rtype: int
2269
+ """
1810
2270
  return self._NeedRotateDetection
1811
2271
 
1812
2272
  @NeedRotateDetection.setter
@@ -1859,6 +2319,9 @@ class DetectFaceResponse(AbstractModel):
1859
2319
 
1860
2320
  @property
1861
2321
  def ImageWidth(self):
2322
+ """Width of requested image.
2323
+ :rtype: int
2324
+ """
1862
2325
  return self._ImageWidth
1863
2326
 
1864
2327
  @ImageWidth.setter
@@ -1867,6 +2330,9 @@ class DetectFaceResponse(AbstractModel):
1867
2330
 
1868
2331
  @property
1869
2332
  def ImageHeight(self):
2333
+ """Height of requested image.
2334
+ :rtype: int
2335
+ """
1870
2336
  return self._ImageHeight
1871
2337
 
1872
2338
  @ImageHeight.setter
@@ -1875,6 +2341,9 @@ class DetectFaceResponse(AbstractModel):
1875
2341
 
1876
2342
  @property
1877
2343
  def FaceInfos(self):
2344
+ """Face information list, including face coordinate information, attribute information (if needed), and quality score information (if needed).
2345
+ :rtype: list of FaceInfo
2346
+ """
1878
2347
  return self._FaceInfos
1879
2348
 
1880
2349
  @FaceInfos.setter
@@ -1883,6 +2352,9 @@ class DetectFaceResponse(AbstractModel):
1883
2352
 
1884
2353
  @property
1885
2354
  def FaceModelVersion(self):
2355
+ """Algorithm model version used for face recognition.
2356
+ :rtype: str
2357
+ """
1886
2358
  return self._FaceModelVersion
1887
2359
 
1888
2360
  @FaceModelVersion.setter
@@ -1891,6 +2363,9 @@ class DetectFaceResponse(AbstractModel):
1891
2363
 
1892
2364
  @property
1893
2365
  def RequestId(self):
2366
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2367
+ :rtype: str
2368
+ """
1894
2369
  return self._RequestId
1895
2370
 
1896
2371
  @RequestId.setter
@@ -1941,6 +2416,13 @@ Supported image formats are PNG, JPG, JPEG, and BMP. GIF is currently not suppor
1941
2416
 
1942
2417
  @property
1943
2418
  def Image(self):
2419
+ """Base64-encoded image data, which cannot exceed 5 MB.
2420
+ The long side cannot exceed 4,000 px for images in .jpg format or 2,000 px for images in other formats.
2421
+ The recommended image aspect ratio is 3:4 (generally, the aspect ratio of images taken by mobile phones).
2422
+ The face must be greater than 100*100 px in size.
2423
+ Supported image formats are PNG, JPG, JPEG, and BMP. GIF is currently not supported.
2424
+ :rtype: str
2425
+ """
1944
2426
  return self._Image
1945
2427
 
1946
2428
  @Image.setter
@@ -1949,6 +2431,15 @@ Supported image formats are PNG, JPG, JPEG, and BMP. GIF is currently not suppor
1949
2431
 
1950
2432
  @property
1951
2433
  def Url(self):
2434
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
2435
+ The long side cannot exceed 4,000 px for images in .jpg format or 2,000 px for images in other formats.
2436
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
2437
+ The recommended image aspect ratio is 3:4 (generally, the aspect ratio of images taken by mobile phones).
2438
+ The face must be greater than 100*100 px in size.
2439
+ We recommend you store the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.
2440
+ Supported image formats are PNG, JPG, JPEG, and BMP. GIF is currently not supported.
2441
+ :rtype: str
2442
+ """
1952
2443
  return self._Url
1953
2444
 
1954
2445
  @Url.setter
@@ -1957,6 +2448,9 @@ Supported image formats are PNG, JPG, JPEG, and BMP. GIF is currently not suppor
1957
2448
 
1958
2449
  @property
1959
2450
  def FaceModelVersion(self):
2451
+ """Algorithm model version used for face recognition. Valid value: `3.0`.
2452
+ :rtype: str
2453
+ """
1960
2454
  return self._FaceModelVersion
1961
2455
 
1962
2456
  @FaceModelVersion.setter
@@ -1998,6 +2492,9 @@ class DetectLiveFaceAccurateResponse(AbstractModel):
1998
2492
 
1999
2493
  @property
2000
2494
  def Score(self):
2495
+ """Liveness score. Value range: [0, 100]. You can set several thresholds such as 5, 10, 40, 70 and 90 to determine whether the image is photographed. We recommend you use the threshold of 40.
2496
+ :rtype: float
2497
+ """
2001
2498
  return self._Score
2002
2499
 
2003
2500
  @Score.setter
@@ -2006,6 +2503,9 @@ class DetectLiveFaceAccurateResponse(AbstractModel):
2006
2503
 
2007
2504
  @property
2008
2505
  def FaceModelVersion(self):
2506
+ """Algorithm model version used for face recognition.
2507
+ :rtype: str
2508
+ """
2009
2509
  return self._FaceModelVersion
2010
2510
 
2011
2511
  @FaceModelVersion.setter
@@ -2014,6 +2514,9 @@ class DetectLiveFaceAccurateResponse(AbstractModel):
2014
2514
 
2015
2515
  @property
2016
2516
  def RequestId(self):
2517
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2518
+ :rtype: str
2519
+ """
2017
2520
  return self._RequestId
2018
2521
 
2019
2522
  @RequestId.setter
@@ -2063,6 +2566,11 @@ Different algorithm model versions correspond to different face recognition algo
2063
2566
 
2064
2567
  @property
2065
2568
  def Image(self):
2569
+ """Base64-encoded image data, which cannot exceed 5 MB.
2570
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats (the aspect ratio of the image should be close to 3:4 (width:height); otherwise, the score returned for the image will be meaningless).
2571
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
2572
+ :rtype: str
2573
+ """
2066
2574
  return self._Image
2067
2575
 
2068
2576
  @Image.setter
@@ -2071,6 +2579,15 @@ Different algorithm model versions correspond to different face recognition algo
2071
2579
 
2072
2580
  @property
2073
2581
  def Url(self):
2582
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
2583
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
2584
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
2585
+ (The aspect ratio of the image should be close to 3:4 (width:height); otherwise, the score returned for the image will be meaningless.)
2586
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
2587
+ The download speed and stability of non-Tencent Cloud URLs may be low.
2588
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
2589
+ :rtype: str
2590
+ """
2074
2591
  return self._Url
2075
2592
 
2076
2593
  @Url.setter
@@ -2079,6 +2596,17 @@ Different algorithm model versions correspond to different face recognition algo
2079
2596
 
2080
2597
  @property
2081
2598
  def FaceModelVersion(self):
2599
+ """Algorithm model version used by the Face Recognition service.
2600
+
2601
+ Currently, `2.0` and `3.0` are supported.
2602
+
2603
+ This parameter is `3.0` by default starting from April 2, 2020. If it is left empty for accounts that used this API, `2.0` will be used by default.
2604
+
2605
+ The parameter can be set only to `3.0` for accounts that purchase the service after November 26, 2020.
2606
+
2607
+ Different algorithm model versions correspond to different face recognition algorithms. The 3.0 version has a better overall effect than the legacy version and is recommended.
2608
+ :rtype: str
2609
+ """
2082
2610
  return self._FaceModelVersion
2083
2611
 
2084
2612
  @FaceModelVersion.setter
@@ -2125,6 +2653,10 @@ This field is meaningful only if `FaceModelVersion` is 3.0.
2125
2653
 
2126
2654
  @property
2127
2655
  def Score(self):
2656
+ """Liveness score. Value range: [0,100]. The score is generally between 80 and 100, but 0 is also a common value. As a recommendation, when the score is greater than 87, it can be judged that the person in the image is alive. You can adjust the threshold according to your specific scenario.
2657
+ This field is meaningful only if `FaceModelVersion` is 2.0.
2658
+ :rtype: float
2659
+ """
2128
2660
  return self._Score
2129
2661
 
2130
2662
  @Score.setter
@@ -2133,6 +2665,9 @@ This field is meaningful only if `FaceModelVersion` is 3.0.
2133
2665
 
2134
2666
  @property
2135
2667
  def FaceModelVersion(self):
2668
+ """Algorithm model version used for face recognition.
2669
+ :rtype: str
2670
+ """
2136
2671
  return self._FaceModelVersion
2137
2672
 
2138
2673
  @FaceModelVersion.setter
@@ -2141,6 +2676,10 @@ This field is meaningful only if `FaceModelVersion` is 3.0.
2141
2676
 
2142
2677
  @property
2143
2678
  def IsLiveness(self):
2679
+ """Whether liveness detection is passed.
2680
+ This field is meaningful only if `FaceModelVersion` is 3.0.
2681
+ :rtype: bool
2682
+ """
2144
2683
  return self._IsLiveness
2145
2684
 
2146
2685
  @IsLiveness.setter
@@ -2149,6 +2688,9 @@ This field is meaningful only if `FaceModelVersion` is 3.0.
2149
2688
 
2150
2689
  @property
2151
2690
  def RequestId(self):
2691
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
2692
+ :rtype: str
2693
+ """
2152
2694
  return self._RequestId
2153
2695
 
2154
2696
  @RequestId.setter
@@ -2190,6 +2732,10 @@ The `Type` values of the `AttributeItem` include: 0: small eyes; 1: general eyes
2190
2732
 
2191
2733
  @property
2192
2734
  def Glass(self):
2735
+ """Whether glasses are worn.
2736
+ The `Type` values of the `AttributeItem` include: 0: no glasses; 1: general glasses; 2: sunglasses.
2737
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
2738
+ """
2193
2739
  return self._Glass
2194
2740
 
2195
2741
  @Glass.setter
@@ -2198,6 +2744,10 @@ The `Type` values of the `AttributeItem` include: 0: small eyes; 1: general eyes
2198
2744
 
2199
2745
  @property
2200
2746
  def EyeOpen(self):
2747
+ """Whether the eyes are open.
2748
+ The `Type` values of the `AttributeItem` include: 0: open; 1: closed.
2749
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
2750
+ """
2201
2751
  return self._EyeOpen
2202
2752
 
2203
2753
  @EyeOpen.setter
@@ -2206,6 +2756,10 @@ The `Type` values of the `AttributeItem` include: 0: small eyes; 1: general eyes
2206
2756
 
2207
2757
  @property
2208
2758
  def EyelidType(self):
2759
+ """Whether the person has double eyelids.
2760
+ The `Type` values of the `AttributeItem` include: 0: no; 1: yes.
2761
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
2762
+ """
2209
2763
  return self._EyelidType
2210
2764
 
2211
2765
  @EyelidType.setter
@@ -2214,6 +2768,10 @@ The `Type` values of the `AttributeItem` include: 0: small eyes; 1: general eyes
2214
2768
 
2215
2769
  @property
2216
2770
  def EyeSize(self):
2771
+ """Eye size.
2772
+ The `Type` values of the `AttributeItem` include: 0: small eyes; 1: general eyes; 2: big eyes.
2773
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
2774
+ """
2217
2775
  return self._EyeSize
2218
2776
 
2219
2777
  @EyeSize.setter
@@ -2267,6 +2825,10 @@ The `Type` values of the `AttributeItem` include: 0: short; 1: long.
2267
2825
 
2268
2826
  @property
2269
2827
  def EyebrowDensity(self):
2828
+ """Eyebrow thickness.
2829
+ The `Type` values of the `AttributeItem` include: 0: light; 1: thick.
2830
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
2831
+ """
2270
2832
  return self._EyebrowDensity
2271
2833
 
2272
2834
  @EyebrowDensity.setter
@@ -2275,6 +2837,10 @@ The `Type` values of the `AttributeItem` include: 0: short; 1: long.
2275
2837
 
2276
2838
  @property
2277
2839
  def EyebrowCurve(self):
2840
+ """Eyebrow curve.
2841
+ The `Type` values of the `AttributeItem` include: 0: flat; 1: curved.
2842
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
2843
+ """
2278
2844
  return self._EyebrowCurve
2279
2845
 
2280
2846
  @EyebrowCurve.setter
@@ -2283,6 +2849,10 @@ The `Type` values of the `AttributeItem` include: 0: short; 1: long.
2283
2849
 
2284
2850
  @property
2285
2851
  def EyebrowLength(self):
2852
+ """Eyebrow length.
2853
+ The `Type` values of the `AttributeItem` include: 0: short; 1: long.
2854
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
2855
+ """
2286
2856
  return self._EyebrowLength
2287
2857
 
2288
2858
  @EyebrowLength.setter
@@ -2365,6 +2935,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2365
2935
 
2366
2936
  @property
2367
2937
  def Gender(self):
2938
+ """Gender. The gender is female for the value range [0,49] and male for the value range [50,100]. The closer the value to 0 or 100, the higher the confidence. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
2939
+ :rtype: int
2940
+ """
2368
2941
  return self._Gender
2369
2942
 
2370
2943
  @Gender.setter
@@ -2373,6 +2946,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2373
2946
 
2374
2947
  @property
2375
2948
  def Age(self):
2949
+ """Age. Value range: [0,100]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
2950
+ :rtype: int
2951
+ """
2376
2952
  return self._Age
2377
2953
 
2378
2954
  @Age.setter
@@ -2381,6 +2957,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2381
2957
 
2382
2958
  @property
2383
2959
  def Expression(self):
2960
+ """Expression. Value range: [0 (normal)–50 (smile)–100 (laugh)]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
2961
+ :rtype: int
2962
+ """
2384
2963
  return self._Expression
2385
2964
 
2386
2965
  @Expression.setter
@@ -2389,6 +2968,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2389
2968
 
2390
2969
  @property
2391
2970
  def Glass(self):
2971
+ """Whether glasses are present. Valid values: true, false. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
2972
+ :rtype: bool
2973
+ """
2392
2974
  return self._Glass
2393
2975
 
2394
2976
  @Glass.setter
@@ -2397,6 +2979,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2397
2979
 
2398
2980
  @property
2399
2981
  def Pitch(self):
2982
+ """Vertical offset in degrees. Value range: [-30,30]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
2983
+ We recommend selecting images in the [-10,10] range for adding faces.
2984
+ :rtype: int
2985
+ """
2400
2986
  return self._Pitch
2401
2987
 
2402
2988
  @Pitch.setter
@@ -2405,6 +2991,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2405
2991
 
2406
2992
  @property
2407
2993
  def Yaw(self):
2994
+ """Horizontal offset in degrees. Value range: [-30,30]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
2995
+ We recommend selecting images in the [-10,10] range for adding faces.
2996
+ :rtype: int
2997
+ """
2408
2998
  return self._Yaw
2409
2999
 
2410
3000
  @Yaw.setter
@@ -2413,6 +3003,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2413
3003
 
2414
3004
  @property
2415
3005
  def Roll(self):
3006
+ """Horizontal rotation in degrees. Value range: [-180,180]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
3007
+ We recommend selecting images in the [-20,20] range for adding faces.
3008
+ :rtype: int
3009
+ """
2416
3010
  return self._Roll
2417
3011
 
2418
3012
  @Roll.setter
@@ -2421,6 +3015,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2421
3015
 
2422
3016
  @property
2423
3017
  def Beauty(self):
3018
+ """Beauty. Value range: [0,100]. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
3019
+ :rtype: int
3020
+ """
2424
3021
  return self._Beauty
2425
3022
 
2426
3023
  @Beauty.setter
@@ -2429,6 +3026,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2429
3026
 
2430
3027
  @property
2431
3028
  def Hat(self):
3029
+ """Whether hat is present. Valid values: true, false. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
3030
+ Note: this field may return null, indicating that no valid values can be obtained.
3031
+ :rtype: bool
3032
+ """
2432
3033
  return self._Hat
2433
3034
 
2434
3035
  @Hat.setter
@@ -2437,6 +3038,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2437
3038
 
2438
3039
  @property
2439
3040
  def Mask(self):
3041
+ """Whether mask is present. Valid values: true, false. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
3042
+ Note: this field may return null, indicating that no valid values can be obtained.
3043
+ :rtype: bool
3044
+ """
2440
3045
  return self._Mask
2441
3046
 
2442
3047
  @Mask.setter
@@ -2445,6 +3050,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2445
3050
 
2446
3051
  @property
2447
3052
  def Hair(self):
3053
+ """Hair information, including length, bang, and color. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
3054
+ Note: this field may return null, indicating that no valid values can be obtained.
3055
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceHairAttributesInfo`
3056
+ """
2448
3057
  return self._Hair
2449
3058
 
2450
3059
  @Hair.setter
@@ -2453,6 +3062,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2453
3062
 
2454
3063
  @property
2455
3064
  def EyeOpen(self):
3065
+ """Whether the eyes are open. Valid values: true, false. As long as there is more than one eye closed, `false` will be returned. If `NeedFaceAttributes` is not 1 or more than 5 faces are detected, this parameter will still be returned but meaningless.
3066
+ Note: this field may return null, indicating that no valid values can be obtained.
3067
+ :rtype: bool
3068
+ """
2456
3069
  return self._EyeOpen
2457
3070
 
2458
3071
  @EyeOpen.setter
@@ -2571,6 +3184,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2571
3184
 
2572
3185
  @property
2573
3186
  def Age(self):
3187
+ """Age. Value range: [0,65], where 65 indicates 65 years old or above.
3188
+ If `FaceAttributesType` does not include `Age` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3189
+ :rtype: int
3190
+ """
2574
3191
  return self._Age
2575
3192
 
2576
3193
  @Age.setter
@@ -2579,6 +3196,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2579
3196
 
2580
3197
  @property
2581
3198
  def Beauty(self):
3199
+ """Beauty score. Value range: [0,100].
3200
+ If `FaceAttributesType` does not include `Beauty` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3201
+ :rtype: int
3202
+ """
2582
3203
  return self._Beauty
2583
3204
 
2584
3205
  @Beauty.setter
@@ -2587,6 +3208,11 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2587
3208
 
2588
3209
  @property
2589
3210
  def Emotion(self):
3211
+ """Emotion, including relaxed, happy, surprised, angry, sad, disgusted, and scared.
3212
+ The `Type` values of the `AttributeItem` include: 0: relaxed; 1: happy; 2: surprised; 3: angry; 4: sad; 5: disgusted; 6: scared.
3213
+ If `FaceAttributesType` does not include `Emotion` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3214
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
3215
+ """
2590
3216
  return self._Emotion
2591
3217
 
2592
3218
  @Emotion.setter
@@ -2595,6 +3221,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2595
3221
 
2596
3222
  @property
2597
3223
  def Eye(self):
3224
+ """Eye information, including whether glasses are worn, whether eyes are closed, whether the person has double eyelids, and the eye size.
3225
+ If `FaceAttributesType` does not include `Eye` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3226
+ :rtype: :class:`tencentcloud.iai.v20200303.models.Eye`
3227
+ """
2598
3228
  return self._Eye
2599
3229
 
2600
3230
  @Eye.setter
@@ -2603,6 +3233,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2603
3233
 
2604
3234
  @property
2605
3235
  def Eyebrow(self):
3236
+ """Eyebrow information, including whether the eyebrows are thick, curved, or long.
3237
+ If `FaceAttributesType` does not include `Eyebrow` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3238
+ :rtype: :class:`tencentcloud.iai.v20200303.models.Eyebrow`
3239
+ """
2606
3240
  return self._Eyebrow
2607
3241
 
2608
3242
  @Eyebrow.setter
@@ -2611,6 +3245,11 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2611
3245
 
2612
3246
  @property
2613
3247
  def Gender(self):
3248
+ """Gender information.
3249
+ The `Type` values of the `AttributeItem` include: 0: male; 1: female.
3250
+ If `FaceAttributesType` does not include `Gender` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3251
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
3252
+ """
2614
3253
  return self._Gender
2615
3254
 
2616
3255
  @Gender.setter
@@ -2619,6 +3258,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2619
3258
 
2620
3259
  @property
2621
3260
  def Hair(self):
3261
+ """Hair information, including length, bang, and color.
3262
+ If `FaceAttributesType` does not include `Hair` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3263
+ :rtype: :class:`tencentcloud.iai.v20200303.models.Hair`
3264
+ """
2622
3265
  return self._Hair
2623
3266
 
2624
3267
  @Hair.setter
@@ -2627,6 +3270,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2627
3270
 
2628
3271
  @property
2629
3272
  def Hat(self):
3273
+ """Hat information, including whether a hat is worn, hat style, and hat color.
3274
+ If `FaceAttributesType` does not include `Hat` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3275
+ :rtype: :class:`tencentcloud.iai.v20200303.models.Hat`
3276
+ """
2630
3277
  return self._Hat
2631
3278
 
2632
3279
  @Hat.setter
@@ -2635,6 +3282,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2635
3282
 
2636
3283
  @property
2637
3284
  def HeadPose(self):
3285
+ """Pose information, including the face pitch, yaw, and roll.
3286
+ If `FaceAttributesType` does not include `Headpose` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3287
+ :rtype: :class:`tencentcloud.iai.v20200303.models.HeadPose`
3288
+ """
2638
3289
  return self._HeadPose
2639
3290
 
2640
3291
  @HeadPose.setter
@@ -2643,6 +3294,11 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2643
3294
 
2644
3295
  @property
2645
3296
  def Mask(self):
3297
+ """Mask information.
3298
+ The `Type` values of the `AttributeItem` include: 0: no mask; 1: the mask is worn and does not cover the face; 2: the mask is worn and covers the chin; 3: the mask is worn and covers the mouth; 4: the mask is worn properly.
3299
+ If `FaceAttributesType` does not include `Mask` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3300
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
3301
+ """
2646
3302
  return self._Mask
2647
3303
 
2648
3304
  @Mask.setter
@@ -2651,6 +3307,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2651
3307
 
2652
3308
  @property
2653
3309
  def Mouth(self):
3310
+ """Mouth information, including whether the mouth is open and the lip thickness.
3311
+ If `FaceAttributesType` does not include `Mouth` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3312
+ :rtype: :class:`tencentcloud.iai.v20200303.models.Mouth`
3313
+ """
2654
3314
  return self._Mouth
2655
3315
 
2656
3316
  @Mouth.setter
@@ -2659,6 +3319,11 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2659
3319
 
2660
3320
  @property
2661
3321
  def Moustache(self):
3322
+ """Beard information.
3323
+ The `Type` values of the `AttributeItem` include: 0: no beard; 1: beard detected.
3324
+ If `FaceAttributesType` does not include `Moustache` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3325
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
3326
+ """
2662
3327
  return self._Moustache
2663
3328
 
2664
3329
  @Moustache.setter
@@ -2667,6 +3332,11 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2667
3332
 
2668
3333
  @property
2669
3334
  def Nose(self):
3335
+ """Nose information.
3336
+ The `Type` values of the `AttributeItem` include: 0: upturned nose; 1: aquiline nose; 2: general nose; 3: bulbous nose.
3337
+ If `FaceAttributesType` does not include `Nose` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3338
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
3339
+ """
2670
3340
  return self._Nose
2671
3341
 
2672
3342
  @Nose.setter
@@ -2675,6 +3345,11 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2675
3345
 
2676
3346
  @property
2677
3347
  def Shape(self):
3348
+ """Face shape information.
3349
+ The `Type` values of the `AttributeItem` include: 0: square; 1: triangular; 2: oval; 3: heart-shaped; 4: round.
3350
+ If `FaceAttributesType` does not include `Shape` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3351
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
3352
+ """
2678
3353
  return self._Shape
2679
3354
 
2680
3355
  @Shape.setter
@@ -2683,6 +3358,11 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2683
3358
 
2684
3359
  @property
2685
3360
  def Skin(self):
3361
+ """Skin color information.
3362
+ The `Type` values of the `AttributeItem` include: 0: yellow; 1: brown; 2: black; 3: white.
3363
+ If `FaceAttributesType` does not include `Skin` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3364
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
3365
+ """
2686
3366
  return self._Skin
2687
3367
 
2688
3368
  @Skin.setter
@@ -2691,6 +3371,10 @@ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detect
2691
3371
 
2692
3372
  @property
2693
3373
  def Smile(self):
3374
+ """Smile level. Value range: [0,100].
3375
+ If `FaceAttributesType` does not include `Smile` or more than 5 faces are detected, this parameter will still be returned but meaningless.
3376
+ :rtype: int
3377
+ """
2694
3378
  return self._Smile
2695
3379
 
2696
3380
  @Smile.setter
@@ -2772,6 +3456,9 @@ If no types are specified in `FaceAttributesType`, the detailed items returned b
2772
3456
 
2773
3457
  @property
2774
3458
  def FaceRect(self):
3459
+ """Position of the detected face frame.
3460
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceRect`
3461
+ """
2775
3462
  return self._FaceRect
2776
3463
 
2777
3464
  @FaceRect.setter
@@ -2780,6 +3467,13 @@ If no types are specified in `FaceAttributesType`, the detailed items returned b
2780
3467
 
2781
3468
  @property
2782
3469
  def FaceDetailAttributesInfo(self):
3470
+ """Face attribute information. According to the types specified in `FaceAttributesType`, the following face attributes will be returned: age (Age), beauty score (Beauty),
3471
+ emotion (Emotion), eye information (Eye), eyebrow information (Eyebrow), gender (Gender),
3472
+ hair information (Hair), hat information (Hat), pose (Headpose), mask information (Mask), mouth information (Mouse), beard information (Moustache),
3473
+ nose information (Nose), face shape (Shape), skin color (Skin), and smile information (Smile), etc.
3474
+ If no types are specified in `FaceAttributesType`, the detailed items returned by `FaceDetaiAttributesInfo` will be meaningless.
3475
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceDetailAttributesInfo`
3476
+ """
2783
3477
  return self._FaceDetailAttributesInfo
2784
3478
 
2785
3479
  @FaceDetailAttributesInfo.setter
@@ -2827,6 +3521,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2827
3521
 
2828
3522
  @property
2829
3523
  def Length(self):
3524
+ """0: shaved head, 1: short hair, 2: medium hair, 3: long hair, 4: braid
3525
+ Note: this field may return null, indicating that no valid values can be obtained.
3526
+ :rtype: int
3527
+ """
2830
3528
  return self._Length
2831
3529
 
2832
3530
  @Length.setter
@@ -2835,6 +3533,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2835
3533
 
2836
3534
  @property
2837
3535
  def Bang(self):
3536
+ """0: with bangs, 1: no bangs
3537
+ Note: this field may return null, indicating that no valid values can be obtained.
3538
+ :rtype: int
3539
+ """
2838
3540
  return self._Bang
2839
3541
 
2840
3542
  @Bang.setter
@@ -2843,6 +3545,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2843
3545
 
2844
3546
  @property
2845
3547
  def Color(self):
3548
+ """0: black, 1: golden, 2: brown, 3: gray
3549
+ Note: this field may return null, indicating that no valid values can be obtained.
3550
+ :rtype: int
3551
+ """
2846
3552
  return self._Color
2847
3553
 
2848
3554
  @Color.setter
@@ -2899,6 +3605,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
2899
3605
 
2900
3606
  @property
2901
3607
  def X(self):
3608
+ """Horizontal coordinate of the top-left vertex of the face frame.
3609
+ The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative.
3610
+ If you want to capture a complete face, you can set the negative coordinates to 0 if the `completeness` score meets the requirement.
3611
+ :rtype: int
3612
+ """
2902
3613
  return self._X
2903
3614
 
2904
3615
  @X.setter
@@ -2907,6 +3618,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
2907
3618
 
2908
3619
  @property
2909
3620
  def Y(self):
3621
+ """Vertical coordinate of the top-left vertex of the face frame.
3622
+ The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative.
3623
+ If you want to capture a complete face, you can set the negative coordinates to 0 if the `completeness` score meets the requirement.
3624
+ :rtype: int
3625
+ """
2910
3626
  return self._Y
2911
3627
 
2912
3628
  @Y.setter
@@ -2915,6 +3631,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2915
3631
 
2916
3632
  @property
2917
3633
  def Width(self):
3634
+ """Face frame width.
3635
+ :rtype: int
3636
+ """
2918
3637
  return self._Width
2919
3638
 
2920
3639
  @Width.setter
@@ -2923,6 +3642,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
2923
3642
 
2924
3643
  @property
2925
3644
  def Height(self):
3645
+ """Face frame height.
3646
+ :rtype: int
3647
+ """
2926
3648
  return self._Height
2927
3649
 
2928
3650
  @Height.setter
@@ -2931,6 +3653,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2931
3653
 
2932
3654
  @property
2933
3655
  def FaceAttributesInfo(self):
3656
+ """Face attributes, including gender, age, expression,
3657
+ beauty, glass, mask, hair, and pose (pitch, roll, yaw). Valid information will be returned only if `NeedFaceAttributes` is set to 1.
3658
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceAttributesInfo`
3659
+ """
2934
3660
  return self._FaceAttributesInfo
2935
3661
 
2936
3662
  @FaceAttributesInfo.setter
@@ -2939,6 +3665,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
2939
3665
 
2940
3666
  @property
2941
3667
  def FaceQualityInfo(self):
3668
+ """Face quality information, including score, sharpness, brightness, and completeness. Valid information will be returned only if `NeedFaceDetection` is set to 1.
3669
+ Note: this field may return null, indicating that no valid values can be obtained.
3670
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceQualityInfo`
3671
+ """
2942
3672
  return self._FaceQualityInfo
2943
3673
 
2944
3674
  @FaceQualityInfo.setter
@@ -3008,6 +3738,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
3008
3738
 
3009
3739
  @property
3010
3740
  def Eyebrow(self):
3741
+ """Eyebrow completeness. Value range: [0,100]. The higher the score, the higher the completeness.
3742
+ Reference range: [0,80], which means incomplete.
3743
+ Note: this field may return null, indicating that no valid values can be obtained.
3744
+ :rtype: int
3745
+ """
3011
3746
  return self._Eyebrow
3012
3747
 
3013
3748
  @Eyebrow.setter
@@ -3016,6 +3751,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
3016
3751
 
3017
3752
  @property
3018
3753
  def Eye(self):
3754
+ """Eye completeness. Value range: [0,100]. The higher the score, the higher the completeness.
3755
+ Reference range: [0,80], which means incomplete.
3756
+ Note: this field may return null, indicating that no valid values can be obtained.
3757
+ :rtype: int
3758
+ """
3019
3759
  return self._Eye
3020
3760
 
3021
3761
  @Eye.setter
@@ -3024,6 +3764,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
3024
3764
 
3025
3765
  @property
3026
3766
  def Nose(self):
3767
+ """Nose completeness. Value range: [0,100]. The higher the score, the higher the completeness.
3768
+ Reference range: [0,60], which means incomplete.
3769
+ Note: this field may return null, indicating that no valid values can be obtained.
3770
+ :rtype: int
3771
+ """
3027
3772
  return self._Nose
3028
3773
 
3029
3774
  @Nose.setter
@@ -3032,6 +3777,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
3032
3777
 
3033
3778
  @property
3034
3779
  def Cheek(self):
3780
+ """Cheek completeness. Value range: [0,100]. The higher the score, the higher the completeness.
3781
+ Reference range: [0,70], which means incomplete.
3782
+ Note: this field may return null, indicating that no valid values can be obtained.
3783
+ :rtype: int
3784
+ """
3035
3785
  return self._Cheek
3036
3786
 
3037
3787
  @Cheek.setter
@@ -3040,6 +3790,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
3040
3790
 
3041
3791
  @property
3042
3792
  def Mouth(self):
3793
+ """Mouth completeness. Value range: [0,100]. The higher the score, the higher the completeness.
3794
+ Reference range: [0,50], which means incomplete.
3795
+ Note: this field may return null, indicating that no valid values can be obtained.
3796
+ :rtype: int
3797
+ """
3043
3798
  return self._Mouth
3044
3799
 
3045
3800
  @Mouth.setter
@@ -3048,6 +3803,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
3048
3803
 
3049
3804
  @property
3050
3805
  def Chin(self):
3806
+ """Chin completeness. Value range: [0,100]. The higher the score, the higher the completeness.
3807
+ Reference range: [0,70], which means incomplete.
3808
+ Note: this field may return null, indicating that no valid values can be obtained.
3809
+ :rtype: int
3810
+ """
3051
3811
  return self._Chin
3052
3812
 
3053
3813
  @Chin.setter
@@ -3106,6 +3866,13 @@ Note: this field may return null, indicating that no valid values can be obtaine
3106
3866
 
3107
3867
  @property
3108
3868
  def Score(self):
3869
+ """Quality score. Value range: [0,100]. It comprehensively evaluates whether the image quality is suitable for face recognition; the higher the score, the higher the quality.
3870
+ In normal cases, you only need to use `Score` as the overall quality standard score. Specific item scores such as `Sharpness`, `Brightness`, `Completeness` are for reference only.
3871
+ Reference range: [0,40]: poor; [40,60]: fine; [60,80]: good; [80,100]: excellent.
3872
+ We recommend selecting images with a score above 70 for adding faces.
3873
+ Note: this field may return null, indicating that no valid values can be obtained.
3874
+ :rtype: int
3875
+ """
3109
3876
  return self._Score
3110
3877
 
3111
3878
  @Score.setter
@@ -3114,6 +3881,12 @@ Note: this field may return null, indicating that no valid values can be obtaine
3114
3881
 
3115
3882
  @property
3116
3883
  def Sharpness(self):
3884
+ """Sharpness. Value range: [0,100]. It evaluates the sharpness of the image. The higher the score, the sharper the image.
3885
+ Reference range: [0,40]: very blurry; [40,60]: blurry; [60,80]: fine; [80,100]: sharp.
3886
+ We recommend selecting images with a score above 80 for adding faces.
3887
+ Note: this field may return null, indicating that no valid values can be obtained.
3888
+ :rtype: int
3889
+ """
3117
3890
  return self._Sharpness
3118
3891
 
3119
3892
  @Sharpness.setter
@@ -3122,6 +3895,12 @@ Note: this field may return null, indicating that no valid values can be obtaine
3122
3895
 
3123
3896
  @property
3124
3897
  def Brightness(self):
3898
+ """Brightness. Value range: [0,100]. The brighter the image, the higher the score.
3899
+ Reference range: [0,30]: dark; [30,70]: normal; [70,100]: bright.
3900
+ We recommend selecting images in the [30,70] range for adding faces.
3901
+ Note: this field may return null, indicating that no valid values can be obtained.
3902
+ :rtype: int
3903
+ """
3125
3904
  return self._Brightness
3126
3905
 
3127
3906
  @Brightness.setter
@@ -3130,6 +3909,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3130
3909
 
3131
3910
  @property
3132
3911
  def Completeness(self):
3912
+ """Completeness of facial features, which assesses the completeness of the eyebrows, eyes, nose, cheeks, mouth, and chin.
3913
+ Note: this field may return null, indicating that no valid values can be obtained.
3914
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceQualityCompleteness`
3915
+ """
3133
3916
  return self._Completeness
3134
3917
 
3135
3918
  @Completeness.setter
@@ -3181,6 +3964,11 @@ If you want to capture a complete face, you can set the negative coordinates to
3181
3964
 
3182
3965
  @property
3183
3966
  def X(self):
3967
+ """Horizontal coordinate of the top-left vertex of face frame.
3968
+ The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative.
3969
+ If you want to capture a complete face, you can set the negative coordinates to 0 if the completeness score meets the requirement.
3970
+ :rtype: int
3971
+ """
3184
3972
  return self._X
3185
3973
 
3186
3974
  @X.setter
@@ -3189,6 +3977,11 @@ If you want to capture a complete face, you can set the negative coordinates to
3189
3977
 
3190
3978
  @property
3191
3979
  def Y(self):
3980
+ """Vertical coordinate of the top-left vertex of face frame.
3981
+ The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative.
3982
+ If you want to capture a complete face, you can set the negative coordinates to 0 if the completeness score meets the requirement.
3983
+ :rtype: int
3984
+ """
3192
3985
  return self._Y
3193
3986
 
3194
3987
  @Y.setter
@@ -3197,6 +3990,9 @@ If you want to capture a complete face, you can set the negative coordinates to
3197
3990
 
3198
3991
  @property
3199
3992
  def Width(self):
3993
+ """Face width
3994
+ :rtype: int
3995
+ """
3200
3996
  return self._Width
3201
3997
 
3202
3998
  @Width.setter
@@ -3205,6 +4001,9 @@ If you want to capture a complete face, you can set the negative coordinates to
3205
4001
 
3206
4002
  @property
3207
4003
  def Height(self):
4004
+ """Face height
4005
+ :rtype: int
4006
+ """
3208
4007
  return self._Height
3209
4008
 
3210
4009
  @Height.setter
@@ -3265,6 +4064,9 @@ class FaceShape(AbstractModel):
3265
4064
 
3266
4065
  @property
3267
4066
  def FaceProfile(self):
4067
+ """21 points that describe the face contour.
4068
+ :rtype: list of Point
4069
+ """
3268
4070
  return self._FaceProfile
3269
4071
 
3270
4072
  @FaceProfile.setter
@@ -3273,6 +4075,9 @@ class FaceShape(AbstractModel):
3273
4075
 
3274
4076
  @property
3275
4077
  def LeftEye(self):
4078
+ """8 points that describe the left eye.
4079
+ :rtype: list of Point
4080
+ """
3276
4081
  return self._LeftEye
3277
4082
 
3278
4083
  @LeftEye.setter
@@ -3281,6 +4086,9 @@ class FaceShape(AbstractModel):
3281
4086
 
3282
4087
  @property
3283
4088
  def RightEye(self):
4089
+ """8 points that describe the right eye.
4090
+ :rtype: list of Point
4091
+ """
3284
4092
  return self._RightEye
3285
4093
 
3286
4094
  @RightEye.setter
@@ -3289,6 +4097,9 @@ class FaceShape(AbstractModel):
3289
4097
 
3290
4098
  @property
3291
4099
  def LeftEyeBrow(self):
4100
+ """8 points that describe the left eyebrow.
4101
+ :rtype: list of Point
4102
+ """
3292
4103
  return self._LeftEyeBrow
3293
4104
 
3294
4105
  @LeftEyeBrow.setter
@@ -3297,6 +4108,9 @@ class FaceShape(AbstractModel):
3297
4108
 
3298
4109
  @property
3299
4110
  def RightEyeBrow(self):
4111
+ """8 points that describe the right eyebrow.
4112
+ :rtype: list of Point
4113
+ """
3300
4114
  return self._RightEyeBrow
3301
4115
 
3302
4116
  @RightEyeBrow.setter
@@ -3305,6 +4119,9 @@ class FaceShape(AbstractModel):
3305
4119
 
3306
4120
  @property
3307
4121
  def Mouth(self):
4122
+ """22 points that describe the mouth.
4123
+ :rtype: list of Point
4124
+ """
3308
4125
  return self._Mouth
3309
4126
 
3310
4127
  @Mouth.setter
@@ -3313,6 +4130,9 @@ class FaceShape(AbstractModel):
3313
4130
 
3314
4131
  @property
3315
4132
  def Nose(self):
4133
+ """13 points that describe the nose.
4134
+ :rtype: list of Point
4135
+ """
3316
4136
  return self._Nose
3317
4137
 
3318
4138
  @Nose.setter
@@ -3321,6 +4141,9 @@ class FaceShape(AbstractModel):
3321
4141
 
3322
4142
  @property
3323
4143
  def LeftPupil(self):
4144
+ """1 point that describes the left pupil.
4145
+ :rtype: list of Point
4146
+ """
3324
4147
  return self._LeftPupil
3325
4148
 
3326
4149
  @LeftPupil.setter
@@ -3329,6 +4152,9 @@ class FaceShape(AbstractModel):
3329
4152
 
3330
4153
  @property
3331
4154
  def RightPupil(self):
4155
+ """1 point that describes the right pupil.
4156
+ :rtype: list of Point
4157
+ """
3332
4158
  return self._RightPupil
3333
4159
 
3334
4160
  @RightPupil.setter
@@ -3415,6 +4241,9 @@ class GetGroupInfoRequest(AbstractModel):
3415
4241
 
3416
4242
  @property
3417
4243
  def GroupId(self):
4244
+ """Group ID, which is the `GroupId` in the `CreateGroup` API.
4245
+ :rtype: str
4246
+ """
3418
4247
  return self._GroupId
3419
4248
 
3420
4249
  @GroupId.setter
@@ -3466,6 +4295,9 @@ class GetGroupInfoResponse(AbstractModel):
3466
4295
 
3467
4296
  @property
3468
4297
  def GroupName(self):
4298
+ """Group name
4299
+ :rtype: str
4300
+ """
3469
4301
  return self._GroupName
3470
4302
 
3471
4303
  @GroupName.setter
@@ -3474,6 +4306,9 @@ class GetGroupInfoResponse(AbstractModel):
3474
4306
 
3475
4307
  @property
3476
4308
  def GroupId(self):
4309
+ """Group ID
4310
+ :rtype: str
4311
+ """
3477
4312
  return self._GroupId
3478
4313
 
3479
4314
  @GroupId.setter
@@ -3482,6 +4317,9 @@ class GetGroupInfoResponse(AbstractModel):
3482
4317
 
3483
4318
  @property
3484
4319
  def GroupExDescriptions(self):
4320
+ """Custom group description field
4321
+ :rtype: list of str
4322
+ """
3485
4323
  return self._GroupExDescriptions
3486
4324
 
3487
4325
  @GroupExDescriptions.setter
@@ -3490,6 +4328,9 @@ class GetGroupInfoResponse(AbstractModel):
3490
4328
 
3491
4329
  @property
3492
4330
  def Tag(self):
4331
+ """Group remarks
4332
+ :rtype: str
4333
+ """
3493
4334
  return self._Tag
3494
4335
 
3495
4336
  @Tag.setter
@@ -3498,6 +4339,9 @@ class GetGroupInfoResponse(AbstractModel):
3498
4339
 
3499
4340
  @property
3500
4341
  def FaceModelVersion(self):
4342
+ """Algorithm model version used for face recognition.
4343
+ :rtype: str
4344
+ """
3501
4345
  return self._FaceModelVersion
3502
4346
 
3503
4347
  @FaceModelVersion.setter
@@ -3506,6 +4350,9 @@ class GetGroupInfoResponse(AbstractModel):
3506
4350
 
3507
4351
  @property
3508
4352
  def CreationTimestamp(self):
4353
+ """Group creation time and date (`CreationTimestamp`), whose value is the number of milliseconds between the UNIX epoch time and the group creation time.
4354
+ :rtype: int
4355
+ """
3509
4356
  return self._CreationTimestamp
3510
4357
 
3511
4358
  @CreationTimestamp.setter
@@ -3514,6 +4361,9 @@ class GetGroupInfoResponse(AbstractModel):
3514
4361
 
3515
4362
  @property
3516
4363
  def RequestId(self):
4364
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4365
+ :rtype: str
4366
+ """
3517
4367
  return self._RequestId
3518
4368
 
3519
4369
  @RequestId.setter
@@ -3548,6 +4398,9 @@ class GetGroupListRequest(AbstractModel):
3548
4398
 
3549
4399
  @property
3550
4400
  def Offset(self):
4401
+ """Starting number. Default value: 0.
4402
+ :rtype: int
4403
+ """
3551
4404
  return self._Offset
3552
4405
 
3553
4406
  @Offset.setter
@@ -3556,6 +4409,9 @@ class GetGroupListRequest(AbstractModel):
3556
4409
 
3557
4410
  @property
3558
4411
  def Limit(self):
4412
+ """Number of returned results. Default value: 10. Maximum value: 1000.
4413
+ :rtype: int
4414
+ """
3559
4415
  return self._Limit
3560
4416
 
3561
4417
  @Limit.setter
@@ -3597,6 +4453,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
3597
4453
 
3598
4454
  @property
3599
4455
  def GroupInfos(self):
4456
+ """Returned group information
4457
+ :rtype: list of GroupInfo
4458
+ """
3600
4459
  return self._GroupInfos
3601
4460
 
3602
4461
  @GroupInfos.setter
@@ -3605,6 +4464,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3605
4464
 
3606
4465
  @property
3607
4466
  def GroupNum(self):
4467
+ """Total number of groups
4468
+ Note: this field may return null, indicating that no valid values can be obtained.
4469
+ :rtype: int
4470
+ """
3608
4471
  return self._GroupNum
3609
4472
 
3610
4473
  @GroupNum.setter
@@ -3613,6 +4476,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
3613
4476
 
3614
4477
  @property
3615
4478
  def RequestId(self):
4479
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4480
+ :rtype: str
4481
+ """
3616
4482
  return self._RequestId
3617
4483
 
3618
4484
  @RequestId.setter
@@ -3645,6 +4511,9 @@ class GetPersonBaseInfoRequest(AbstractModel):
3645
4511
 
3646
4512
  @property
3647
4513
  def PersonId(self):
4514
+ """Person ID, which is the `PersonId` in the `CreatePerson` API.
4515
+ :rtype: str
4516
+ """
3648
4517
  return self._PersonId
3649
4518
 
3650
4519
  @PersonId.setter
@@ -3687,6 +4556,9 @@ class GetPersonBaseInfoResponse(AbstractModel):
3687
4556
 
3688
4557
  @property
3689
4558
  def PersonName(self):
4559
+ """Person name
4560
+ :rtype: str
4561
+ """
3690
4562
  return self._PersonName
3691
4563
 
3692
4564
  @PersonName.setter
@@ -3695,6 +4567,9 @@ class GetPersonBaseInfoResponse(AbstractModel):
3695
4567
 
3696
4568
  @property
3697
4569
  def Gender(self):
4570
+ """Person gender. 0: empty; 1: male; 2: female.
4571
+ :rtype: int
4572
+ """
3698
4573
  return self._Gender
3699
4574
 
3700
4575
  @Gender.setter
@@ -3703,6 +4578,9 @@ class GetPersonBaseInfoResponse(AbstractModel):
3703
4578
 
3704
4579
  @property
3705
4580
  def FaceIds(self):
4581
+ """List of the IDs of included faces
4582
+ :rtype: list of str
4583
+ """
3706
4584
  return self._FaceIds
3707
4585
 
3708
4586
  @FaceIds.setter
@@ -3711,6 +4589,9 @@ class GetPersonBaseInfoResponse(AbstractModel):
3711
4589
 
3712
4590
  @property
3713
4591
  def RequestId(self):
4592
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4593
+ :rtype: str
4594
+ """
3714
4595
  return self._RequestId
3715
4596
 
3716
4597
  @RequestId.setter
@@ -3745,6 +4626,9 @@ class GetPersonGroupInfoRequest(AbstractModel):
3745
4626
 
3746
4627
  @property
3747
4628
  def PersonId(self):
4629
+ """Person ID, which is the `PersonId` in the `CreatePerson` API.
4630
+ :rtype: str
4631
+ """
3748
4632
  return self._PersonId
3749
4633
 
3750
4634
  @PersonId.setter
@@ -3753,6 +4637,9 @@ class GetPersonGroupInfoRequest(AbstractModel):
3753
4637
 
3754
4638
  @property
3755
4639
  def Offset(self):
4640
+ """Starting number. Default value: 0.
4641
+ :rtype: int
4642
+ """
3756
4643
  return self._Offset
3757
4644
 
3758
4645
  @Offset.setter
@@ -3761,6 +4648,9 @@ class GetPersonGroupInfoRequest(AbstractModel):
3761
4648
 
3762
4649
  @property
3763
4650
  def Limit(self):
4651
+ """Number of returned results. Default value: 10. Maximum value: 100.
4652
+ :rtype: int
4653
+ """
3764
4654
  return self._Limit
3765
4655
 
3766
4656
  @Limit.setter
@@ -3807,6 +4697,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
3807
4697
 
3808
4698
  @property
3809
4699
  def PersonGroupInfos(self):
4700
+ """List of groups containing this person and their description fields
4701
+ :rtype: list of PersonGroupInfo
4702
+ """
3810
4703
  return self._PersonGroupInfos
3811
4704
 
3812
4705
  @PersonGroupInfos.setter
@@ -3815,6 +4708,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3815
4708
 
3816
4709
  @property
3817
4710
  def GroupNum(self):
4711
+ """Total number of groups
4712
+ Note: this field may return null, indicating that no valid values can be obtained.
4713
+ :rtype: int
4714
+ """
3818
4715
  return self._GroupNum
3819
4716
 
3820
4717
  @GroupNum.setter
@@ -3823,6 +4720,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
3823
4720
 
3824
4721
  @property
3825
4722
  def FaceModelVersion(self):
4723
+ """Algorithm model version used by the Face Recognition service.
4724
+ Note: this field may return null, indicating that no valid values can be obtained.
4725
+ :rtype: str
4726
+ """
3826
4727
  return self._FaceModelVersion
3827
4728
 
3828
4729
  @FaceModelVersion.setter
@@ -3831,6 +4732,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
3831
4732
 
3832
4733
  @property
3833
4734
  def RequestId(self):
4735
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4736
+ :rtype: str
4737
+ """
3834
4738
  return self._RequestId
3835
4739
 
3836
4740
  @RequestId.setter
@@ -3864,6 +4768,9 @@ class GetPersonListNumRequest(AbstractModel):
3864
4768
 
3865
4769
  @property
3866
4770
  def GroupId(self):
4771
+ """Group ID, which is the `GroupId` in the `CreateGroup` API.
4772
+ :rtype: str
4773
+ """
3867
4774
  return self._GroupId
3868
4775
 
3869
4776
  @GroupId.setter
@@ -3903,6 +4810,9 @@ class GetPersonListNumResponse(AbstractModel):
3903
4810
 
3904
4811
  @property
3905
4812
  def PersonNum(self):
4813
+ """Number of persons
4814
+ :rtype: int
4815
+ """
3906
4816
  return self._PersonNum
3907
4817
 
3908
4818
  @PersonNum.setter
@@ -3911,6 +4821,9 @@ class GetPersonListNumResponse(AbstractModel):
3911
4821
 
3912
4822
  @property
3913
4823
  def FaceNum(self):
4824
+ """Number of faces
4825
+ :rtype: int
4826
+ """
3914
4827
  return self._FaceNum
3915
4828
 
3916
4829
  @FaceNum.setter
@@ -3919,6 +4832,9 @@ class GetPersonListNumResponse(AbstractModel):
3919
4832
 
3920
4833
  @property
3921
4834
  def RequestId(self):
4835
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4836
+ :rtype: str
4837
+ """
3922
4838
  return self._RequestId
3923
4839
 
3924
4840
  @RequestId.setter
@@ -3952,6 +4868,9 @@ class GetPersonListRequest(AbstractModel):
3952
4868
 
3953
4869
  @property
3954
4870
  def GroupId(self):
4871
+ """Group ID, which is the `GroupId` in the `CreateGroup` API.
4872
+ :rtype: str
4873
+ """
3955
4874
  return self._GroupId
3956
4875
 
3957
4876
  @GroupId.setter
@@ -3960,6 +4879,9 @@ class GetPersonListRequest(AbstractModel):
3960
4879
 
3961
4880
  @property
3962
4881
  def Offset(self):
4882
+ """Starting number. Default value: 0.
4883
+ :rtype: int
4884
+ """
3963
4885
  return self._Offset
3964
4886
 
3965
4887
  @Offset.setter
@@ -3968,6 +4890,9 @@ class GetPersonListRequest(AbstractModel):
3968
4890
 
3969
4891
  @property
3970
4892
  def Limit(self):
4893
+ """Number of returned results. Default value: 10. Maximum value: 1000.
4894
+ :rtype: int
4895
+ """
3971
4896
  return self._Limit
3972
4897
 
3973
4898
  @Limit.setter
@@ -4018,6 +4943,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
4018
4943
 
4019
4944
  @property
4020
4945
  def PersonInfos(self):
4946
+ """Returned person information
4947
+ :rtype: list of PersonInfo
4948
+ """
4021
4949
  return self._PersonInfos
4022
4950
 
4023
4951
  @PersonInfos.setter
@@ -4026,6 +4954,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4026
4954
 
4027
4955
  @property
4028
4956
  def PersonNum(self):
4957
+ """Number of persons in the group
4958
+ Note: this field may return null, indicating that no valid values can be obtained.
4959
+ :rtype: int
4960
+ """
4029
4961
  return self._PersonNum
4030
4962
 
4031
4963
  @PersonNum.setter
@@ -4034,6 +4966,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4034
4966
 
4035
4967
  @property
4036
4968
  def FaceNum(self):
4969
+ """Number of faces in the group
4970
+ Note: this field may return null, indicating that no valid values can be obtained.
4971
+ :rtype: int
4972
+ """
4037
4973
  return self._FaceNum
4038
4974
 
4039
4975
  @FaceNum.setter
@@ -4042,6 +4978,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4042
4978
 
4043
4979
  @property
4044
4980
  def FaceModelVersion(self):
4981
+ """Algorithm model version used for face recognition.
4982
+ Note: this field may return null, indicating that no valid values can be obtained.
4983
+ :rtype: str
4984
+ """
4045
4985
  return self._FaceModelVersion
4046
4986
 
4047
4987
  @FaceModelVersion.setter
@@ -4050,6 +4990,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
4050
4990
 
4051
4991
  @property
4052
4992
  def RequestId(self):
4993
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4994
+ :rtype: str
4995
+ """
4053
4996
  return self._RequestId
4054
4997
 
4055
4998
  @RequestId.setter
@@ -4087,6 +5030,9 @@ class GroupCandidate(AbstractModel):
4087
5030
 
4088
5031
  @property
4089
5032
  def GroupId(self):
5033
+ """Group ID.
5034
+ :rtype: str
5035
+ """
4090
5036
  return self._GroupId
4091
5037
 
4092
5038
  @GroupId.setter
@@ -4095,6 +5041,9 @@ class GroupCandidate(AbstractModel):
4095
5041
 
4096
5042
  @property
4097
5043
  def Candidates(self):
5044
+ """Most matching candidate recognized
5045
+ :rtype: list of Candidate
5046
+ """
4098
5047
  return self._Candidates
4099
5048
 
4100
5049
  @Candidates.setter
@@ -4138,6 +5087,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4138
5087
 
4139
5088
  @property
4140
5089
  def GroupExDescriptionIndex(self):
5090
+ """Custom group description field index, whose value starts from 0.
5091
+ Note: this field may return null, indicating that no valid values can be obtained.
5092
+ :rtype: int
5093
+ """
4141
5094
  return self._GroupExDescriptionIndex
4142
5095
 
4143
5096
  @GroupExDescriptionIndex.setter
@@ -4146,6 +5099,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
4146
5099
 
4147
5100
  @property
4148
5101
  def GroupExDescription(self):
5102
+ """Content of the custom group description field to be updated
5103
+ :rtype: str
5104
+ """
4149
5105
  return self._GroupExDescription
4150
5106
 
4151
5107
  @GroupExDescription.setter
@@ -4200,6 +5156,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
4200
5156
 
4201
5157
  @property
4202
5158
  def GroupName(self):
5159
+ """Group name
5160
+ :rtype: str
5161
+ """
4203
5162
  return self._GroupName
4204
5163
 
4205
5164
  @GroupName.setter
@@ -4208,6 +5167,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
4208
5167
 
4209
5168
  @property
4210
5169
  def GroupId(self):
5170
+ """Group ID
5171
+ :rtype: str
5172
+ """
4211
5173
  return self._GroupId
4212
5174
 
4213
5175
  @GroupId.setter
@@ -4216,6 +5178,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4216
5178
 
4217
5179
  @property
4218
5180
  def GroupExDescriptions(self):
5181
+ """Custom group description field
5182
+ Note: this field may return null, indicating that no valid values can be obtained.
5183
+ :rtype: list of str
5184
+ """
4219
5185
  return self._GroupExDescriptions
4220
5186
 
4221
5187
  @GroupExDescriptions.setter
@@ -4224,6 +5190,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4224
5190
 
4225
5191
  @property
4226
5192
  def Tag(self):
5193
+ """Group remarks
5194
+ Note: this field may return null, indicating that no valid values can be obtained.
5195
+ :rtype: str
5196
+ """
4227
5197
  return self._Tag
4228
5198
 
4229
5199
  @Tag.setter
@@ -4232,6 +5202,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4232
5202
 
4233
5203
  @property
4234
5204
  def FaceModelVersion(self):
5205
+ """Algorithm model version used for face recognition.
5206
+ Note: this field may return null, indicating that no valid values can be obtained.
5207
+ :rtype: str
5208
+ """
4235
5209
  return self._FaceModelVersion
4236
5210
 
4237
5211
  @FaceModelVersion.setter
@@ -4240,6 +5214,11 @@ Note: this field may return null, indicating that no valid values can be obtaine
4240
5214
 
4241
5215
  @property
4242
5216
  def CreationTimestamp(self):
5217
+ """Group creation time and date (`CreationTimestamp`), whose value is the number of milliseconds between the UNIX epoch time and the group creation time.
5218
+ The UNIX epoch time is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Time (UTC). For more information, please see the UNIX time document.
5219
+ Note: this field may return null, indicating that no valid values can be obtained.
5220
+ :rtype: int
5221
+ """
4243
5222
  return self._CreationTimestamp
4244
5223
 
4245
5224
  @CreationTimestamp.setter
@@ -4287,6 +5266,10 @@ The `Type` values of the `AttributeItem` include: 0: black; 1: golden; 2: brown;
4287
5266
 
4288
5267
  @property
4289
5268
  def Length(self):
5269
+ """Hair length information.
5270
+ The `Type` values of the `AttributeItem` include: 0: bald, 1: short hair, 2: medium hair, 3: long hair, 4: braid.
5271
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
5272
+ """
4290
5273
  return self._Length
4291
5274
 
4292
5275
  @Length.setter
@@ -4295,6 +5278,10 @@ The `Type` values of the `AttributeItem` include: 0: black; 1: golden; 2: brown;
4295
5278
 
4296
5279
  @property
4297
5280
  def Bang(self):
5281
+ """Bang information.
5282
+ The `Type` values of the `AttributeItem` include: 0: no bang; 1: bang detected.
5283
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
5284
+ """
4298
5285
  return self._Bang
4299
5286
 
4300
5287
  @Bang.setter
@@ -4303,6 +5290,10 @@ The `Type` values of the `AttributeItem` include: 0: black; 1: golden; 2: brown;
4303
5290
 
4304
5291
  @property
4305
5292
  def Color(self):
5293
+ """Hair color information.
5294
+ The `Type` values of the `AttributeItem` include: 0: black; 1: golden; 2: brown; 3: gray.
5295
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
5296
+ """
4306
5297
  return self._Color
4307
5298
 
4308
5299
  @Color.setter
@@ -4349,6 +5340,10 @@ The `Type` values of the `AttributeItem` include: 0: no hat; 1: red; 2: yellow;
4349
5340
 
4350
5341
  @property
4351
5342
  def Style(self):
5343
+ """Hat wearing status information.
5344
+ The `Type` values of the `AttributeItem` include: 0: no hat; 1: general hat; 2: helmet; 3: security guard hat.
5345
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
5346
+ """
4352
5347
  return self._Style
4353
5348
 
4354
5349
  @Style.setter
@@ -4357,6 +5352,10 @@ The `Type` values of the `AttributeItem` include: 0: no hat; 1: red; 2: yellow;
4357
5352
 
4358
5353
  @property
4359
5354
  def Color(self):
5355
+ """Hat color.
5356
+ The `Type` values of the `AttributeItem` include: 0: no hat; 1: red; 2: yellow; 3: blue; 4: black; 5: gray; 6: mixed colors.
5357
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
5358
+ """
4360
5359
  return self._Color
4361
5360
 
4362
5361
  @Color.setter
@@ -4401,6 +5400,9 @@ class HeadPose(AbstractModel):
4401
5400
 
4402
5401
  @property
4403
5402
  def Pitch(self):
5403
+ """Pitch. Value range: [-30,30].
5404
+ :rtype: int
5405
+ """
4404
5406
  return self._Pitch
4405
5407
 
4406
5408
  @Pitch.setter
@@ -4409,6 +5411,9 @@ class HeadPose(AbstractModel):
4409
5411
 
4410
5412
  @property
4411
5413
  def Yaw(self):
5414
+ """Yaw. Value range: [-30,30].
5415
+ :rtype: int
5416
+ """
4412
5417
  return self._Yaw
4413
5418
 
4414
5419
  @Yaw.setter
@@ -4417,6 +5422,9 @@ class HeadPose(AbstractModel):
4417
5422
 
4418
5423
  @property
4419
5424
  def Roll(self):
5425
+ """Roll. Value range: [-180,180].
5426
+ :rtype: int
5427
+ """
4420
5428
  return self._Roll
4421
5429
 
4422
5430
  @Roll.setter
@@ -4461,6 +5469,9 @@ class ModifyGroupRequest(AbstractModel):
4461
5469
 
4462
5470
  @property
4463
5471
  def GroupId(self):
5472
+ """Group ID, which is the `GroupId` in the `CreateGroup` API.
5473
+ :rtype: str
5474
+ """
4464
5475
  return self._GroupId
4465
5476
 
4466
5477
  @GroupId.setter
@@ -4469,6 +5480,9 @@ class ModifyGroupRequest(AbstractModel):
4469
5480
 
4470
5481
  @property
4471
5482
  def GroupName(self):
5483
+ """Group name
5484
+ :rtype: str
5485
+ """
4472
5486
  return self._GroupName
4473
5487
 
4474
5488
  @GroupName.setter
@@ -4477,6 +5491,9 @@ class ModifyGroupRequest(AbstractModel):
4477
5491
 
4478
5492
  @property
4479
5493
  def GroupExDescriptionInfos(self):
5494
+ """Custom description field of the group to be modified, which is a `key-value` pair.
5495
+ :rtype: list of GroupExDescriptionInfo
5496
+ """
4480
5497
  return self._GroupExDescriptionInfos
4481
5498
 
4482
5499
  @GroupExDescriptionInfos.setter
@@ -4485,6 +5502,9 @@ class ModifyGroupRequest(AbstractModel):
4485
5502
 
4486
5503
  @property
4487
5504
  def Tag(self):
5505
+ """Group remarks
5506
+ :rtype: str
5507
+ """
4488
5508
  return self._Tag
4489
5509
 
4490
5510
  @Tag.setter
@@ -4526,6 +5546,9 @@ class ModifyGroupResponse(AbstractModel):
4526
5546
 
4527
5547
  @property
4528
5548
  def RequestId(self):
5549
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
5550
+ :rtype: str
5551
+ """
4529
5552
  return self._RequestId
4530
5553
 
4531
5554
  @RequestId.setter
@@ -4557,6 +5580,9 @@ class ModifyPersonGroupInfoRequest(AbstractModel):
4557
5580
 
4558
5581
  @property
4559
5582
  def GroupId(self):
5583
+ """Group ID, which is the `GroupId` in the `CreateGroup` API.
5584
+ :rtype: str
5585
+ """
4560
5586
  return self._GroupId
4561
5587
 
4562
5588
  @GroupId.setter
@@ -4565,6 +5591,9 @@ class ModifyPersonGroupInfoRequest(AbstractModel):
4565
5591
 
4566
5592
  @property
4567
5593
  def PersonId(self):
5594
+ """Person ID, which is the `PersonId` in the `CreatePerson` API.
5595
+ :rtype: str
5596
+ """
4568
5597
  return self._PersonId
4569
5598
 
4570
5599
  @PersonId.setter
@@ -4573,6 +5602,9 @@ class ModifyPersonGroupInfoRequest(AbstractModel):
4573
5602
 
4574
5603
  @property
4575
5604
  def PersonExDescriptionInfos(self):
5605
+ """Custom description field of the person to be modified, which is a `key-value` pair.
5606
+ :rtype: list of PersonExDescriptionInfo
5607
+ """
4576
5608
  return self._PersonExDescriptionInfos
4577
5609
 
4578
5610
  @PersonExDescriptionInfos.setter
@@ -4613,6 +5645,9 @@ class ModifyPersonGroupInfoResponse(AbstractModel):
4613
5645
 
4614
5646
  @property
4615
5647
  def RequestId(self):
5648
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
5649
+ :rtype: str
5650
+ """
4616
5651
  return self._RequestId
4617
5652
 
4618
5653
  @RequestId.setter
@@ -4639,6 +5674,10 @@ The `Type` values of the `AttributeItem` include: 0: closed; 1: open.
4639
5674
 
4640
5675
  @property
4641
5676
  def MouthOpen(self):
5677
+ """Whether the mouth is open.
5678
+ The `Type` values of the `AttributeItem` include: 0: closed; 1: open.
5679
+ :rtype: :class:`tencentcloud.iai.v20200303.models.AttributeItem`
5680
+ """
4642
5681
  return self._MouthOpen
4643
5682
 
4644
5683
  @MouthOpen.setter
@@ -4678,6 +5717,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
4678
5717
 
4679
5718
  @property
4680
5719
  def PersonExDescriptionIndex(self):
5720
+ """Person description field index, whose value starts from 0.
5721
+ Note: this field may return null, indicating that no valid values can be obtained.
5722
+ :rtype: int
5723
+ """
4681
5724
  return self._PersonExDescriptionIndex
4682
5725
 
4683
5726
  @PersonExDescriptionIndex.setter
@@ -4686,6 +5729,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
4686
5729
 
4687
5730
  @property
4688
5731
  def PersonExDescription(self):
5732
+ """Content of the person description field to be updated
5733
+ :rtype: str
5734
+ """
4689
5735
  return self._PersonExDescription
4690
5736
 
4691
5737
  @PersonExDescription.setter
@@ -4723,6 +5769,9 @@ class PersonGroupInfo(AbstractModel):
4723
5769
 
4724
5770
  @property
4725
5771
  def GroupId(self):
5772
+ """ID of the group that contains this person
5773
+ :rtype: str
5774
+ """
4726
5775
  return self._GroupId
4727
5776
 
4728
5777
  @GroupId.setter
@@ -4731,6 +5780,9 @@ class PersonGroupInfo(AbstractModel):
4731
5780
 
4732
5781
  @property
4733
5782
  def PersonExDescriptions(self):
5783
+ """Content of person description field
5784
+ :rtype: list of str
5785
+ """
4734
5786
  return self._PersonExDescriptions
4735
5787
 
4736
5788
  @PersonExDescriptions.setter
@@ -4781,6 +5833,9 @@ The Unix epoch is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Tim
4781
5833
 
4782
5834
  @property
4783
5835
  def PersonName(self):
5836
+ """Person name
5837
+ :rtype: str
5838
+ """
4784
5839
  return self._PersonName
4785
5840
 
4786
5841
  @PersonName.setter
@@ -4789,6 +5844,9 @@ The Unix epoch is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Tim
4789
5844
 
4790
5845
  @property
4791
5846
  def PersonId(self):
5847
+ """Person ID
5848
+ :rtype: str
5849
+ """
4792
5850
  return self._PersonId
4793
5851
 
4794
5852
  @PersonId.setter
@@ -4797,6 +5855,9 @@ The Unix epoch is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Tim
4797
5855
 
4798
5856
  @property
4799
5857
  def Gender(self):
5858
+ """Person gender
5859
+ :rtype: int
5860
+ """
4800
5861
  return self._Gender
4801
5862
 
4802
5863
  @Gender.setter
@@ -4805,6 +5866,9 @@ The Unix epoch is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Tim
4805
5866
 
4806
5867
  @property
4807
5868
  def PersonExDescriptions(self):
5869
+ """Content of person description field
5870
+ :rtype: list of str
5871
+ """
4808
5872
  return self._PersonExDescriptions
4809
5873
 
4810
5874
  @PersonExDescriptions.setter
@@ -4813,6 +5877,9 @@ The Unix epoch is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Tim
4813
5877
 
4814
5878
  @property
4815
5879
  def FaceIds(self):
5880
+ """List of contained face images
5881
+ :rtype: list of str
5882
+ """
4816
5883
  return self._FaceIds
4817
5884
 
4818
5885
  @FaceIds.setter
@@ -4821,6 +5888,10 @@ The Unix epoch is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Tim
4821
5888
 
4822
5889
  @property
4823
5890
  def CreationTimestamp(self):
5891
+ """Person creation time, measured in the number of milliseconds elapsed since the Unix epoch
5892
+ The Unix epoch is 00:00:00, Thursday, January 1, 1970, Coordinated Universal Time (UTC). For more information, please see the Unix time document.
5893
+ :rtype: int
5894
+ """
4824
5895
  return self._CreationTimestamp
4825
5896
 
4826
5897
  @CreationTimestamp.setter
@@ -4862,6 +5933,9 @@ class Point(AbstractModel):
4862
5933
 
4863
5934
  @property
4864
5935
  def X(self):
5936
+ """X coordinate
5937
+ :rtype: int
5938
+ """
4865
5939
  return self._X
4866
5940
 
4867
5941
  @X.setter
@@ -4870,6 +5944,9 @@ class Point(AbstractModel):
4870
5944
 
4871
5945
  @property
4872
5946
  def Y(self):
5947
+ """Y coordinate
5948
+ :rtype: int
5949
+ """
4873
5950
  return self._Y
4874
5951
 
4875
5952
  @Y.setter
@@ -4910,6 +5987,9 @@ class Result(AbstractModel):
4910
5987
 
4911
5988
  @property
4912
5989
  def Candidates(self):
5990
+ """Most matching candidate recognized
5991
+ :rtype: list of Candidate
5992
+ """
4913
5993
  return self._Candidates
4914
5994
 
4915
5995
  @Candidates.setter
@@ -4918,6 +5998,9 @@ class Result(AbstractModel):
4918
5998
 
4919
5999
  @property
4920
6000
  def FaceRect(self):
6001
+ """Position of detected face frame
6002
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceRect`
6003
+ """
4921
6004
  return self._FaceRect
4922
6005
 
4923
6006
  @FaceRect.setter
@@ -4926,6 +6009,9 @@ class Result(AbstractModel):
4926
6009
 
4927
6010
  @property
4928
6011
  def RetCode(self):
6012
+ """The status return code for the face image detected. Valid values: `0` - normal; `-1601` - the image does not meet the quality requirements, in which case `Candidate` is empty; `-1604` - the face similarity is not higher than `FaceMatchThreshold`.
6013
+ :rtype: int
6014
+ """
4929
6015
  return self._RetCode
4930
6016
 
4931
6017
  @RetCode.setter
@@ -4975,6 +6061,9 @@ class ResultsReturnsByGroup(AbstractModel):
4975
6061
 
4976
6062
  @property
4977
6063
  def FaceRect(self):
6064
+ """Position of detected face frame
6065
+ :rtype: :class:`tencentcloud.iai.v20200303.models.FaceRect`
6066
+ """
4978
6067
  return self._FaceRect
4979
6068
 
4980
6069
  @FaceRect.setter
@@ -4983,6 +6072,9 @@ class ResultsReturnsByGroup(AbstractModel):
4983
6072
 
4984
6073
  @property
4985
6074
  def GroupCandidates(self):
6075
+ """Recognition result.
6076
+ :rtype: list of GroupCandidate
6077
+ """
4986
6078
  return self._GroupCandidates
4987
6079
 
4988
6080
  @GroupCandidates.setter
@@ -4991,6 +6083,10 @@ class ResultsReturnsByGroup(AbstractModel):
4991
6083
 
4992
6084
  @property
4993
6085
  def RetCode(self):
6086
+ """Status return code of detected face image. 0: normal.
6087
+ -1601: the image quality control requirement is not met; in this case, `Candidate` is empty.
6088
+ :rtype: int
6089
+ """
4994
6090
  return self._RetCode
4995
6091
 
4996
6092
  @RetCode.setter
@@ -5079,6 +6175,10 @@ If the image quality does not meet the requirement, the returned result will pro
5079
6175
 
5080
6176
  @property
5081
6177
  def GroupIds(self):
6178
+ """List of groups to be searched in (up to 100). The array element value is the `GroupId` in the `CreateGroup` API.
6179
+ You cannot search for groups using different algorithm model versions (`FaceModelVersion`) at a time.
6180
+ :rtype: list of str
6181
+ """
5082
6182
  return self._GroupIds
5083
6183
 
5084
6184
  @GroupIds.setter
@@ -5087,6 +6187,11 @@ If the image quality does not meet the requirement, the returned result will pro
5087
6187
 
5088
6188
  @property
5089
6189
  def Image(self):
6190
+ """Base64-encoded image data, which cannot exceed 5 MB.
6191
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
6192
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
6193
+ :rtype: str
6194
+ """
5090
6195
  return self._Image
5091
6196
 
5092
6197
  @Image.setter
@@ -5095,6 +6200,14 @@ If the image quality does not meet the requirement, the returned result will pro
5095
6200
 
5096
6201
  @property
5097
6202
  def Url(self):
6203
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
6204
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
6205
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
6206
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
6207
+ The download speed and stability of non-Tencent Cloud URLs may be low.
6208
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
6209
+ :rtype: str
6210
+ """
5098
6211
  return self._Url
5099
6212
 
5100
6213
  @Url.setter
@@ -5103,6 +6216,11 @@ If the image quality does not meet the requirement, the returned result will pro
5103
6216
 
5104
6217
  @property
5105
6218
  def MaxFaceNum(self):
6219
+ """Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10.
6220
+ `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized.
6221
+ For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized.
6222
+ :rtype: int
6223
+ """
5106
6224
  return self._MaxFaceNum
5107
6225
 
5108
6226
  @MaxFaceNum.setter
@@ -5111,6 +6229,9 @@ If the image quality does not meet the requirement, the returned result will pro
5111
6229
 
5112
6230
  @property
5113
6231
  def MinFaceSize(self):
6232
+ """Minimum height and width of face in px. Default value: 34. Face images whose value is below 34 cannot be recognized. We recommend setting this parameter to 80.
6233
+ :rtype: int
6234
+ """
5114
6235
  return self._MinFaceSize
5115
6236
 
5116
6237
  @MinFaceSize.setter
@@ -5119,6 +6240,11 @@ If the image quality does not meet the requirement, the returned result will pro
5119
6240
 
5120
6241
  @property
5121
6242
  def MaxPersonNum(self):
6243
+ """Number of the most similar persons returned for one single recognized face image. Default value: 5. Maximum value: 100.
6244
+ For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned.
6245
+ The greater the value, the longer the processing time. We recommend setting a value below 10.
6246
+ :rtype: int
6247
+ """
5122
6248
  return self._MaxPersonNum
5123
6249
 
5124
6250
  @MaxPersonNum.setter
@@ -5127,6 +6253,9 @@ If the image quality does not meet the requirement, the returned result will pro
5127
6253
 
5128
6254
  @property
5129
6255
  def NeedPersonInfo(self):
6256
+ """Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default.
6257
+ :rtype: int
6258
+ """
5130
6259
  return self._NeedPersonInfo
5131
6260
 
5132
6261
  @NeedPersonInfo.setter
@@ -5135,6 +6264,16 @@ If the image quality does not meet the requirement, the returned result will pro
5135
6264
 
5136
6265
  @property
5137
6266
  def QualityControl(self):
6267
+ """Image quality control.
6268
+ 0: no control.
6269
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
6270
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
6271
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
6272
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
6273
+ Default value: 0.
6274
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
6275
+ :rtype: int
6276
+ """
5138
6277
  return self._QualityControl
5139
6278
 
5140
6279
  @QualityControl.setter
@@ -5143,6 +6282,9 @@ If the image quality does not meet the requirement, the returned result will pro
5143
6282
 
5144
6283
  @property
5145
6284
  def FaceMatchThreshold(self):
6285
+ """In the output parameter `Score`, the result will be returned only if the result value is above the `FaceMatchThreshold` value. Default value: 0.
6286
+ :rtype: float
6287
+ """
5146
6288
  return self._FaceMatchThreshold
5147
6289
 
5148
6290
  @FaceMatchThreshold.setter
@@ -5151,6 +6293,9 @@ If the image quality does not meet the requirement, the returned result will pro
5151
6293
 
5152
6294
  @property
5153
6295
  def NeedRotateDetection(self):
6296
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
6297
+ :rtype: int
6298
+ """
5154
6299
  return self._NeedRotateDetection
5155
6300
 
5156
6301
  @NeedRotateDetection.setter
@@ -5202,6 +6347,9 @@ class SearchFacesResponse(AbstractModel):
5202
6347
 
5203
6348
  @property
5204
6349
  def Results(self):
6350
+ """Recognition result.
6351
+ :rtype: list of Result
6352
+ """
5205
6353
  return self._Results
5206
6354
 
5207
6355
  @Results.setter
@@ -5210,6 +6358,9 @@ class SearchFacesResponse(AbstractModel):
5210
6358
 
5211
6359
  @property
5212
6360
  def FaceNum(self):
6361
+ """Number of faces included in searched groups.
6362
+ :rtype: int
6363
+ """
5213
6364
  return self._FaceNum
5214
6365
 
5215
6366
  @FaceNum.setter
@@ -5218,6 +6369,9 @@ class SearchFacesResponse(AbstractModel):
5218
6369
 
5219
6370
  @property
5220
6371
  def FaceModelVersion(self):
6372
+ """Algorithm model version used for face recognition.
6373
+ :rtype: str
6374
+ """
5221
6375
  return self._FaceModelVersion
5222
6376
 
5223
6377
  @FaceModelVersion.setter
@@ -5226,6 +6380,9 @@ class SearchFacesResponse(AbstractModel):
5226
6380
 
5227
6381
  @property
5228
6382
  def RequestId(self):
6383
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
6384
+ :rtype: str
6385
+ """
5229
6386
  return self._RequestId
5230
6387
 
5231
6388
  @RequestId.setter
@@ -5306,6 +6463,10 @@ Value range: [0.0,100.0).
5306
6463
 
5307
6464
  @property
5308
6465
  def GroupIds(self):
6466
+ """List of groups to be searched in (up to 60). The array element value is the `GroupId` in the `CreateGroup` API.
6467
+ You cannot search for groups using different algorithm model versions (`FaceModelVersion`) at a time.
6468
+ :rtype: list of str
6469
+ """
5309
6470
  return self._GroupIds
5310
6471
 
5311
6472
  @GroupIds.setter
@@ -5314,6 +6475,11 @@ Value range: [0.0,100.0).
5314
6475
 
5315
6476
  @property
5316
6477
  def Image(self):
6478
+ """Base64-encoded image data, which cannot exceed 5 MB.
6479
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
6480
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
6481
+ :rtype: str
6482
+ """
5317
6483
  return self._Image
5318
6484
 
5319
6485
  @Image.setter
@@ -5322,6 +6488,14 @@ Value range: [0.0,100.0).
5322
6488
 
5323
6489
  @property
5324
6490
  def Url(self):
6491
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
6492
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
6493
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
6494
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
6495
+ The download speed and stability of non-Tencent Cloud URLs may be low.
6496
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
6497
+ :rtype: str
6498
+ """
5325
6499
  return self._Url
5326
6500
 
5327
6501
  @Url.setter
@@ -5330,6 +6504,11 @@ Value range: [0.0,100.0).
5330
6504
 
5331
6505
  @property
5332
6506
  def MaxFaceNum(self):
6507
+ """Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10.
6508
+ `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized.
6509
+ For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized.
6510
+ :rtype: int
6511
+ """
5333
6512
  return self._MaxFaceNum
5334
6513
 
5335
6514
  @MaxFaceNum.setter
@@ -5338,6 +6517,9 @@ Value range: [0.0,100.0).
5338
6517
 
5339
6518
  @property
5340
6519
  def MinFaceSize(self):
6520
+ """Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. We recommend setting this parameter to 80.
6521
+ :rtype: int
6522
+ """
5341
6523
  return self._MinFaceSize
5342
6524
 
5343
6525
  @MinFaceSize.setter
@@ -5346,6 +6528,10 @@ Value range: [0.0,100.0).
5346
6528
 
5347
6529
  @property
5348
6530
  def MaxPersonNumPerGroup(self):
6531
+ """Detected faces, which is corresponding to the maximum number of returned most matching persons. Default value: 5. Maximum value: 10.
6532
+ For example, if `MaxFaceNum` is 3, `MaxPersonNumPerGroup` is 5, and the `GroupIds` length is 3, up to 45 (3 * 5 * 3) persons will be returned.
6533
+ :rtype: int
6534
+ """
5349
6535
  return self._MaxPersonNumPerGroup
5350
6536
 
5351
6537
  @MaxPersonNumPerGroup.setter
@@ -5354,6 +6540,9 @@ Value range: [0.0,100.0).
5354
6540
 
5355
6541
  @property
5356
6542
  def NeedPersonInfo(self):
6543
+ """Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default.
6544
+ :rtype: int
6545
+ """
5357
6546
  return self._NeedPersonInfo
5358
6547
 
5359
6548
  @NeedPersonInfo.setter
@@ -5362,6 +6551,16 @@ Value range: [0.0,100.0).
5362
6551
 
5363
6552
  @property
5364
6553
  def QualityControl(self):
6554
+ """Image quality control.
6555
+ 0: no control.
6556
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
6557
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
6558
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
6559
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
6560
+ Default value: 0.
6561
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
6562
+ :rtype: int
6563
+ """
5365
6564
  return self._QualityControl
5366
6565
 
5367
6566
  @QualityControl.setter
@@ -5370,6 +6569,11 @@ Value range: [0.0,100.0).
5370
6569
 
5371
6570
  @property
5372
6571
  def FaceMatchThreshold(self):
6572
+ """In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value.
6573
+ Default value: 0.
6574
+ Value range: [0.0,100.0).
6575
+ :rtype: float
6576
+ """
5373
6577
  return self._FaceMatchThreshold
5374
6578
 
5375
6579
  @FaceMatchThreshold.setter
@@ -5378,6 +6582,9 @@ Value range: [0.0,100.0).
5378
6582
 
5379
6583
  @property
5380
6584
  def NeedRotateDetection(self):
6585
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
6586
+ :rtype: int
6587
+ """
5381
6588
  return self._NeedRotateDetection
5382
6589
 
5383
6590
  @NeedRotateDetection.setter
@@ -5429,6 +6636,9 @@ class SearchFacesReturnsByGroupResponse(AbstractModel):
5429
6636
 
5430
6637
  @property
5431
6638
  def FaceNum(self):
6639
+ """Number of faces included in searched groups.
6640
+ :rtype: int
6641
+ """
5432
6642
  return self._FaceNum
5433
6643
 
5434
6644
  @FaceNum.setter
@@ -5437,6 +6647,9 @@ class SearchFacesReturnsByGroupResponse(AbstractModel):
5437
6647
 
5438
6648
  @property
5439
6649
  def ResultsReturnsByGroup(self):
6650
+ """Recognition result.
6651
+ :rtype: list of ResultsReturnsByGroup
6652
+ """
5440
6653
  return self._ResultsReturnsByGroup
5441
6654
 
5442
6655
  @ResultsReturnsByGroup.setter
@@ -5445,6 +6658,9 @@ class SearchFacesReturnsByGroupResponse(AbstractModel):
5445
6658
 
5446
6659
  @property
5447
6660
  def FaceModelVersion(self):
6661
+ """Algorithm model version used for face recognition.
6662
+ :rtype: str
6663
+ """
5448
6664
  return self._FaceModelVersion
5449
6665
 
5450
6666
  @FaceModelVersion.setter
@@ -5453,6 +6669,9 @@ class SearchFacesReturnsByGroupResponse(AbstractModel):
5453
6669
 
5454
6670
  @property
5455
6671
  def RequestId(self):
6672
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
6673
+ :rtype: str
6674
+ """
5456
6675
  return self._RequestId
5457
6676
 
5458
6677
  @RequestId.setter
@@ -5532,6 +6751,9 @@ If the image quality does not meet the requirement, the returned result will pro
5532
6751
 
5533
6752
  @property
5534
6753
  def GroupIds(self):
6754
+ """List of groups to be searched in (up to 100). The array element value is the `GroupId` in the `CreateGroup` API.
6755
+ :rtype: list of str
6756
+ """
5535
6757
  return self._GroupIds
5536
6758
 
5537
6759
  @GroupIds.setter
@@ -5540,6 +6762,12 @@ If the image quality does not meet the requirement, the returned result will pro
5540
6762
 
5541
6763
  @property
5542
6764
  def Image(self):
6765
+ """Base64-encoded image data, which cannot exceed 5 MB.
6766
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
6767
+ If there are multiple faces in the image, only the face with the largest size will be selected.
6768
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
6769
+ :rtype: str
6770
+ """
5543
6771
  return self._Image
5544
6772
 
5545
6773
  @Image.setter
@@ -5548,6 +6776,14 @@ If the image quality does not meet the requirement, the returned result will pro
5548
6776
 
5549
6777
  @property
5550
6778
  def Url(self):
6779
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
6780
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
6781
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
6782
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
6783
+ The download speed and stability of non-Tencent Cloud URLs may be low.
6784
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
6785
+ :rtype: str
6786
+ """
5551
6787
  return self._Url
5552
6788
 
5553
6789
  @Url.setter
@@ -5556,6 +6792,11 @@ If the image quality does not meet the requirement, the returned result will pro
5556
6792
 
5557
6793
  @property
5558
6794
  def MaxFaceNum(self):
6795
+ """Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10.
6796
+ `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized.
6797
+ For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized.
6798
+ :rtype: int
6799
+ """
5559
6800
  return self._MaxFaceNum
5560
6801
 
5561
6802
  @MaxFaceNum.setter
@@ -5564,6 +6805,9 @@ If the image quality does not meet the requirement, the returned result will pro
5564
6805
 
5565
6806
  @property
5566
6807
  def MinFaceSize(self):
6808
+ """Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. We recommend setting this parameter to 80.
6809
+ :rtype: int
6810
+ """
5567
6811
  return self._MinFaceSize
5568
6812
 
5569
6813
  @MinFaceSize.setter
@@ -5572,6 +6816,11 @@ If the image quality does not meet the requirement, the returned result will pro
5572
6816
 
5573
6817
  @property
5574
6818
  def MaxPersonNum(self):
6819
+ """Number of the most similar persons returned for one single recognized face image. Default value: 5. Maximum value: 100.
6820
+ For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned.
6821
+ The greater the value, the longer the processing time. We recommend setting a value below 10.
6822
+ :rtype: int
6823
+ """
5575
6824
  return self._MaxPersonNum
5576
6825
 
5577
6826
  @MaxPersonNum.setter
@@ -5580,6 +6829,16 @@ If the image quality does not meet the requirement, the returned result will pro
5580
6829
 
5581
6830
  @property
5582
6831
  def QualityControl(self):
6832
+ """Image quality control.
6833
+ 0: no control.
6834
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
6835
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
6836
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
6837
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
6838
+ Default value: 0.
6839
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
6840
+ :rtype: int
6841
+ """
5583
6842
  return self._QualityControl
5584
6843
 
5585
6844
  @QualityControl.setter
@@ -5588,6 +6847,9 @@ If the image quality does not meet the requirement, the returned result will pro
5588
6847
 
5589
6848
  @property
5590
6849
  def FaceMatchThreshold(self):
6850
+ """In the output parameter `Score`, the result will be returned only if the result value is greater than or equal to the `FaceMatchThreshold` value. Default value: 0. Value range: [0.0,100.0).
6851
+ :rtype: float
6852
+ """
5591
6853
  return self._FaceMatchThreshold
5592
6854
 
5593
6855
  @FaceMatchThreshold.setter
@@ -5596,6 +6858,9 @@ If the image quality does not meet the requirement, the returned result will pro
5596
6858
 
5597
6859
  @property
5598
6860
  def NeedPersonInfo(self):
6861
+ """Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default.
6862
+ :rtype: int
6863
+ """
5599
6864
  return self._NeedPersonInfo
5600
6865
 
5601
6866
  @NeedPersonInfo.setter
@@ -5604,6 +6869,9 @@ If the image quality does not meet the requirement, the returned result will pro
5604
6869
 
5605
6870
  @property
5606
6871
  def NeedRotateDetection(self):
6872
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
6873
+ :rtype: int
6874
+ """
5607
6875
  return self._NeedRotateDetection
5608
6876
 
5609
6877
  @NeedRotateDetection.setter
@@ -5656,6 +6924,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
5656
6924
 
5657
6925
  @property
5658
6926
  def Results(self):
6927
+ """Recognition result.
6928
+ :rtype: list of Result
6929
+ """
5659
6930
  return self._Results
5660
6931
 
5661
6932
  @Results.setter
@@ -5664,6 +6935,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
5664
6935
 
5665
6936
  @property
5666
6937
  def PersonNum(self):
6938
+ """Number of the persons included in searched groups. If the quality of all faces in the input image does not meet the requirement, 0 will be returned.
6939
+ :rtype: int
6940
+ """
5667
6941
  return self._PersonNum
5668
6942
 
5669
6943
  @PersonNum.setter
@@ -5672,6 +6946,10 @@ Note: this field may return null, indicating that no valid values can be obtaine
5672
6946
 
5673
6947
  @property
5674
6948
  def FaceModelVersion(self):
6949
+ """Algorithm model version used for face recognition.
6950
+ Note: this field may return null, indicating that no valid values can be obtained.
6951
+ :rtype: str
6952
+ """
5675
6953
  return self._FaceModelVersion
5676
6954
 
5677
6955
  @FaceModelVersion.setter
@@ -5680,6 +6958,9 @@ Note: this field may return null, indicating that no valid values can be obtaine
5680
6958
 
5681
6959
  @property
5682
6960
  def RequestId(self):
6961
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
6962
+ :rtype: str
6963
+ """
5683
6964
  return self._RequestId
5684
6965
 
5685
6966
  @RequestId.setter
@@ -5757,6 +7038,9 @@ If the image quality does not meet the requirement, the returned result will pro
5757
7038
 
5758
7039
  @property
5759
7040
  def GroupIds(self):
7041
+ """List of groups to be searched in (up to 60). The array element value is the `GroupId` in the `CreateGroup` API.
7042
+ :rtype: list of str
7043
+ """
5760
7044
  return self._GroupIds
5761
7045
 
5762
7046
  @GroupIds.setter
@@ -5765,6 +7049,11 @@ If the image quality does not meet the requirement, the returned result will pro
5765
7049
 
5766
7050
  @property
5767
7051
  def Image(self):
7052
+ """Base64-encoded image data, which cannot exceed 5 MB.
7053
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
7054
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
7055
+ :rtype: str
7056
+ """
5768
7057
  return self._Image
5769
7058
 
5770
7059
  @Image.setter
@@ -5773,6 +7062,14 @@ If the image quality does not meet the requirement, the returned result will pro
5773
7062
 
5774
7063
  @property
5775
7064
  def Url(self):
7065
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
7066
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
7067
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
7068
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
7069
+ The download speed and stability of non-Tencent Cloud URLs may be low.
7070
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
7071
+ :rtype: str
7072
+ """
5776
7073
  return self._Url
5777
7074
 
5778
7075
  @Url.setter
@@ -5781,6 +7078,11 @@ If the image quality does not meet the requirement, the returned result will pro
5781
7078
 
5782
7079
  @property
5783
7080
  def MaxFaceNum(self):
7081
+ """Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10.
7082
+ `MaxFaceNum` is used to control the number of faces to be searched for if there are multiple faces in the input image to be recognized.
7083
+ For example, if the input image in `Image` or `Url` contains multiple faces and `MaxFaceNum` is 5, top 5 faces with the largest size in the image will be recognized.
7084
+ :rtype: int
7085
+ """
5784
7086
  return self._MaxFaceNum
5785
7087
 
5786
7088
  @MaxFaceNum.setter
@@ -5789,6 +7091,9 @@ If the image quality does not meet the requirement, the returned result will pro
5789
7091
 
5790
7092
  @property
5791
7093
  def MinFaceSize(self):
7094
+ """Minimum height and width of face in px. Default value: 34. A value below 34 will affect the search accuracy. We recommend setting this parameter to 80.
7095
+ :rtype: int
7096
+ """
5792
7097
  return self._MinFaceSize
5793
7098
 
5794
7099
  @MinFaceSize.setter
@@ -5797,6 +7102,10 @@ If the image quality does not meet the requirement, the returned result will pro
5797
7102
 
5798
7103
  @property
5799
7104
  def MaxPersonNumPerGroup(self):
7105
+ """Detected faces, which is corresponding to the maximum number of returned most matching persons. Default value: 5. Maximum value: 10.
7106
+ For example, if `MaxFaceNum` is 3, `MaxPersonNumPerGroup` is 5, and the `GroupIds` length is 3, up to 45 (3 * 5 * 3) persons will be returned.
7107
+ :rtype: int
7108
+ """
5800
7109
  return self._MaxPersonNumPerGroup
5801
7110
 
5802
7111
  @MaxPersonNumPerGroup.setter
@@ -5805,6 +7114,16 @@ If the image quality does not meet the requirement, the returned result will pro
5805
7114
 
5806
7115
  @property
5807
7116
  def QualityControl(self):
7117
+ """Image quality control.
7118
+ 0: no control.
7119
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
7120
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
7121
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
7122
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
7123
+ Default value: 0.
7124
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
7125
+ :rtype: int
7126
+ """
5808
7127
  return self._QualityControl
5809
7128
 
5810
7129
  @QualityControl.setter
@@ -5813,6 +7132,9 @@ If the image quality does not meet the requirement, the returned result will pro
5813
7132
 
5814
7133
  @property
5815
7134
  def FaceMatchThreshold(self):
7135
+ """In the output parameter `Score`, the result will be returned only if the result value is above the `FaceMatchThreshold` value. Default value: 0.
7136
+ :rtype: float
7137
+ """
5816
7138
  return self._FaceMatchThreshold
5817
7139
 
5818
7140
  @FaceMatchThreshold.setter
@@ -5821,6 +7143,9 @@ If the image quality does not meet the requirement, the returned result will pro
5821
7143
 
5822
7144
  @property
5823
7145
  def NeedPersonInfo(self):
7146
+ """Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default.
7147
+ :rtype: int
7148
+ """
5824
7149
  return self._NeedPersonInfo
5825
7150
 
5826
7151
  @NeedPersonInfo.setter
@@ -5829,6 +7154,9 @@ If the image quality does not meet the requirement, the returned result will pro
5829
7154
 
5830
7155
  @property
5831
7156
  def NeedRotateDetection(self):
7157
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
7158
+ :rtype: int
7159
+ """
5832
7160
  return self._NeedRotateDetection
5833
7161
 
5834
7162
  @NeedRotateDetection.setter
@@ -5880,6 +7208,9 @@ class SearchPersonsReturnsByGroupResponse(AbstractModel):
5880
7208
 
5881
7209
  @property
5882
7210
  def PersonNum(self):
7211
+ """Number of the persons included in searched groups. If the quality of all faces in the input image does not meet the requirement, 0 will be returned.
7212
+ :rtype: int
7213
+ """
5883
7214
  return self._PersonNum
5884
7215
 
5885
7216
  @PersonNum.setter
@@ -5888,6 +7219,9 @@ class SearchPersonsReturnsByGroupResponse(AbstractModel):
5888
7219
 
5889
7220
  @property
5890
7221
  def ResultsReturnsByGroup(self):
7222
+ """Recognition result.
7223
+ :rtype: list of ResultsReturnsByGroup
7224
+ """
5891
7225
  return self._ResultsReturnsByGroup
5892
7226
 
5893
7227
  @ResultsReturnsByGroup.setter
@@ -5896,6 +7230,9 @@ class SearchPersonsReturnsByGroupResponse(AbstractModel):
5896
7230
 
5897
7231
  @property
5898
7232
  def FaceModelVersion(self):
7233
+ """Algorithm model version used for face recognition.
7234
+ :rtype: str
7235
+ """
5899
7236
  return self._FaceModelVersion
5900
7237
 
5901
7238
  @FaceModelVersion.setter
@@ -5904,6 +7241,9 @@ class SearchPersonsReturnsByGroupResponse(AbstractModel):
5904
7241
 
5905
7242
  @property
5906
7243
  def RequestId(self):
7244
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
7245
+ :rtype: str
7246
+ """
5907
7247
  return self._RequestId
5908
7248
 
5909
7249
  @RequestId.setter
@@ -5965,6 +7305,9 @@ If the image quality does not meet the requirement, the returned result will pro
5965
7305
 
5966
7306
  @property
5967
7307
  def PersonId(self):
7308
+ """ID of the person to be verified. For more information on `PersonId`, please see the group management APIs.
7309
+ :rtype: str
7310
+ """
5968
7311
  return self._PersonId
5969
7312
 
5970
7313
  @PersonId.setter
@@ -5973,6 +7316,12 @@ If the image quality does not meet the requirement, the returned result will pro
5973
7316
 
5974
7317
  @property
5975
7318
  def Image(self):
7319
+ """Base64-encoded image data, which cannot exceed 5 MB.
7320
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
7321
+ If there are multiple faces in the image, only the face with the largest size will be selected.
7322
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
7323
+ :rtype: str
7324
+ """
5976
7325
  return self._Image
5977
7326
 
5978
7327
  @Image.setter
@@ -5981,6 +7330,15 @@ If the image quality does not meet the requirement, the returned result will pro
5981
7330
 
5982
7331
  @property
5983
7332
  def Url(self):
7333
+ """Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
7334
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
7335
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
7336
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
7337
+ The download speed and stability of non-Tencent Cloud URLs may be low.
7338
+ If there are multiple faces in the image, only the face with the largest size will be selected.
7339
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
7340
+ :rtype: str
7341
+ """
5984
7342
  return self._Url
5985
7343
 
5986
7344
  @Url.setter
@@ -5989,6 +7347,16 @@ If the image quality does not meet the requirement, the returned result will pro
5989
7347
 
5990
7348
  @property
5991
7349
  def QualityControl(self):
7350
+ """Image quality control.
7351
+ 0: no control.
7352
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
7353
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
7354
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
7355
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
7356
+ Default value: 0.
7357
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
7358
+ :rtype: int
7359
+ """
5992
7360
  return self._QualityControl
5993
7361
 
5994
7362
  @QualityControl.setter
@@ -5997,6 +7365,9 @@ If the image quality does not meet the requirement, the returned result will pro
5997
7365
 
5998
7366
  @property
5999
7367
  def NeedRotateDetection(self):
7368
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
7369
+ :rtype: int
7370
+ """
6000
7371
  return self._NeedRotateDetection
6001
7372
 
6002
7373
  @NeedRotateDetection.setter
@@ -6047,6 +7418,13 @@ The 0.1%, 0.01%, and 0.001% FARs on v2.0 correspond to scores of 70, 80, and 90,
6047
7418
 
6048
7419
  @property
6049
7420
  def Score(self):
7421
+ """Similarity between given face image and `PersonId`. If there are multiple faces under the `PersonId`, the score of the highest similarity will be returned.
7422
+
7423
+ The returned similarity score varies by algorithm version.
7424
+ If you need to verify whether the faces in the two images are the same person, then the 0.1%, 0.01%, and 0.001% FARs on v3.0 correspond to scores of 40, 50, and 60, respectively. Generally, if the score is above 50, it can be judged that they are the same person.
7425
+ The 0.1%, 0.01%, and 0.001% FARs on v2.0 correspond to scores of 70, 80, and 90, respectively. Generally, if the score is above 80, it can be judged that they are the same person.
7426
+ :rtype: float
7427
+ """
6050
7428
  return self._Score
6051
7429
 
6052
7430
  @Score.setter
@@ -6055,6 +7433,9 @@ The 0.1%, 0.01%, and 0.001% FARs on v2.0 correspond to scores of 70, 80, and 90,
6055
7433
 
6056
7434
  @property
6057
7435
  def IsMatch(self):
7436
+ """Whether the person is the one in the image. The fixed threshold score is 60. If you want to adjust the threshold more flexibly, you can take the returned `Score` parameter value for judgment.
7437
+ :rtype: bool
7438
+ """
6058
7439
  return self._IsMatch
6059
7440
 
6060
7441
  @IsMatch.setter
@@ -6063,6 +7444,9 @@ The 0.1%, 0.01%, and 0.001% FARs on v2.0 correspond to scores of 70, 80, and 90,
6063
7444
 
6064
7445
  @property
6065
7446
  def FaceModelVersion(self):
7447
+ """Algorithm model version used for face recognition in the group where the `Person` is, which is set when the group is created.
7448
+ :rtype: str
7449
+ """
6066
7450
  return self._FaceModelVersion
6067
7451
 
6068
7452
  @FaceModelVersion.setter
@@ -6071,6 +7455,9 @@ The 0.1%, 0.01%, and 0.001% FARs on v2.0 correspond to scores of 70, 80, and 90,
6071
7455
 
6072
7456
  @property
6073
7457
  def RequestId(self):
7458
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
7459
+ :rtype: str
7460
+ """
6074
7461
  return self._RequestId
6075
7462
 
6076
7463
  @RequestId.setter
@@ -6127,6 +7514,9 @@ If the image quality does not meet the requirement, the returned result will pro
6127
7514
 
6128
7515
  @property
6129
7516
  def PersonId(self):
7517
+ """ID of the person to be verified. For more information on `PersonId`, please see the group management APIs.
7518
+ :rtype: str
7519
+ """
6130
7520
  return self._PersonId
6131
7521
 
6132
7522
  @PersonId.setter
@@ -6135,6 +7525,12 @@ If the image quality does not meet the requirement, the returned result will pro
6135
7525
 
6136
7526
  @property
6137
7527
  def Image(self):
7528
+ """Base64-encoded data of the image.
7529
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
7530
+ If there are multiple faces in the image, only the face with the largest size will be selected.
7531
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
7532
+ :rtype: str
7533
+ """
6138
7534
  return self._Image
6139
7535
 
6140
7536
  @Image.setter
@@ -6143,6 +7539,15 @@ If the image quality does not meet the requirement, the returned result will pro
6143
7539
 
6144
7540
  @property
6145
7541
  def Url(self):
7542
+ """Image URL
7543
+ The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
7544
+ Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
7545
+ We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
7546
+ The download speed and stability of non-Tencent Cloud URLs may be low.
7547
+ If there are multiple faces in the image, only the face with the largest size will be selected.
7548
+ PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
7549
+ :rtype: str
7550
+ """
6146
7551
  return self._Url
6147
7552
 
6148
7553
  @Url.setter
@@ -6151,6 +7556,16 @@ If the image quality does not meet the requirement, the returned result will pro
6151
7556
 
6152
7557
  @property
6153
7558
  def QualityControl(self):
7559
+ """Image quality control.
7560
+ 0: no control.
7561
+ 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
7562
+ 2: average quality requirement. The image has at least three of the following problems: excessive brightness, excessive dimness, blurriness or average blurriness, covered eyebrows, covered cheeks, and covered chin.
7563
+ 3: high-quality requirement. The image has one to two of the following problems: excessive brightness, excessive dimness, average blurriness, covered eyebrows, covered cheeks, and covered chin.
7564
+ 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
7565
+ Default value: 0.
7566
+ If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
7567
+ :rtype: int
7568
+ """
6154
7569
  return self._QualityControl
6155
7570
 
6156
7571
  @QualityControl.setter
@@ -6159,6 +7574,9 @@ If the image quality does not meet the requirement, the returned result will pro
6159
7574
 
6160
7575
  @property
6161
7576
  def NeedRotateDetection(self):
7577
+ """Whether to enable the support for rotated image recognition. 0: no; 1: yes. Default value: 0. When the face in the image is rotated and the image has no EXIF information, if this parameter is not enabled, the face in the image cannot be correctly detected and recognized. If you are sure that the input image contains EXIF information or the face in the image will not be rotated, do not enable this parameter, as the overall time consumption may increase by hundreds of milliseconds after it is enabled.
7578
+ :rtype: int
7579
+ """
6162
7580
  return self._NeedRotateDetection
6163
7581
 
6164
7582
  @NeedRotateDetection.setter
@@ -6205,6 +7623,9 @@ class VerifyPersonResponse(AbstractModel):
6205
7623
 
6206
7624
  @property
6207
7625
  def Score(self):
7626
+ """Similarity between given face image and `PersonId`. If there are multiple faces under the `PersonId`, their information will be fused for verification.
7627
+ :rtype: float
7628
+ """
6208
7629
  return self._Score
6209
7630
 
6210
7631
  @Score.setter
@@ -6213,6 +7634,9 @@ class VerifyPersonResponse(AbstractModel):
6213
7634
 
6214
7635
  @property
6215
7636
  def IsMatch(self):
7637
+ """Whether the person in the image matches the `PersonId`.
7638
+ :rtype: bool
7639
+ """
6216
7640
  return self._IsMatch
6217
7641
 
6218
7642
  @IsMatch.setter
@@ -6221,6 +7645,9 @@ class VerifyPersonResponse(AbstractModel):
6221
7645
 
6222
7646
  @property
6223
7647
  def FaceModelVersion(self):
7648
+ """Algorithm model version used for face recognition in the group where the `Person` is, which is set when the group is created.
7649
+ :rtype: str
7650
+ """
6224
7651
  return self._FaceModelVersion
6225
7652
 
6226
7653
  @FaceModelVersion.setter
@@ -6229,6 +7656,9 @@ class VerifyPersonResponse(AbstractModel):
6229
7656
 
6230
7657
  @property
6231
7658
  def RequestId(self):
7659
+ """The unique request ID, which is returned for each request. RequestId is required for locating a problem.
7660
+ :rtype: str
7661
+ """
6232
7662
  return self._RequestId
6233
7663
 
6234
7664
  @RequestId.setter