tencentcloud-sdk-nodejs-intl-en 3.0.1466 → 3.0.1468

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.
@@ -149,7 +149,7 @@ The `Type` values of the `AttributeItem` include: 0: small eyes; 1: general eyes
149
149
  }
150
150
 
151
151
  /**
152
- * Most matching candidate recognized
152
+ * The most similar candidate identified
153
153
  * @class
154
154
  */
155
155
  class Candidate extends AbstractModel {
@@ -157,46 +157,43 @@ class Candidate extends AbstractModel {
157
157
  super();
158
158
 
159
159
  /**
160
- * Person ID
160
+ * Person ID.
161
161
  * @type {string || null}
162
162
  */
163
163
  this.PersonId = null;
164
164
 
165
165
  /**
166
- * 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.
166
+ * Face ID.
167
+ -Valid only in the API response of SearchFaces/SearchFacesReturnsByGroup.
168
+ -Person search class interfaces use the fusion feature method for retrieval. This field is meaningless.
167
169
  * @type {string || null}
168
170
  */
169
171
  this.FaceId = null;
170
172
 
171
173
  /**
172
- * Match score of candidate.
173
-
174
- 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;
175
- 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;
176
- In a face base library containing 300,000 faces, the 1% and 0.1% FARs correspond to scores of 85 and 95, respectively.
177
-
178
- 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.
174
+ * Match score of the candidate.
175
+ -In a face base library of 10,000 faces, a false acceptance rate of 1% corresponds to a score of 70 points, 0.1% corresponds to 80 points, and 0.01% corresponds to 90 points.
176
+ -For a face base library of 100,000, a false acceptance rate of 1% corresponds to a score of 80 points, 0.1% corresponds to 90 points, and 0.01% corresponds to 100 points.
177
+ -With a face base library of 300,000, a false acceptance rate of 1% corresponds to a score of 85, and a false acceptance rate of 0.1% corresponds to a score of 95.
178
+ -Generally, a score of around 80 applies to most scenarios. It is advisable not to exceed 90. You can choose a suitable score according to the actual situation.
179
179
  * @type {number || null}
180
180
  */
181
181
  this.Score = null;
182
182
 
183
183
  /**
184
- * Person name
185
- Note: this field may return null, indicating that no valid values can be obtained.
184
+ * Person name.
186
185
  * @type {string || null}
187
186
  */
188
187
  this.PersonName = null;
189
188
 
190
189
  /**
191
- * Person gender
192
- Note: this field may return null, indicating that no valid values can be obtained.
190
+ * Gender of personnel.
193
191
  * @type {number || null}
194
192
  */
195
193
  this.Gender = null;
196
194
 
197
195
  /**
198
- * List of groups containing this person and their description fields
199
- Note: this field may return null, indicating that no valid values can be obtained.
196
+ * List of person libraries containing this person and the content of the description field.
200
197
  * @type {Array.<PersonGroupInfo> || null}
201
198
  */
202
199
  this.PersonGroupInfos = null;
@@ -340,54 +337,42 @@ Value range: [0.0,100.0).
340
337
  }
341
338
 
342
339
  /**
343
- * GetGroupInfo response structure.
340
+ * Sensitive data encryption
344
341
  * @class
345
342
  */
346
- class GetGroupInfoResponse extends AbstractModel {
343
+ class Encryption extends AbstractModel {
347
344
  constructor(){
348
345
  super();
349
346
 
350
347
  /**
351
- * Group name
352
- * @type {string || null}
353
- */
354
- this.GroupName = null;
355
-
356
- /**
357
- * Group ID
358
- * @type {string || null}
359
- */
360
- this.GroupId = null;
361
-
362
- /**
363
- * Custom group description field
348
+ * <p>When using the encryption service, fill in the field to be encrypted. In this API, you can fill in one or more encrypted fields.</p>
364
349
  * @type {Array.<string> || null}
365
350
  */
366
- this.GroupExDescriptions = null;
351
+ this.EncryptList = null;
367
352
 
368
353
  /**
369
- * Group remarks
354
+ * <p>Encrypted symmetric key. For key generation and use, see the <a href="https://www.tencentcloud.com/document/product/1007/47180?from_cn_redirect=1">data encryption</a> document.</p>
370
355
  * @type {string || null}
371
356
  */
372
- this.Tag = null;
357
+ this.CiphertextBlob = null;
373
358
 
374
359
  /**
375
- * Algorithm model version used for face recognition.
360
+ * <p>For users with encryption requirements, import the initial vector for CBC encryption (a custom string of 16 characters).</p>
376
361
  * @type {string || null}
377
362
  */
378
- this.FaceModelVersion = null;
363
+ this.Iv = null;
379
364
 
380
365
  /**
381
- * Group creation time and date (`CreationTimestamp`), whose value is the number of milliseconds between the UNIX epoch time and the group creation time.
382
- * @type {number || null}
366
+ * <p>Encryption algorithm (supports 'AES-256-CBC'). If not specified, it defaults to 'AES-256-CBC'</p>
367
+ * @type {string || null}
383
368
  */
384
- this.CreationTimestamp = null;
369
+ this.Algorithm = null;
385
370
 
386
371
  /**
387
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
388
- * @type {string || null}
372
+ * <p>Message digest generated by the SM4-GCM algorithm (used when validating message integrity), not supported.</p>
373
+ * @type {Array.<string> || null}
389
374
  */
390
- this.RequestId = null;
375
+ this.TagList = null;
391
376
 
392
377
  }
393
378
 
@@ -398,13 +383,11 @@ class GetGroupInfoResponse extends AbstractModel {
398
383
  if (!params) {
399
384
  return;
400
385
  }
401
- this.GroupName = 'GroupName' in params ? params.GroupName : null;
402
- this.GroupId = 'GroupId' in params ? params.GroupId : null;
403
- this.GroupExDescriptions = 'GroupExDescriptions' in params ? params.GroupExDescriptions : null;
404
- this.Tag = 'Tag' in params ? params.Tag : null;
405
- this.FaceModelVersion = 'FaceModelVersion' in params ? params.FaceModelVersion : null;
406
- this.CreationTimestamp = 'CreationTimestamp' in params ? params.CreationTimestamp : null;
407
- this.RequestId = 'RequestId' in params ? params.RequestId : null;
386
+ this.EncryptList = 'EncryptList' in params ? params.EncryptList : null;
387
+ this.CiphertextBlob = 'CiphertextBlob' in params ? params.CiphertextBlob : null;
388
+ this.Iv = 'Iv' in params ? params.Iv : null;
389
+ this.Algorithm = 'Algorithm' in params ? params.Algorithm : null;
390
+ this.TagList = 'TagList' in params ? params.TagList : null;
408
391
 
409
392
  }
410
393
  }
@@ -804,40 +787,49 @@ Note: this field may return null, indicating that no valid values can be obtaine
804
787
  }
805
788
 
806
789
  /**
807
- * GetPersonList response structure.
790
+ * GetGroupInfo response structure.
808
791
  * @class
809
792
  */
810
- class GetPersonListResponse extends AbstractModel {
793
+ class GetGroupInfoResponse extends AbstractModel {
811
794
  constructor(){
812
795
  super();
813
796
 
814
797
  /**
815
- * Returned person information
816
- * @type {Array.<PersonInfo> || null}
798
+ * Group name
799
+ * @type {string || null}
817
800
  */
818
- this.PersonInfos = null;
801
+ this.GroupName = null;
819
802
 
820
803
  /**
821
- * Number of persons in the group
822
- Note: this field may return null, indicating that no valid values can be obtained.
823
- * @type {number || null}
804
+ * Group ID
805
+ * @type {string || null}
824
806
  */
825
- this.PersonNum = null;
807
+ this.GroupId = null;
826
808
 
827
809
  /**
828
- * Number of faces in the group
829
- Note: this field may return null, indicating that no valid values can be obtained.
830
- * @type {number || null}
810
+ * Custom group description field
811
+ * @type {Array.<string> || null}
831
812
  */
832
- this.FaceNum = null;
813
+ this.GroupExDescriptions = null;
814
+
815
+ /**
816
+ * Group remarks
817
+ * @type {string || null}
818
+ */
819
+ this.Tag = null;
833
820
 
834
821
  /**
835
822
  * Algorithm model version used for face recognition.
836
- Note: this field may return null, indicating that no valid values can be obtained.
837
823
  * @type {string || null}
838
824
  */
839
825
  this.FaceModelVersion = null;
840
826
 
827
+ /**
828
+ * Group creation time and date (`CreationTimestamp`), whose value is the number of milliseconds between the UNIX epoch time and the group creation time.
829
+ * @type {number || null}
830
+ */
831
+ this.CreationTimestamp = null;
832
+
841
833
  /**
842
834
  * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
843
835
  * @type {string || null}
@@ -853,18 +845,12 @@ Note: this field may return null, indicating that no valid values can be obtaine
853
845
  if (!params) {
854
846
  return;
855
847
  }
856
-
857
- if (params.PersonInfos) {
858
- this.PersonInfos = new Array();
859
- for (let z in params.PersonInfos) {
860
- let obj = new PersonInfo();
861
- obj.deserialize(params.PersonInfos[z]);
862
- this.PersonInfos.push(obj);
863
- }
864
- }
865
- this.PersonNum = 'PersonNum' in params ? params.PersonNum : null;
866
- this.FaceNum = 'FaceNum' in params ? params.FaceNum : null;
848
+ this.GroupName = 'GroupName' in params ? params.GroupName : null;
849
+ this.GroupId = 'GroupId' in params ? params.GroupId : null;
850
+ this.GroupExDescriptions = 'GroupExDescriptions' in params ? params.GroupExDescriptions : null;
851
+ this.Tag = 'Tag' in params ? params.Tag : null;
867
852
  this.FaceModelVersion = 'FaceModelVersion' in params ? params.FaceModelVersion : null;
853
+ this.CreationTimestamp = 'CreationTimestamp' in params ? params.CreationTimestamp : null;
868
854
  this.RequestId = 'RequestId' in params ? params.RequestId : null;
869
855
 
870
856
  }
@@ -1255,88 +1241,77 @@ class CreatePersonRequest extends AbstractModel {
1255
1241
  super();
1256
1242
 
1257
1243
  /**
1258
- * ID of the group to join, which is the `GroupId` in the `CreateGroup` API.
1244
+ * <p>ID of the personnel database to be added, which is the GroupId in the API for creating a personnel database.</p>
1259
1245
  * @type {string || null}
1260
1246
  */
1261
1247
  this.GroupId = null;
1262
1248
 
1263
1249
  /**
1264
- * Person name, which can contain 1 to 60 characters and is modifiable and repeatable.
1250
+ * <p>Person name. [1, 60] characters, modifiable, repeatable.</p>
1265
1251
  * @type {string || null}
1266
1252
  */
1267
1253
  this.PersonName = null;
1268
1254
 
1269
1255
  /**
1270
- * 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.
1256
+ * <p>Person ID.</p><ul><li>Cannot be modified or repeated under a single Tencent Cloud account.</li><li>Supports English letters, digits, -%@#&amp;_, length limited to 64B.</li></ul>
1271
1257
  * @type {string || null}
1272
1258
  */
1273
1259
  this.PersonId = null;
1274
1260
 
1275
1261
  /**
1276
- * 0: empty; 1: male; 2: female.
1262
+ * <p>Gender.</p><ul><li>Value range: 0 represents empty, 1 represents man, 2 represents woman.</li></ul>
1277
1263
  * @type {number || null}
1278
1264
  */
1279
1265
  this.Gender = null;
1280
1266
 
1281
1267
  /**
1282
- * Content of person description field, which is a `key-value` pair, can contain 0 to 60 characters, and is modifiable and repeatable.
1268
+ * <p>Person description field content, key-value. [0, 60] characters, modifiable, repeatable.</p>
1283
1269
  * @type {Array.<PersonExDescriptionInfo> || null}
1284
1270
  */
1285
1271
  this.PersonExDescriptionInfos = null;
1286
1272
 
1287
1273
  /**
1288
- * Base64-encoded image data, which cannot exceed 5 MB.
1289
- The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
1290
- PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
1274
+ * <p>base64 image data.</p><ul><li>base64-encoded data must not exceed 5 MB.</li><li>For jpg images, the long edge must not exceed 4000 pixels. For other formats, the long edge must not exceed 2000 pixels. The short edge of images in all formats must be at least 64 pixels.</li><li>PNG, jpg, JPEG, and BMP are supported. GIF images are not supported.</li></ul>
1291
1275
  * @type {string || null}
1292
1276
  */
1293
1277
  this.Image = null;
1294
1278
 
1295
1279
  /**
1296
- * Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
1297
- The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
1298
- Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
1299
- We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
1300
- The download speed and stability of non-Tencent Cloud URLs may be low.
1301
- PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
1280
+ * <p>Image Url.</p><ul><li>The corresponding Image size after base64 encoding must not exceed 5M.</li><li>For jpg format, the long side pixel cannot exceed 4000. For other formats, the long side pixel cannot exceed 2000. The short side pixel of images in all formats must not be less than 64.</li><li>Either Url or Image must be provided. If both are provided, only Url is used.</li><li>Images stored in Tencent Cloud's Url can guarantee higher download speed and stability. It is recommended to store images in Tencent Cloud.</li><li>The speed and stability of URLs not stored in Tencent Cloud may be affected to a certain extent.</li><li>PNG, jpg, JPEG, and BMP are supported. GIF images are not supported.</li></ul>
1302
1281
  * @type {string || null}
1303
1282
  */
1304
1283
  this.Url = null;
1305
1284
 
1306
1285
  /**
1307
- * 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.
1308
- 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.
1309
- Otherwise, the new person will be created.
1310
- 0: do not judge, i.e., the person will be created no matter whether a duplicate person exists in the group.
1311
- 1: low duplicate person judgment requirement (1% FAR);
1312
- 2: average duplicate person judgment requirement (0.1% FAR);
1313
- 3: high duplicate person judgment requirement (0.01% FAR);
1314
- 4: very high duplicate person judgment requirement (0.001% FAR).
1315
- Default value: 0.
1316
- 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.
1286
+ * <p>This parameter is used to control whether the human face contained in the image specified by Image or Url is determined to be a suspected duplicate person already existing in the person library. </p><ul><li>If determined to be the same person already in the person library, no new person will be created, and the personnel information of the suspected duplicate person will be returned. </li><li>If not, the person will be created. </li><li>Value range:<br>0: No judgment is performed, and the person will be stored regardless of whether there is a suspected duplicate person in the library;<br>1: Low duplicate person judgment requirement (1% false recognition rate);<br>2: Normal duplicate person judgment requirement (0.1% false recognition rate);<br>3: High duplicate person judgment requirement (0.01% false recognition rate);<br>4: Very high duplicate person judgment requirement (0.001% false recognition rate). </li><li>Default value: 0. </li><li>Note: The higher the requirement, the lower the probability of suspected duplicate persons. The false recognition rates for different requirements are for reference only and can be adjusted according to the actual situation.</li></ul>
1317
1287
  * @type {number || null}
1318
1288
  */
1319
1289
  this.UniquePersonControl = null;
1320
1290
 
1321
1291
  /**
1322
- * Image quality control.
1323
- 0: no control.
1324
- 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
1325
- 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.
1326
- 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.
1327
- 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
1328
- Default value: 0.
1329
- If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
1292
+ * <p>Image quality control. </p><ul><li>Value range: <br>0: no control; <br>1: low quality requirement, where the image is very blurry, or at least one or more of the eyes, nose, or mouth are occluded; <br>2: general quality requirement, where the image is bright, dark, blurry or generally blurry, with at least three of the following: eyebrow occlusion, cheek occlusion, or chin occlusion; <br>3: high quality requirement, where the image is bright, dark, generally blurry, with one or two of the following: eyebrow occlusion, cheek occlusion, or chin occlusion; <br>4: very high quality requirement, where each dimension is optimal or at most one dimension has a minor problem; </li><li>Default: 0. </li><li>If the image quality fails to satisfy the requirement, the returned result will prompt that the image quality detection does not meet the requirement.</li></ul>
1330
1293
  * @type {number || null}
1331
1294
  */
1332
1295
  this.QualityControl = null;
1333
1296
 
1334
1297
  /**
1335
- * 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.
1298
+ * <p>Whether to enable image rotation recognition support.</p><ul><li>Value range: 0 for disabled, 1 for enabled.</li><li>Default value: 0.</li><li>This parameter is used to correctly detect and recognize human faces in an image when the faces are rotated and the image has no exif information. If image rotation recognition support is not enabled in this case, the faces cannot be detected or recognized.</li><li>If you confirm that the image contains exif information or that the human faces in the input image will not be rotated, do not enable this parameter. Once enabled, the overall duration may increase by several hundred milliseconds.</li></ul>
1336
1299
  * @type {number || null}
1337
1300
  */
1338
1301
  this.NeedRotateDetection = null;
1339
1302
 
1303
+ /**
1304
+ * <p>Whether to encrypt the entire request body. Supported encryption algorithm: AES-256-CBC. Users with encryption requirements can use this parameter.</p>
1305
+ * @type {Encryption || null}
1306
+ */
1307
+ this.Encryption = null;
1308
+
1309
+ /**
1310
+ * <p>Encrypted ciphertext. The data format before encryption is as follows: {&quot;Url&quot;:&quot;<strong>&quot;,&quot;Image&quot;:&quot;</strong>&quot;}.</p>
1311
+ * @type {string || null}
1312
+ */
1313
+ this.EncryptedBody = null;
1314
+
1340
1315
  }
1341
1316
 
1342
1317
  /**
@@ -1365,6 +1340,13 @@ If the image quality does not meet the requirement, the returned result will pro
1365
1340
  this.QualityControl = 'QualityControl' in params ? params.QualityControl : null;
1366
1341
  this.NeedRotateDetection = 'NeedRotateDetection' in params ? params.NeedRotateDetection : null;
1367
1342
 
1343
+ if (params.Encryption) {
1344
+ let obj = new Encryption();
1345
+ obj.deserialize(params.Encryption)
1346
+ this.Encryption = obj;
1347
+ }
1348
+ this.EncryptedBody = 'EncryptedBody' in params ? params.EncryptedBody : null;
1349
+
1368
1350
  }
1369
1351
  }
1370
1352
 
@@ -1440,47 +1422,43 @@ class CreateFaceResponse extends AbstractModel {
1440
1422
  super();
1441
1423
 
1442
1424
  /**
1443
- * Number of successfully added faces
1425
+ * <p>Number of faces that joined successfully.</p>
1444
1426
  * @type {number || null}
1445
1427
  */
1446
1428
  this.SucFaceNum = null;
1447
1429
 
1448
1430
  /**
1449
- * List of IDs of successfully added faces
1431
+ * <p>List of face IDs that joined successfully.</p>
1450
1432
  * @type {Array.<string> || null}
1451
1433
  */
1452
1434
  this.SucFaceIds = null;
1453
1435
 
1454
1436
  /**
1455
- * Adding result for each face image. -1101: no face detected; -1102: image decoding failed;
1456
- -1601: the image quality control requirement is not met; -1604: the face similarity is not above `FaceMatchThreshold`.
1457
- Other non-zero values: algorithm service exception.
1458
- The order of `RetCode` values is the same as the order of `Images` or `Urls` in the input parameter.
1437
+ * <p>Addition result of each face image.</p><ul><li>Other non-zero values represent algorithm service exceptions, with the following value ranges:<br>-1101 represents no face detected.<br>-1102 represents image decoding failure.<br>-1109 represents image size too large or too small.<br>-1601 represents the image quality control requirement is not met.<br>-1604 represents face similarity does not exceed FaceMatchThreshold. </li><li>The order of RetCode is consistent with the sequence of Images or Urls in the input parameters.</li></ul>
1459
1438
  * @type {Array.<number> || null}
1460
1439
  */
1461
1440
  this.RetCode = null;
1462
1441
 
1463
1442
  /**
1464
- * Indexes of successfully added faces. The order of indexes is the same as the order of `Images` or `Urls` in the input parameter.
1465
- For example, if there are 3 URLs in `Urls`, and the second URL fails, then the value of `SucIndexes` will be [0,2].
1443
+ * <p>Index of successfully added faces.</p><ul><li>The index order is consistent with the sequence of Images or Urls in the input parameter.</li><li>For example, if there are 3 Urls in Urls and the second url fails, the value of SucIndexes is [0,2].</li></ul>
1466
1444
  * @type {Array.<number> || null}
1467
1445
  */
1468
1446
  this.SucIndexes = null;
1469
1447
 
1470
1448
  /**
1471
- * Frame positions of successfully added faces. The order is the same as the order of `Images` or `Urls` in the input parameter.
1449
+ * <p>Face bounding box position of successfully joined faces. The sequence is consistent with the sequence of Images or Urls in the input parameter.</p>
1472
1450
  * @type {Array.<FaceRect> || null}
1473
1451
  */
1474
1452
  this.SucFaceRects = null;
1475
1453
 
1476
1454
  /**
1477
- * Algorithm model version used for face recognition.
1455
+ * <p>Algorithm model version used for face recognition.</p>
1478
1456
  * @type {string || null}
1479
1457
  */
1480
1458
  this.FaceModelVersion = null;
1481
1459
 
1482
1460
  /**
1483
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1461
+ * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1484
1462
  * @type {string || null}
1485
1463
  */
1486
1464
  this.RequestId = null;
@@ -1642,26 +1620,25 @@ class SearchPersonsResponse extends AbstractModel {
1642
1620
  super();
1643
1621
 
1644
1622
  /**
1645
- * Recognition result.
1623
+ * <p>Recognition result.</p>
1646
1624
  * @type {Array.<Result> || null}
1647
1625
  */
1648
1626
  this.Results = null;
1649
1627
 
1650
1628
  /**
1651
- * 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.
1629
+ * <p>Number of personnel included in the searched group. If all faces in the input image fail to meet the quality requirement, 0 is returned.</p>
1652
1630
  * @type {number || null}
1653
1631
  */
1654
1632
  this.PersonNum = null;
1655
1633
 
1656
1634
  /**
1657
- * Algorithm model version used for face recognition.
1658
- Note: this field may return null, indicating that no valid values can be obtained.
1635
+ * <p>Algorithm model version used for face recognition.</p>
1659
1636
  * @type {string || null}
1660
1637
  */
1661
1638
  this.FaceModelVersion = null;
1662
1639
 
1663
1640
  /**
1664
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
1641
+ * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1665
1642
  * @type {string || null}
1666
1643
  */
1667
1644
  this.RequestId = null;
@@ -1780,7 +1757,7 @@ If you need to verify whether the faces in the two images are the same person, w
1780
1757
  }
1781
1758
 
1782
1759
  /**
1783
- * Custom description field of the person to be modified, which is a `key-value` pair.
1760
+ * Content of the person description field to be modified, key-value
1784
1761
  * @class
1785
1762
  */
1786
1763
  class PersonExDescriptionInfo extends AbstractModel {
@@ -1788,14 +1765,13 @@ class PersonExDescriptionInfo extends AbstractModel {
1788
1765
  super();
1789
1766
 
1790
1767
  /**
1791
- * Person description field index, whose value starts from 0.
1792
- Note: this field may return null, indicating that no valid values can be obtained.
1768
+ * Person description field Index, starts from 0.
1793
1769
  * @type {number || null}
1794
1770
  */
1795
1771
  this.PersonExDescriptionIndex = null;
1796
1772
 
1797
1773
  /**
1798
- * Content of the person description field to be updated
1774
+ * Person description field content that needs to be updated.
1799
1775
  * @type {string || null}
1800
1776
  */
1801
1777
  this.PersonExDescription = null;
@@ -2040,60 +2016,53 @@ class CreateFaceRequest extends AbstractModel {
2040
2016
  super();
2041
2017
 
2042
2018
  /**
2043
- * Person ID, which is the `PersonId` in the `CreatePerson` API.
2019
+ * <p>Person ID, which is the PersonId in the person creation API.</p>
2044
2020
  * @type {string || null}
2045
2021
  */
2046
2022
  this.PersonId = null;
2047
2023
 
2048
2024
  /**
2049
- * Base64-encoded image data, which cannot exceed 5 MB.
2050
- The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
2051
- A person can have up to 5 face images.
2052
- If there are multiple faces in the image, only the face with the largest size will be selected.
2053
- PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
2025
+ * <p>base64 data of the image.</p><ul><li>base64 encoded size must not exceed 5M.</li><li>For jpg format, the long side pixel must not exceed 4000. For other formats, the image long edge must not exceed 2000. The short side pixel of images in all formats must be not less than 64.</li><li>The total number of faces must not exceed 5.</li><li>If the image contains several faces, only the face with the maximum area is selected.</li><li>PNG, jpg, JPEG, and BMP are supported. GIF images are not supported.</li></ul>
2054
2026
  * @type {Array.<string> || null}
2055
2027
  */
2056
2028
  this.Images = null;
2057
2029
 
2058
2030
  /**
2059
- * Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
2060
- The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
2061
- Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
2062
- We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
2063
- The download speed and stability of non-Tencent Cloud URLs may be low.
2064
- PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
2065
- A person can have up to 5 face images.
2066
- If there are multiple faces in the image, only the face with the largest size will be selected.
2031
+ * <p>Image Url.</p><ul><li>The size of the corresponding Image after base64 encoding must not exceed 5M.</li><li>For jpg format, the long side pixel must not exceed 4000. For other Image formats, the long side pixel must not exceed 2000. The short side pixel of images in all formats must be not less than 64.</li><li>Either Url or Image must be provided. If both are provided, only Url is used.</li><li>Images stored in Tencent Cloud URLs can guarantee higher download speed and stability. It is recommended to store images in Tencent Cloud.</li><li>The speed and stability of non-Tencent Cloud Storage URLs may be affected to a certain extent.</li><li>PNG, jpg, JPEG, and BMP are supported. GIF images are not supported.</li><li>The total number of human faces must not exceed 5.</li><li>If the Image contains several faces, only the face with the maximum area is selected.</li></ul>
2067
2032
  * @type {Array.<string> || null}
2068
2033
  */
2069
2034
  this.Urls = null;
2070
2035
 
2071
2036
  /**
2072
- * Only faces whose similarity to an existing face of the person is above the value of `FaceMatchThreshold` can be added successfully.
2073
- Default value: 60. Value range: [0,100].
2037
+ * <p>Only faces with a similarity to the person's existing faces exceeding the FaceMatchThreshold can be added successfully. </p><ul><li>Default value: 60. </li><li>Value range: [0,100]. </li></ul>
2074
2038
  * @type {number || null}
2075
2039
  */
2076
2040
  this.FaceMatchThreshold = null;
2077
2041
 
2078
2042
  /**
2079
- * Image quality control.
2080
- 0: no control.
2081
- 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
2082
- 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.
2083
- 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.
2084
- 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
2085
- Default value: 0.
2086
- If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
2043
+ * <p>Image quality control. </p><ul><li>Value range: <br>0: no control; <br>1: low quality requirement, where the image is super blurry, or at least one or more of the following exist: eye occlusion, nose occlusion, or mouth occlusion; <br>2: normal quality requirement, where the image is bright, dark, blurry or generally blurry, or at least three of the following exist: eyebrow obstruction, cheek obstruction, or chin obstruction; <br>3: high quality requirement, where the image is bright, dark, generally blurry, or one to two of the following exist: eyebrow obstruction, cheek obstruction, or chin obstruction; <br>4: super high quality requirement, where each dimension is at its best or at most one dimension has a minor problem; </li><li>Default: 0. </li><li>If the image quality fails to satisfy the requirement, the returned result will prompt that the image quality detection does not meet the requirement.</li></ul>
2087
2044
  * @type {number || null}
2088
2045
  */
2089
2046
  this.QualityControl = null;
2090
2047
 
2091
2048
  /**
2092
- * 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.
2049
+ * <p>Whether to enable image rotation recognition support.</p><ul><li>Value range: 0 means not enabled, 1 means enabled.</li><li>Default value: 0.</li><li>This parameter is used when the human face in the image is rotated and the image has no exif information. If image rotation recognition support is not enabled, the human face in the image cannot be correctly detected or recognized.</li><li>If you confirm that the image contains exif information or that the human face in the input image will not be rotated, do not enable this parameter. Once enabled, the overall duration may increase by several hundred milliseconds.</li></ul>
2093
2050
  * @type {number || null}
2094
2051
  */
2095
2052
  this.NeedRotateDetection = null;
2096
2053
 
2054
+ /**
2055
+ * <p>Whether full-body encryption is required for the request information. Supported encryption algorithm: AES-256-CBC. Users with encryption requirements can use this parameter.</p>
2056
+ * @type {Encryption || null}
2057
+ */
2058
+ this.Encryption = null;
2059
+
2060
+ /**
2061
+ * <p>Encrypted ciphertext. The data format before encryption is as follows: {&quot;Url&quot;:&quot;<strong>&quot;,&quot;Image&quot;:&quot;</strong>&quot;}。</p>
2062
+ * @type {string || null}
2063
+ */
2064
+ this.EncryptedBody = null;
2065
+
2097
2066
  }
2098
2067
 
2099
2068
  /**
@@ -2110,6 +2079,13 @@ If the image quality does not meet the requirement, the returned result will pro
2110
2079
  this.QualityControl = 'QualityControl' in params ? params.QualityControl : null;
2111
2080
  this.NeedRotateDetection = 'NeedRotateDetection' in params ? params.NeedRotateDetection : null;
2112
2081
 
2082
+ if (params.Encryption) {
2083
+ let obj = new Encryption();
2084
+ obj.deserialize(params.Encryption)
2085
+ this.Encryption = obj;
2086
+ }
2087
+ this.EncryptedBody = 'EncryptedBody' in params ? params.EncryptedBody : null;
2088
+
2113
2089
  }
2114
2090
  }
2115
2091
 
@@ -2218,7 +2194,7 @@ Different algorithm model versions correspond to different face recognition algo
2218
2194
  }
2219
2195
 
2220
2196
  /**
2221
- * List of groups containing this person and their description fields
2197
+ * List of person libraries containing this person and description field content
2222
2198
  * @class
2223
2199
  */
2224
2200
  class PersonGroupInfo extends AbstractModel {
@@ -2226,13 +2202,13 @@ class PersonGroupInfo extends AbstractModel {
2226
2202
  super();
2227
2203
 
2228
2204
  /**
2229
- * ID of the group that contains this person
2205
+ * Personnel database ID that contains this person.
2230
2206
  * @type {string || null}
2231
2207
  */
2232
2208
  this.GroupId = null;
2233
2209
 
2234
2210
  /**
2235
- * Content of person description field
2211
+ * Person description field content.
2236
2212
  * @type {Array.<string> || null}
2237
2213
  */
2238
2214
  this.PersonExDescriptions = null;
@@ -2295,7 +2271,7 @@ class GetPersonGroupInfoRequest extends AbstractModel {
2295
2271
  }
2296
2272
 
2297
2273
  /**
2298
- * Face recognition result
2274
+ * Recognition result of the human face
2299
2275
  * @class
2300
2276
  */
2301
2277
  class Result extends AbstractModel {
@@ -2303,19 +2279,21 @@ class Result extends AbstractModel {
2303
2279
  super();
2304
2280
 
2305
2281
  /**
2306
- * Most matching candidate recognized
2282
+ * The most similar candidate identified.
2307
2283
  * @type {Array.<Candidate> || null}
2308
2284
  */
2309
2285
  this.Candidates = null;
2310
2286
 
2311
2287
  /**
2312
- * Position of detected face frame
2288
+ * Face bounding box position detected.
2313
2289
  * @type {FaceRect || null}
2314
2290
  */
2315
2291
  this.FaceRect = null;
2316
2292
 
2317
2293
  /**
2318
- * 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`.
2294
+ * Status return code of the detected face image.
2295
+ - 0 indicates normal.
2296
+ -1601 indicates the image quality control requirement is not met. At this point, the Candidate content is empty.
2319
2297
  * @type {number || null}
2320
2298
  */
2321
2299
  this.RetCode = null;
@@ -2537,84 +2515,77 @@ class SearchPersonsRequest extends AbstractModel {
2537
2515
  super();
2538
2516
 
2539
2517
  /**
2540
- * List of groups to be searched in (up to 100). The array element value is the `GroupId` in the `CreateGroup` API.
2518
+ * <p>List of person libraries to query, with a capacity limit of 100. The value of an array element is the GroupId in the person library creation API.</p>
2541
2519
  * @type {Array.<string> || null}
2542
2520
  */
2543
2521
  this.GroupIds = null;
2544
2522
 
2545
2523
  /**
2546
- * Base64-encoded image data, which cannot exceed 5 MB.
2547
- The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
2548
- If there are multiple faces in the image, only the face with the largest size will be selected.
2549
- PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
2524
+ * <p>Image base64 data.</p><ul><li>Size after base64 encoding must not exceed 5M.</li><li>Long side pixel of jpg images cannot exceed 4000, and that of other formats cannot exceed 2000.</li><li>Short side pixel of images in all formats must not be less than 64.</li><li>If an image contains several faces, only the face with the maximum area is selected.</li><li>PNG, jpg, JPEG, and BMP are supported. GIF images are not supported.</li></ul>
2550
2525
  * @type {string || null}
2551
2526
  */
2552
2527
  this.Image = null;
2553
2528
 
2554
2529
  /**
2555
- * Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
2556
- The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
2557
- Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
2558
- We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
2559
- The download speed and stability of non-Tencent Cloud URLs may be low.
2560
- PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
2530
+ * <p>Image Url.</p><ul><li>The size of the corresponding Image after base64 encoding must not exceed 5M.</li><li>For jpg format, the long side pixel cannot exceed 4000. For other formats, the long side pixel cannot exceed 2000.</li><li>The short side pixel of images in all formats must be not less than 64.</li><li>Either Url or Image must be provided. If both are provided, only Url is used.</li><li>Urls of images stored in Tencent Cloud can guarantee higher download speed and stability. It is recommended to store images in Tencent Cloud.</li><li>The speed and stability of Urls not stored in Tencent Cloud may be affected to a certain extent.</li><li>PNG, jpg, JPEG, and BMP are supported. GIF images are not supported.</li></ul>
2561
2531
  * @type {string || null}
2562
2532
  */
2563
2533
  this.Url = null;
2564
2534
 
2565
2535
  /**
2566
- * Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10.
2567
- `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.
2568
- 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.
2536
+ * <p>Maximum number of human faces to be recognized.</p><ul><li>Default value: 1 (only the face with the maximum area in the image is detected). Maximum value: 10.</li><li>MaxFaceNum is used to set the number of faces to search when the input image to be recognized contains several faces.</li><li>For example, if the image in the input Image or Url contains several faces and MaxFaceNum is set to 5, the 5 faces with the maximum area in the image will be recognized.</li></ul>
2569
2537
  * @type {number || null}
2570
2538
  */
2571
2539
  this.MaxFaceNum = null;
2572
2540
 
2573
2541
  /**
2574
- * 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.
2542
+ * <p>Minimum length and width of a human face, unit: pixel.</p><ul><li>Default value: 34.</li><li>Less than 34 will affect search accuracy.</li><li>Set it to 80.</li></ul>
2575
2543
  * @type {number || null}
2576
2544
  */
2577
2545
  this.MinFaceSize = null;
2578
2546
 
2579
2547
  /**
2580
- * Number of the most similar persons returned for one single recognized face image. Default value: 5. Maximum value: 100.
2581
- For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned.
2582
- The greater the value, the longer the processing time. We recommend setting a value below 10.
2548
+ * <p>Number of most similar persons returned for a single recognized human face.</p><ul><li>Default value: 5. Maximum value: 100.</li><li>For example, if MaxFaceNum is 1 and MaxPersonNum is 8, the information of the Top 8 similar persons is returned.</li><li>A larger value means a longer time to process. It is advisable not to exceed 10.</li></ul>
2583
2549
  * @type {number || null}
2584
2550
  */
2585
2551
  this.MaxPersonNum = null;
2586
2552
 
2587
2553
  /**
2588
- * Image quality control.
2589
- 0: no control.
2590
- 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
2591
- 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.
2592
- 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.
2593
- 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
2594
- Default value: 0.
2595
- If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
2554
+ * <p>Image quality control. </p><ul><li>Value range:<br>0: No control.<br>1: Low quality requirement. The image is super blurry, with at least one of the following: eye, nose, or mouth occlusion.<br>2: Normal quality requirement. The image is bright, dark, blurry or generally blurry, with at least three of the following: eyebrow occlusion, cheek occlusion, or chin occlusion.<br>3: High quality requirement. The image is bright, dark, generally blurry, with one or two of the following: eyebrow occlusion, cheek occlusion, or chin occlusion.<br>4: Very high quality requirement. Each dimension is optimal or at most one dimension has a minor problem.</li><li>Default: 0. </li><li>If the image quality fails to satisfy the requirement, the returned result will prompt that the image quality detection does not meet the requirement.</li></ul>
2596
2555
  * @type {number || null}
2597
2556
  */
2598
2557
  this.QualityControl = null;
2599
2558
 
2600
2559
  /**
2601
- * 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).
2560
+ * <p>In the output parameter Score, only results equal to or greater than the FaceMatchThreshold value will be returned.</p><ul><li>Default value: 0.</li><li>Value range: [0.0,100.0).</li></ul>
2602
2561
  * @type {number || null}
2603
2562
  */
2604
2563
  this.FaceMatchThreshold = null;
2605
2564
 
2606
2565
  /**
2607
- * Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default.
2566
+ * <p>Whether to return specific personnel information.</p><ul><li>Value range: 0 to disable, 1 to enable.</li><li>Default value: 0.</li><li>Other values other than 0 and 1 default to 0.</li></ul>
2608
2567
  * @type {number || null}
2609
2568
  */
2610
2569
  this.NeedPersonInfo = null;
2611
2570
 
2612
2571
  /**
2613
- * 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.
2572
+ * <p>Whether to enable image rotation recognition support.</p><ul><li>Value range: 0 for not enabled, 1 for enabled.</li><li>Default value: 0.</li><li>This parameter is used when the human face in the image is rotated and the image has no exif information. If image rotation recognition support is not enabled, the human face in the image cannot be correctly detected and recognized.</li><li>If you confirm that the image contains exif information or that the human face in the input image will not be rotated, do not enable this parameter. Once enabled, the overall duration may increase by several hundred milliseconds.</li></ul>
2614
2573
  * @type {number || null}
2615
2574
  */
2616
2575
  this.NeedRotateDetection = null;
2617
2576
 
2577
+ /**
2578
+ * <p>Whether full request body encryption is required. Supported encryption algorithm: AES-256-CBC. Users with encryption requirements can use this parameter.</p>
2579
+ * @type {Encryption || null}
2580
+ */
2581
+ this.Encryption = null;
2582
+
2583
+ /**
2584
+ * <p>Encrypted ciphertext. The data format before encryption is as follows: {&quot;Url&quot;:&quot;<strong>&quot;,&quot;Image&quot;:&quot;</strong>&quot;}.</p>
2585
+ * @type {string || null}
2586
+ */
2587
+ this.EncryptedBody = null;
2588
+
2618
2589
  }
2619
2590
 
2620
2591
  /**
@@ -2635,6 +2606,13 @@ If the image quality does not meet the requirement, the returned result will pro
2635
2606
  this.NeedPersonInfo = 'NeedPersonInfo' in params ? params.NeedPersonInfo : null;
2636
2607
  this.NeedRotateDetection = 'NeedRotateDetection' in params ? params.NeedRotateDetection : null;
2637
2608
 
2609
+ if (params.Encryption) {
2610
+ let obj = new Encryption();
2611
+ obj.deserialize(params.Encryption)
2612
+ this.Encryption = obj;
2613
+ }
2614
+ this.EncryptedBody = 'EncryptedBody' in params ? params.EncryptedBody : null;
2615
+
2638
2616
  }
2639
2617
  }
2640
2618
 
@@ -3627,6 +3605,73 @@ Note: this field may return null, indicating that no valid values can be obtaine
3627
3605
  }
3628
3606
  }
3629
3607
 
3608
+ /**
3609
+ * GetPersonList response structure.
3610
+ * @class
3611
+ */
3612
+ class GetPersonListResponse extends AbstractModel {
3613
+ constructor(){
3614
+ super();
3615
+
3616
+ /**
3617
+ * Returned person information
3618
+ * @type {Array.<PersonInfo> || null}
3619
+ */
3620
+ this.PersonInfos = null;
3621
+
3622
+ /**
3623
+ * Number of persons in the group
3624
+ Note: this field may return null, indicating that no valid values can be obtained.
3625
+ * @type {number || null}
3626
+ */
3627
+ this.PersonNum = null;
3628
+
3629
+ /**
3630
+ * Number of faces in the group
3631
+ Note: this field may return null, indicating that no valid values can be obtained.
3632
+ * @type {number || null}
3633
+ */
3634
+ this.FaceNum = null;
3635
+
3636
+ /**
3637
+ * Algorithm model version used for face recognition.
3638
+ Note: this field may return null, indicating that no valid values can be obtained.
3639
+ * @type {string || null}
3640
+ */
3641
+ this.FaceModelVersion = null;
3642
+
3643
+ /**
3644
+ * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3645
+ * @type {string || null}
3646
+ */
3647
+ this.RequestId = null;
3648
+
3649
+ }
3650
+
3651
+ /**
3652
+ * @private
3653
+ */
3654
+ deserialize(params) {
3655
+ if (!params) {
3656
+ return;
3657
+ }
3658
+
3659
+ if (params.PersonInfos) {
3660
+ this.PersonInfos = new Array();
3661
+ for (let z in params.PersonInfos) {
3662
+ let obj = new PersonInfo();
3663
+ obj.deserialize(params.PersonInfos[z]);
3664
+ this.PersonInfos.push(obj);
3665
+ }
3666
+ }
3667
+ this.PersonNum = 'PersonNum' in params ? params.PersonNum : null;
3668
+ this.FaceNum = 'FaceNum' in params ? params.FaceNum : null;
3669
+ this.FaceModelVersion = 'FaceModelVersion' in params ? params.FaceModelVersion : null;
3670
+ this.RequestId = 'RequestId' in params ? params.RequestId : null;
3671
+
3672
+ }
3673
+ }
3674
+
3630
3675
  /**
3631
3676
  * DetectLiveFaceAccurate response structure.
3632
3677
  * @class
@@ -3885,33 +3930,31 @@ class CreatePersonResponse extends AbstractModel {
3885
3930
  super();
3886
3931
 
3887
3932
  /**
3888
- * Unique ID of face image.
3933
+ * <p>Unique ID of the face image.</p>
3889
3934
  * @type {string || null}
3890
3935
  */
3891
3936
  this.FaceId = null;
3892
3937
 
3893
3938
  /**
3894
- * Position of detected face frame.
3895
- Note: this field may return null, indicating that no valid values can be obtained.
3939
+ * <p>Position of the detected face frame.</p>
3896
3940
  * @type {FaceRect || null}
3897
3941
  */
3898
3942
  this.FaceRect = null;
3899
3943
 
3900
3944
  /**
3901
- * `PersonId` of suspected duplicate person.
3902
- This parameter is meaningful only if the `UniquePersonControl` parameter is not 0 and there is a suspected duplicate person in the group.
3945
+ * <p>PersonId of the suspected duplicate person. </p><ul><li>This parameter is meaningful only when the UniquePersonControl parameter is not 0 and there is a suspected duplicate person in the person library.</li></ul>
3903
3946
  * @type {string || null}
3904
3947
  */
3905
3948
  this.SimilarPersonId = null;
3906
3949
 
3907
3950
  /**
3908
- * Algorithm model version used for face recognition.
3951
+ * <p>Algorithm model version used for face recognition.</p>
3909
3952
  * @type {string || null}
3910
3953
  */
3911
3954
  this.FaceModelVersion = null;
3912
3955
 
3913
3956
  /**
3914
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
3957
+ * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3915
3958
  * @type {string || null}
3916
3959
  */
3917
3960
  this.RequestId = null;
@@ -3976,25 +4019,25 @@ class SearchFacesResponse extends AbstractModel {
3976
4019
  super();
3977
4020
 
3978
4021
  /**
3979
- * Recognition result.
4022
+ * <p>Recognition result.</p>
3980
4023
  * @type {Array.<Result> || null}
3981
4024
  */
3982
4025
  this.Results = null;
3983
4026
 
3984
4027
  /**
3985
- * Number of faces included in searched groups.
4028
+ * <p>Number of faces in the searched group.</p>
3986
4029
  * @type {number || null}
3987
4030
  */
3988
4031
  this.FaceNum = null;
3989
4032
 
3990
4033
  /**
3991
- * Algorithm model version used for face recognition.
4034
+ * <p>Algorithm model version used for face recognition.</p>
3992
4035
  * @type {string || null}
3993
4036
  */
3994
4037
  this.FaceModelVersion = null;
3995
4038
 
3996
4039
  /**
3997
- * The unique request ID, which is returned for each request. RequestId is required for locating a problem.
4040
+ * The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3998
4041
  * @type {string || null}
3999
4042
  */
4000
4043
  this.RequestId = null;
@@ -4649,7 +4692,7 @@ class AttributeItem extends AbstractModel {
4649
4692
  }
4650
4693
 
4651
4694
  /**
4652
- * Position of detected face frame
4695
+ * Location of the detected face frame
4653
4696
  * @class
4654
4697
  */
4655
4698
  class FaceRect extends AbstractModel {
@@ -4657,29 +4700,29 @@ class FaceRect extends AbstractModel {
4657
4700
  super();
4658
4701
 
4659
4702
  /**
4660
- * Horizontal coordinate of the top-left vertex of face frame.
4661
- The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative.
4662
- If you want to capture a complete face, you can set the negative coordinates to 0 if the completeness score meets the requirement.
4703
+ * Top-left X-axis coordinate of the face box
4704
+ -The face frame contains the facial feature locations and is expanded on this basis. If the face frame exceeds the image range, it can cause negative coordinate values.
4705
+ -If you need to capture a complete face, you can set negative coordinates to 0 when the completeness meets the requirements.
4663
4706
  * @type {number || null}
4664
4707
  */
4665
4708
  this.X = null;
4666
4709
 
4667
4710
  /**
4668
- * Vertical coordinate of the top-left vertex of face frame.
4669
- The face frame encompasses the facial features and is extended accordingly. If it is larger than the image, the coordinates will be negative.
4670
- If you want to capture a complete face, you can set the negative coordinates to 0 if the completeness score meets the requirement.
4711
+ * Top-left Y-axis coordinate of the face box
4712
+ -The face frame contains the facial feature locations and is expanded on this basis. If the face frame exceeds the image range, it can cause negative coordinate values.
4713
+ -If you need to capture a complete face, you can set negative coordinates to 0 when the completeness meets the requirements.
4671
4714
  * @type {number || null}
4672
4715
  */
4673
4716
  this.Y = null;
4674
4717
 
4675
4718
  /**
4676
- * Face width
4719
+ * Face width.
4677
4720
  * @type {number || null}
4678
4721
  */
4679
4722
  this.Width = null;
4680
4723
 
4681
4724
  /**
4682
- * Face height
4725
+ * Face height.
4683
4726
  * @type {number || null}
4684
4727
  */
4685
4728
  this.Height = null;
@@ -4738,84 +4781,77 @@ class SearchFacesRequest extends AbstractModel {
4738
4781
  super();
4739
4782
 
4740
4783
  /**
4741
- * List of groups to be searched in (up to 100). The array element value is the `GroupId` in the `CreateGroup` API.
4742
- You cannot search for groups using different algorithm model versions (`FaceModelVersion`) at a time.
4784
+ * <p>List of person libraries to search, with a maximum of 100.</p><ul><li>The array element value is the GroupId in the person library creation API.</li><li>You cannot search person libraries with different algorithm model versions (FaceModelVersion) at the same time.</li></ul>
4743
4785
  * @type {Array.<string> || null}
4744
4786
  */
4745
4787
  this.GroupIds = null;
4746
4788
 
4747
4789
  /**
4748
- * Base64-encoded image data, which cannot exceed 5 MB.
4749
- The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
4750
- PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
4790
+ * <p>base64 data of the image.</p><ul><li>base64-encoded data must not exceed 5 MB.</li><li>For jpg images, the long side pixel cannot exceed 4000. For other formats, the long side pixel cannot exceed 2000.</li><li>The short side pixel of images in all formats must be at least 64.</li><li>PNG, jpg, JPEG, and BMP are supported. GIF images are not supported.</li></ul>
4751
4791
  * @type {string || null}
4752
4792
  */
4753
4793
  this.Image = null;
4754
4794
 
4755
4795
  /**
4756
- * Image URL. The image cannot exceed 5 MB in size after being Base64-encoded.
4757
- The long side cannot exceed 4,000 px for images in JPG format or 2,000 px for images in other formats.
4758
- Either `Url` or `Image` must be provided; if both are provided, only `Url` will be used.
4759
- We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability.
4760
- The download speed and stability of non-Tencent Cloud URLs may be low.
4761
- PNG, JPG, JPEG, and BMP images are supported, while GIF images are not.
4796
+ * <p>The Url of the Image.</p><ul><li>The size of the corresponding Image after base64 encoding must not exceed 5M.</li><li>The long side pixel of a jpg Image cannot exceed 4000, and that of other formats cannot exceed 2000.</li><li>The short side pixel of images in all formats must be not less than 64.</li><li>Either Url or Image must be provided. If both are provided, only Url is used.</li><li>An Image stored in Tencent Cloud via Url can guarantee higher download speed and stability. It is recommended to store images in Tencent Cloud.</li><li>The speed and stability of URLs not stored in Tencent Cloud may be affected to a certain extent.</li><li>PNG, jpg, JPEG, and BMP are supported, while GIF images are not supported.</li></ul>
4762
4797
  * @type {string || null}
4763
4798
  */
4764
4799
  this.Url = null;
4765
4800
 
4766
4801
  /**
4767
- * Maximum number of recognizable faces. Default value: 1 (i.e., detecting only the face with the largest size in the image). Maximum value: 10.
4768
- `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.
4769
- 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.
4802
+ * <p>Maximum number of faces to be recognized.</p><ul><li>Default value: 1 (only the face with the maximum area in the image is detected). Maximum value: 10. </li><li>MaxFaceNum is used to set the number of faces to search when the input image to be recognized contains several faces. </li><li>For example, if the image in the input Image or Url contains several faces and MaxFaceNum is set to 5, the 5 faces with the maximum area in the image will be recognized.</li></ul>
4770
4803
  * @type {number || null}
4771
4804
  */
4772
4805
  this.MaxFaceNum = null;
4773
4806
 
4774
4807
  /**
4775
- * 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.
4808
+ * <p>Minimum size of the face length and width, unit: pixel.</p><ul><li>Default value: 34.</li><li>Face images smaller than 34 cannot be recognized.</li><li>It is recommended to set it to 80.</li></ul>
4776
4809
  * @type {number || null}
4777
4810
  */
4778
4811
  this.MinFaceSize = null;
4779
4812
 
4780
4813
  /**
4781
- * Number of the most similar persons returned for one single recognized face image. Default value: 5. Maximum value: 100.
4782
- For example, if `MaxFaceNum` is 1 and `MaxPersonNum` is 8, information of the top 8 most similar persons will be returned.
4783
- The greater the value, the longer the processing time. We recommend setting a value below 10.
4814
+ * <p>Number of most similar persons returned for a single recognized human face.</p><ul><li>Default value: 5. Maximum value: 100. </li><li>For example, if MaxFaceNum is 1 and MaxPersonNum is 8, the Top 8 similar personnel information is returned.</li><li>A larger value means a longer time to process.</li><li>It is recommended not to exceed 10.</li></ul>
4784
4815
  * @type {number || null}
4785
4816
  */
4786
4817
  this.MaxPersonNum = null;
4787
4818
 
4788
4819
  /**
4789
- * Whether to return person details. 0: no; 1: yes. Default value: 0. Other values will be considered as 0 by default.
4820
+ * <p>Whether to return detailed personnel information.</p><ul><li>Value range: 0 to disable, 1 to enable.</li><li>Default value: 0.</li><li>Other values other than 0 and 1 default to 0.</li></ul>
4790
4821
  * @type {number || null}
4791
4822
  */
4792
4823
  this.NeedPersonInfo = null;
4793
4824
 
4794
4825
  /**
4795
- * Image quality control.
4796
- 0: no control.
4797
- 1: low quality requirement. The image has one or more of the following problems: extreme blurriness, covered eyes, covered nose, and covered mouth.
4798
- 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.
4799
- 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.
4800
- 4: very high-quality requirement. The image is optimal in all dimensions or only has a slight problem in one dimension.
4801
- Default value: 0.
4802
- If the image quality does not meet the requirement, the returned result will prompt that the detected image quality is unsatisfactory.
4826
+ * <p>Image quality control. </p><ul><li>Value range: <br>0: No control. <br>1: Low quality requirement. The image is super blurry, with at least one or more of the following: eye, nose, or mouth occlusion. <br>2: General quality requirement. The image is bright, dark, blurry or generally blurry, with at least three of the following: eyebrow occlusion, cheek occlusion, or chin occlusion. <br>3: High quality requirement. The image is bright, dark, generally blurry, with one or two of the following: eyebrow occlusion, cheek occlusion, or chin occlusion. <br>4: Very high quality requirement. Each dimension is optimal or at most one dimension has a minor problem.</li><li>Default: 0. </li><li>If the image quality fails to satisfy the requirement, the returned result will prompt that the image quality detection does not meet the requirement.</li></ul>
4803
4827
  * @type {number || null}
4804
4828
  */
4805
4829
  this.QualityControl = null;
4806
4830
 
4807
4831
  /**
4808
- * In the output parameter `Score`, the result will be returned only if the result value is above the `FaceMatchThreshold` value. Default value: 0.
4832
+ * <p>In the output parameter Score, only results exceeding the FaceMatchThreshold value will be returned. The default is 0.</p>
4809
4833
  * @type {number || null}
4810
4834
  */
4811
4835
  this.FaceMatchThreshold = null;
4812
4836
 
4813
4837
  /**
4814
- * 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.
4838
+ * <p>Whether to enable image rotation recognition support.</p><ul><li>Value range: 0 for not enabled, 1 for enabled.</li><li>Default value: 0.</li><li>This parameter is used to correctly detect and recognize human faces in the input image when the faces are rotated and the image has no exif information. If image rotation recognition support is not enabled, the faces cannot be detected or recognized correctly.</li><li>If you confirm that the image contains exif information or that the human faces in the input image will not be rotated, do not enable this parameter. Once enabled, the overall duration may increase by several hundred milliseconds.</li></ul>
4815
4839
  * @type {number || null}
4816
4840
  */
4817
4841
  this.NeedRotateDetection = null;
4818
4842
 
4843
+ /**
4844
+ * <p>Whether to encrypt the entire request body. Supported encryption algorithms: AES-256-CBC. Users with encryption requirements can use this parameter.</p>
4845
+ * @type {Encryption || null}
4846
+ */
4847
+ this.Encryption = null;
4848
+
4849
+ /**
4850
+ * <p>Encrypted ciphertext. The data format before encryption is as follows: {&quot;Url&quot;:&quot;<strong>&quot;,&quot;Image&quot;:&quot;</strong>&quot;}.</p>
4851
+ * @type {string || null}
4852
+ */
4853
+ this.EncryptedBody = null;
4854
+
4819
4855
  }
4820
4856
 
4821
4857
  /**
@@ -4836,6 +4872,13 @@ If the image quality does not meet the requirement, the returned result will pro
4836
4872
  this.FaceMatchThreshold = 'FaceMatchThreshold' in params ? params.FaceMatchThreshold : null;
4837
4873
  this.NeedRotateDetection = 'NeedRotateDetection' in params ? params.NeedRotateDetection : null;
4838
4874
 
4875
+ if (params.Encryption) {
4876
+ let obj = new Encryption();
4877
+ obj.deserialize(params.Encryption)
4878
+ this.Encryption = obj;
4879
+ }
4880
+ this.EncryptedBody = 'EncryptedBody' in params ? params.EncryptedBody : null;
4881
+
4839
4882
  }
4840
4883
  }
4841
4884
 
@@ -4914,7 +4957,7 @@ module.exports = {
4914
4957
  Eye: Eye,
4915
4958
  Candidate: Candidate,
4916
4959
  SearchFacesReturnsByGroupRequest: SearchFacesReturnsByGroupRequest,
4917
- GetGroupInfoResponse: GetGroupInfoResponse,
4960
+ Encryption: Encryption,
4918
4961
  DeletePersonRequest: DeletePersonRequest,
4919
4962
  ModifyGroupResponse: ModifyGroupResponse,
4920
4963
  SearchPersonsReturnsByGroupResponse: SearchPersonsReturnsByGroupResponse,
@@ -4924,7 +4967,7 @@ module.exports = {
4924
4967
  ModifyPersonGroupInfoRequest: ModifyPersonGroupInfoRequest,
4925
4968
  GetGroupListResponse: GetGroupListResponse,
4926
4969
  GroupInfo: GroupInfo,
4927
- GetPersonListResponse: GetPersonListResponse,
4970
+ GetGroupInfoResponse: GetGroupInfoResponse,
4928
4971
  Hat: Hat,
4929
4972
  FaceQualityCompleteness: FaceQualityCompleteness,
4930
4973
  FaceAttributesInfo: FaceAttributesInfo,
@@ -4970,6 +5013,7 @@ module.exports = {
4970
5013
  GetGroupInfoRequest: GetGroupInfoRequest,
4971
5014
  FaceDetailInfo: FaceDetailInfo,
4972
5015
  FaceHairAttributesInfo: FaceHairAttributesInfo,
5016
+ GetPersonListResponse: GetPersonListResponse,
4973
5017
  DetectLiveFaceAccurateResponse: DetectLiveFaceAccurateResponse,
4974
5018
  AnalyzeFaceRequest: AnalyzeFaceRequest,
4975
5019
  Point: Point,