tencentcloud-sdk-nodejs 4.0.970 → 4.0.971

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/CHANGELOG.md +381 -0
  2. package/SERVICE_CHANGELOG.md +508 -229
  3. package/package.json +1 -1
  4. package/products.md +30 -30
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/asr/v20190614/asr_models.ts +3 -3
  7. package/src/services/ccc/v20200210/ccc_models.ts +79 -123
  8. package/src/services/cdb/v20170320/cdb_client.ts +32 -20
  9. package/src/services/cdb/v20170320/cdb_models.ts +159 -101
  10. package/src/services/cdc/v20201214/cdc_models.ts +2 -2
  11. package/src/services/cls/v20201016/cls_models.ts +31 -1
  12. package/src/services/cwp/v20180228/cwp_client.ts +3 -16
  13. package/src/services/cwp/v20180228/cwp_models.ts +822 -1570
  14. package/src/services/dasb/v20191018/dasb_models.ts +0 -4
  15. package/src/services/emr/v20190103/emr_models.ts +20 -5
  16. package/src/services/ess/v20201111/ess_models.ts +1 -1
  17. package/src/services/essbasic/v20210526/essbasic_models.ts +1 -1
  18. package/src/services/hai/v20230812/hai_client.ts +2 -0
  19. package/src/services/hai/v20230812/hai_models.ts +64 -2
  20. package/src/services/hunyuan/v20230901/hunyuan_client.ts +1 -1
  21. package/src/services/hunyuan/v20230901/hunyuan_models.ts +7 -3
  22. package/src/services/iai/v20180301/iai_models.ts +4 -4
  23. package/src/services/iai/v20200303/iai_models.ts +450 -351
  24. package/src/services/iss/v20230517/iss_client.ts +20 -32
  25. package/src/services/iss/v20230517/iss_models.ts +150 -178
  26. package/src/services/mmps/v20200710/mmps_models.ts +9 -9
  27. package/src/services/redis/v20180412/redis_client.ts +1 -1
  28. package/src/services/redis/v20180412/redis_models.ts +3 -5
  29. package/src/services/ssl/v20191205/ssl_client.ts +3 -2
  30. package/src/services/ssl/v20191205/ssl_models.ts +147 -108
  31. package/src/services/tcr/v20190924/tcr_models.ts +1 -1
  32. package/src/services/tdmq/v20200217/tdmq_models.ts +2 -2
  33. package/src/services/vpc/v20170312/vpc_client.ts +12 -0
  34. package/src/services/vpc/v20170312/vpc_models.ts +24 -0
  35. package/src/services/wedata/v20210820/wedata_client.ts +36 -0
  36. package/src/services/wedata/v20210820/wedata_models.ts +128 -0
  37. package/tencentcloud/common/sdk_version.d.ts +1 -1
  38. package/tencentcloud/common/sdk_version.js +1 -1
  39. package/tencentcloud/services/asr/v20190614/asr_models.d.ts +3 -3
  40. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +71 -115
  41. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +22 -18
  42. package/tencentcloud/services/cdb/v20170320/cdb_client.js +23 -17
  43. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +156 -100
  44. package/tencentcloud/services/cdc/v20201214/cdc_models.d.ts +2 -2
  45. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +31 -1
  46. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +1 -7
  47. package/tencentcloud/services/cwp/v20180228/cwp_client.js +0 -8
  48. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +821 -1568
  49. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +0 -4
  50. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +20 -5
  51. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +1 -1
  52. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +1 -1
  53. package/tencentcloud/services/hai/v20230812/hai_models.d.ts +62 -2
  54. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.d.ts +1 -1
  55. package/tencentcloud/services/hunyuan/v20230901/hunyuan_client.js +1 -1
  56. package/tencentcloud/services/hunyuan/v20230901/hunyuan_models.d.ts +7 -3
  57. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +4 -4
  58. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +450 -351
  59. package/tencentcloud/services/iss/v20230517/iss_client.d.ts +7 -11
  60. package/tencentcloud/services/iss/v20230517/iss_client.js +9 -15
  61. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +150 -176
  62. package/tencentcloud/services/mmps/v20200710/mmps_models.d.ts +9 -9
  63. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +1 -1
  64. package/tencentcloud/services/redis/v20180412/redis_client.js +1 -1
  65. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +3 -5
  66. package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +1 -1
  67. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +146 -108
  68. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +1 -1
  69. package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +2 -2
  70. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +5 -1
  71. package/tencentcloud/services/vpc/v20170312/vpc_client.js +6 -0
  72. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +22 -0
  73. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +13 -1
  74. package/tencentcloud/services/wedata/v20210820/wedata_client.js +18 -0
  75. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +122 -0
  76. package/test/cdb.v20170320.test.js +10 -0
  77. package/test/cwp.v20180228.test.js +0 -10
  78. package/test/iss.v20230517.test.js +6 -16
  79. package/test/vpc.v20170312.test.js +10 -0
  80. package/test/wedata.v20210820.test.js +30 -0
@@ -21,24 +21,24 @@
21
21
  export interface Eye {
22
22
  /**
23
23
  * 识别是否佩戴眼镜。
24
- AttributeItem对应的Type为 —— 0:无眼镜,1:普通眼镜,2:墨镜
24
+ - AttributeItem对应的Type为 —— 0:无眼镜,1:普通眼镜,2:墨镜
25
25
  */
26
- Glass: AttributeItem
26
+ Glass?: AttributeItem
27
27
  /**
28
28
  * 识别眼睛的睁开、闭合状态。
29
- AttributeItem对应的Type为 —— 0:睁开,1:闭眼
29
+ - AttributeItem对应的Type为 —— 0:睁开,1:闭眼
30
30
  */
31
- EyeOpen: AttributeItem
31
+ EyeOpen?: AttributeItem
32
32
  /**
33
33
  * 识别是否双眼皮。
34
- AttributeItem对应的Type为 —— 0:无,1:有。
34
+ - AttributeItem对应的Type为 —— 0:无,1:有。
35
35
  */
36
- EyelidType: AttributeItem
36
+ EyelidType?: AttributeItem
37
37
  /**
38
38
  * 眼睛大小。
39
- AttributeItem对应的Type为 —— 0:小眼睛,1:普通眼睛,2:大眼睛。
39
+ - AttributeItem对应的Type为 —— 0:小眼睛,1:普通眼睛,2:大眼睛。
40
40
  */
41
- EyeSize: AttributeItem
41
+ EyeSize?: AttributeItem
42
42
  }
43
43
 
44
44
  /**
@@ -46,38 +46,38 @@ AttributeItem对应的Type为 —— 0:小眼睛,1:普通眼睛,2:大
46
46
  */
47
47
  export interface Candidate {
48
48
  /**
49
- * 人员ID
49
+ * 人员ID
50
50
  */
51
- PersonId: string
51
+ PersonId?: string
52
52
  /**
53
- * 人脸ID,仅在SearchFaces/SearchFacesReturnsByGroup接口返回时有效。人员搜索类接口采用融合特征方式检索,该字段无意义
53
+ * 人脸ID
54
+ - 仅在SearchFaces/SearchFacesReturnsByGroup接口返回时有效。
55
+ - 人员搜索类接口采用融合特征方式检索,该字段无意义。
54
56
  */
55
- FaceId: string
57
+ FaceId?: string
56
58
  /**
57
59
  * 候选者的匹配得分。
58
-
59
- 1万大小人脸底库下,误识率百分之一对应分数为70分,误识率千分之一对应分数为80分,误识率万分之一对应分数为90分;
60
- 10万大小人脸底库下,误识率百分之一对应分数为80分,误识率千分之一对应分数为90分,误识率万分之一对应分数为100分;
61
- 30万大小人脸底库下,误识率百分之一对应分数为85分,误识率千分之一对应分数为95分。
62
-
63
- 一般80分左右可适用大部分场景,建议分数不要超过90分。您可以根据实际情况选择合适的分数。
60
+ - 1万大小人脸底库下,误识率百分之一对应分数为70分,误识率千分之一对应分数为80分,误识率万分之一对应分数为90分。
61
+ - 10万大小人脸底库下,误识率百分之一对应分数为80分,误识率千分之一对应分数为90分,误识率万分之一对应分数为100分。
62
+ - 30万大小人脸底库下,误识率百分之一对应分数为85分,误识率千分之一对应分数为95分。
63
+ - 一般80分左右可适用大部分场景,建议分数不要超过90分。您可以根据实际情况选择合适的分数。
64
64
  */
65
- Score: number
65
+ Score?: number
66
66
  /**
67
- * 人员名称
67
+ * 人员名称。
68
68
  注意:此字段可能返回 null,表示取不到有效值。
69
69
  */
70
- PersonName: string
70
+ PersonName?: string
71
71
  /**
72
- * 人员性别
72
+ * 人员性别。
73
73
  注意:此字段可能返回 null,表示取不到有效值。
74
74
  */
75
- Gender: number
75
+ Gender?: number
76
76
  /**
77
- * 包含此人员的人员库及描述字段内容列表
77
+ * 包含此人员的人员库及描述字段内容列表。
78
78
  注意:此字段可能返回 null,表示取不到有效值。
79
79
  */
80
- PersonGroupInfos: Array<PersonGroupInfo>
80
+ PersonGroupInfos?: Array<PersonGroupInfo>
81
81
  }
82
82
 
83
83
  /**
@@ -133,13 +133,13 @@ export interface SearchPersonsReturnsByGroupResponse {
133
133
  */
134
134
  export interface PersonGroupInfo {
135
135
  /**
136
- * 包含此人员的人员库ID
136
+ * 包含此人员的人员库ID
137
137
  */
138
- GroupId: string
138
+ GroupId?: string
139
139
  /**
140
- * 人员描述字段内容
140
+ * 人员描述字段内容。
141
141
  */
142
- PersonExDescriptions: Array<string>
142
+ PersonExDescriptions?: Array<string>
143
143
  }
144
144
 
145
145
  /**
@@ -270,20 +270,20 @@ RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
270
270
  */
271
271
  export interface FaceHairAttributesInfo {
272
272
  /**
273
- * 0:光头,1:短发,2:中发,3:长发,4:绑发
273
+ * 取值范围:0:光头,1:短发,2:中发,3:长发,4:绑发。
274
274
  注意:此字段可能返回 null,表示取不到有效值。
275
275
  */
276
- Length: number
276
+ Length?: number
277
277
  /**
278
- * 0:有刘海,1:无刘海
278
+ * 取值范围:0:有刘海,1:无刘海。
279
279
  注意:此字段可能返回 null,表示取不到有效值。
280
280
  */
281
- Bang: number
281
+ Bang?: number
282
282
  /**
283
- * 0:黑色,1:金色,2:棕色,3:灰白色
283
+ * 取值范围:0:黑色,1:金色,2:棕色,3:灰白色。
284
284
  注意:此字段可能返回 null,表示取不到有效值。
285
285
  */
286
- Color: number
286
+ Color?: number
287
287
  }
288
288
 
289
289
  /**
@@ -395,34 +395,37 @@ export interface GetPersonGroupInfoRequest {
395
395
  export interface FaceInfo {
396
396
  /**
397
397
  * 人脸框左上角横坐标。
398
- 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
399
- 若需截取完整人脸,可以在完整分completeness满足需求的情况下,将负值坐标取0。
398
+ - 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
399
+ - 若需截取完整人脸,可以在完整分completeness满足需求的情况下,将负值坐标取0。
400
400
  */
401
- X: number
401
+ X?: number
402
402
  /**
403
403
  * 人脸框左上角纵坐标。
404
- 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
405
- 若需截取完整人脸,可以在完整分completeness满足需求的情况下,将负值坐标取0。
404
+ - 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
405
+ - 若需截取完整人脸,可以在完整分completeness满足需求的情况下,将负值坐标取0。
406
406
  */
407
- Y: number
407
+ Y?: number
408
408
  /**
409
409
  * 人脸框宽度。
410
410
  */
411
- Width: number
411
+ Width?: number
412
412
  /**
413
413
  * 人脸框高度。
414
414
  */
415
- Height: number
415
+ Height?: number
416
416
  /**
417
- * 人脸属性信息,包含性别( gender )、年龄( age )、表情( expression )、
418
- 魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息。
417
+ * 人脸属性信息。
418
+ - 包含性别( gender )、年龄( age )、表情( expression )、魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )
419
+ - 只有当 NeedFaceAttributes 设为 1 时才返回有效信息。
419
420
  */
420
- FaceAttributesInfo: FaceAttributesInfo
421
+ FaceAttributesInfo?: FaceAttributesInfo
421
422
  /**
422
- * 人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。
423
+ * 人脸质量信息。
424
+ - 包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。
425
+ - 只有当NeedFaceDetection设为1时才返回有效信息。
423
426
  注意:此字段可能返回 null,表示取不到有效值。
424
427
  */
425
- FaceQualityInfo: FaceQualityInfo
428
+ FaceQualityInfo?: FaceQualityInfo
426
429
  }
427
430
 
428
431
  /**
@@ -431,19 +434,19 @@ export interface FaceInfo {
431
434
  export interface Eyebrow {
432
435
  /**
433
436
  * 眉毛浓密。
434
- AttributeItem对应的Type为 —— 0:淡眉,1:浓眉。
437
+ - AttributeItem对应的Type为 —— 0:淡眉,1:浓眉。
435
438
  */
436
- EyebrowDensity: AttributeItem
439
+ EyebrowDensity?: AttributeItem
437
440
  /**
438
441
  * 眉毛弯曲。
439
- AttributeItem对应的Type为 —— 0:不弯,1:弯眉。
442
+ - AttributeItem对应的Type为 —— 0:不弯,1:弯眉。
440
443
  */
441
- EyebrowCurve: AttributeItem
444
+ EyebrowCurve?: AttributeItem
442
445
  /**
443
446
  * 眉毛长短。
444
- AttributeItem对应的Type为 —— 0:短眉毛,1:长眉毛。
447
+ - AttributeItem对应的Type为 —— 0:短眉毛,1:长眉毛。
445
448
  */
446
- EyebrowLength: AttributeItem
449
+ EyebrowLength?: AttributeItem
447
450
  }
448
451
 
449
452
  /**
@@ -451,24 +454,27 @@ AttributeItem对应的Type为 —— 0:短眉毛,1:长眉毛。
451
454
  */
452
455
  export interface AnalyzeDenseLandmarksRequest {
453
456
  /**
454
- * 检测模式。0 为检测所有出现的人脸, 1 为检测面积最大的人脸。
455
- 默认为 0
456
- 最多返回 5 张人脸的五官定位(人脸关键点)具体信息。
457
+ * 检测模式。
458
+ - 取值范围:0 为检测所有出现的人脸, 1 为检测面积最大的人脸。
459
+ - 默认为 0。
460
+ - 最多返回 5 张人脸的五官定位(人脸关键点)具体信息。
457
461
  */
458
462
  Mode?: number
459
463
  /**
460
- * 图片 base64 数据,base64 编码后大小不可超过5M。
461
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
462
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
464
+ * 图片 base64 数据。
465
+ - base64 编码后大小不可超过5M
466
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
467
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
463
468
  */
464
469
  Image?: string
465
470
  /**
466
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
467
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
468
- Url、Image必须提供一个,如果都提供,只使用 Url
469
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
470
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
471
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
471
+ * 图片的 Url 。
472
+ - 对应图片 base64 编码后大小不可超过5M
473
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
474
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
475
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
476
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
477
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
472
478
  */
473
479
  Url?: string
474
480
  /**
@@ -476,7 +482,11 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
476
482
  */
477
483
  FaceModelVersion?: string
478
484
  /**
479
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
485
+ * 是否开启图片旋转识别支持。
486
+ - 取值范围:0为不开启,1为开启。
487
+ - 默认为0。
488
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
489
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
480
490
  */
481
491
  NeedRotateDetection?: number
482
492
  }
@@ -561,13 +571,16 @@ Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00
561
571
  */
562
572
  export interface DetectLiveFaceAccurateResponse {
563
573
  /**
564
- * 活体打分,取值范围 [0,100],根据活体分数对应的阈值区间来判断是否为翻拍。目前阈值可分为[5,10,40,70,90],其中推荐阈值为40。
574
+ * 活体打分。
575
+ - 取值范围 [0,100]。
576
+ - 根据活体分数对应的阈值区间来判断是否为翻拍。
577
+ - 目前阈值可分为[5,10,40,70,90],其中推荐阈值为40。
565
578
  */
566
- Score: number
579
+ Score?: number
567
580
  /**
568
581
  * 人脸识别所用的算法模型版本。
569
582
  */
570
- FaceModelVersion: string
583
+ FaceModelVersion?: string
571
584
  /**
572
585
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
573
586
  */
@@ -579,38 +592,45 @@ export interface DetectLiveFaceAccurateResponse {
579
592
  */
580
593
  export interface AnalyzeFaceRequest {
581
594
  /**
582
- * 检测模式。0 为检测所有出现的人脸, 1 为检测面积最大的人脸。默认为 0。最多返回 10 张人脸的五官定位(人脸关键点)具体信息。
595
+ * 检测模式。
596
+ - 取值范围:
597
+ 0 为检测所有出现的人脸。
598
+ 1 为检测面积最大的人脸。
599
+ - 默认为 0。
600
+ - 最多返回 10 张人脸的五官定位(人脸关键点)具体信息。
583
601
  */
584
602
  Mode?: number
585
603
  /**
586
- * 图片 base64 数据,base64 编码后大小不可超过5M。
587
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
588
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
604
+ * 图片 base64 数据。
605
+ - base64 编码后大小不可超过5M
606
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
607
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
589
608
  */
590
609
  Image?: string
591
610
  /**
592
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
593
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
594
- Url、Image必须提供一个,如果都提供,只使用 Url
595
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
596
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
597
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
611
+ * 图片的 Url 。
612
+ - 对应图片 base64 编码后大小不可超过5M
613
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
614
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
615
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
616
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
617
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
598
618
  */
599
619
  Url?: string
600
620
  /**
601
621
  * 人脸识别服务所用的算法模型版本。
602
-
603
- 目前入参支持 2.0”和“3.0“ 两个输入。
604
-
605
- 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
606
-
607
- 2020年11月26日后开通服务的账号仅支持输入“3.0”。
608
-
609
- 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
622
+ - 目前入参支持 “2.0”和“3.0“ 两个输入。
623
+ - 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
624
+ - 2020年11月26日后开通服务的账号仅支持输入“3.0”。
625
+ - 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
610
626
  */
611
627
  FaceModelVersion?: string
612
628
  /**
613
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
629
+ * 是否开启图片旋转识别支持。
630
+ - 0为不开启,1为开启。
631
+ - 默认为0。
632
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
633
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
614
634
  */
615
635
  NeedRotateDetection?: number
616
636
  }
@@ -690,11 +710,11 @@ export interface GroupCandidate {
690
710
  /**
691
711
  * 人员库ID 。
692
712
  */
693
- GroupId: string
713
+ GroupId?: string
694
714
  /**
695
715
  * 识别出的最相似候选人。
696
716
  */
697
- Candidates: Array<Candidate>
717
+ Candidates?: Array<Candidate>
698
718
  }
699
719
 
700
720
  /**
@@ -903,34 +923,36 @@ export interface GetUpgradeGroupFaceModelVersionResultRequest {
903
923
  */
904
924
  export interface GroupInfo {
905
925
  /**
906
- * 人员库名称
926
+ * 人员库名称。
907
927
  */
908
- GroupName: string
928
+ GroupName?: string
909
929
  /**
910
- * 人员库ID
930
+ * 人员库ID
911
931
  */
912
- GroupId: string
932
+ GroupId?: string
913
933
  /**
914
- * 人员库自定义描述字段
934
+ * 人员库自定义描述字段。
915
935
  注意:此字段可能返回 null,表示取不到有效值。
916
936
  */
917
- GroupExDescriptions: Array<string>
937
+ GroupExDescriptions?: Array<string>
918
938
  /**
919
- * 人员库信息备注
939
+ * 人员库信息备注。
920
940
  注意:此字段可能返回 null,表示取不到有效值。
921
941
  */
922
- Tag: string
942
+ Tag?: string
923
943
  /**
924
944
  * 人脸识别所用的算法模型版本。
925
945
  注意:此字段可能返回 null,表示取不到有效值。
926
946
  */
927
- FaceModelVersion: string
947
+ FaceModelVersion?: string
928
948
  /**
929
- * Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
930
- Unix 纪元时间是 1970 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。
949
+ * Group的创建时间和日期 CreationTimestamp。
950
+ - CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
951
+ - Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。
952
+ - 有关更多信息,请参阅 Unix 时间。
931
953
  注意:此字段可能返回 null,表示取不到有效值。
932
954
  */
933
- CreationTimestamp: number
955
+ CreationTimestamp?: number
934
956
  }
935
957
 
936
958
  /**
@@ -938,32 +960,35 @@ Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00
938
960
  */
939
961
  export interface FaceQualityInfo {
940
962
  /**
941
- * 质量分: [0,100],综合评价图像质量是否适合人脸识别,分数越高质量越好。
942
- 正常情况,只需要使用Score作为质量分总体的判断标准即可。Sharpness、Brightness、Completeness等细项分仅供参考。
943
- 参考范围:[0,40]较差,[40,60] 一般,[60,80]较好,[80,100]很好。
944
- 建议:人脸入库选取70以上的图片。
963
+ * 质量分。
964
+ - 取值范围:[0,100],综合评价图像质量是否适合人脸识别,分数越高质量越好。
965
+ - 正常情况,只需要使用Score作为质量分总体的判断标准即可。Sharpness、Brightness、Completeness等细项分仅供参考。
966
+ - 参考范围:[0,40]较差,[40,60] 一般,[60,80]较好,[80,100]很好。
967
+ - 建议:人脸入库选取70以上的图片。
945
968
  注意:此字段可能返回 null,表示取不到有效值。
946
969
  */
947
- Score: number
970
+ Score?: number
948
971
  /**
949
- * 清晰分:[0,100],评价图片清晰程度,分数越高越清晰。
950
- 参考范围:[0,40]特别模糊,[40,60]模糊,[60,80]一般,[80,100]清晰。
951
- 建议:人脸入库选取80以上的图片。
972
+ * 清晰分。
973
+ - 取值范围:[0,100],评价图片清晰程度,分数越高越清晰。
974
+ - 参考范围:[0,40]特别模糊,[40,60]模糊,[60,80]一般,[80,100]清晰。
975
+ - 建议:人脸入库选取80以上的图片。
952
976
  注意:此字段可能返回 null,表示取不到有效值。
953
977
  */
954
- Sharpness: number
978
+ Sharpness?: number
955
979
  /**
956
- * 光照分:[0,100],评价图片光照程度,分数越高越亮。
957
- 参考范围: [0,30]偏暗,[30,70]光照正常,[70,100]偏亮。
958
- 建议:人脸入库选取[30,70]的图片。
980
+ * 光照分。
981
+ - 取值范围:[0,100],评价图片光照程度,分数越高越亮。
982
+ - 参考范围: [0,30]偏暗,[30,70]光照正常,[70,100]偏亮。
983
+ - 建议:人脸入库选取[30,70]的图片。
959
984
  注意:此字段可能返回 null,表示取不到有效值。
960
985
  */
961
- Brightness: number
986
+ Brightness?: number
962
987
  /**
963
988
  * 五官遮挡分,评价眉毛(Eyebrow)、眼睛(Eye)、鼻子(Nose)、脸颊(Cheek)、嘴巴(Mouth)、下巴(Chin)的被遮挡程度。
964
989
  注意:此字段可能返回 null,表示取不到有效值。
965
990
  */
966
- Completeness: FaceQualityCompleteness
991
+ Completeness?: FaceQualityCompleteness
967
992
  }
968
993
 
969
994
  /**
@@ -1082,95 +1107,95 @@ export interface DenseFaceShape {
1082
1107
  /**
1083
1108
  * 人脸框左上角横坐标。
1084
1109
  */
1085
- X: number
1110
+ X?: number
1086
1111
  /**
1087
1112
  * 人脸框左上角纵坐标。
1088
1113
  */
1089
- Y: number
1114
+ Y?: number
1090
1115
  /**
1091
1116
  * 人脸框宽度。
1092
1117
  */
1093
- Width: number
1118
+ Width?: number
1094
1119
  /**
1095
1120
  * 人脸框高度。
1096
1121
  */
1097
- Height: number
1122
+ Height?: number
1098
1123
  /**
1099
1124
  * 描述左侧眼睛轮廓的 XX 点。
1100
1125
  */
1101
- LeftEye: Array<Point>
1126
+ LeftEye?: Array<Point>
1102
1127
  /**
1103
1128
  * 描述右侧眼睛轮廓的 XX 点。
1104
1129
  */
1105
- RightEye: Array<Point>
1130
+ RightEye?: Array<Point>
1106
1131
  /**
1107
1132
  * 描述左侧眉毛轮廓的 XX 点。
1108
1133
  */
1109
- LeftEyeBrow: Array<Point>
1134
+ LeftEyeBrow?: Array<Point>
1110
1135
  /**
1111
1136
  * 描述右侧眉毛轮廓的 XX 点。
1112
1137
  */
1113
- RightEyeBrow: Array<Point>
1138
+ RightEyeBrow?: Array<Point>
1114
1139
  /**
1115
1140
  * 描述外嘴巴轮廓的 XX 点, 从左侧开始逆时针返回。
1116
1141
  */
1117
- MouthOutside: Array<Point>
1142
+ MouthOutside?: Array<Point>
1118
1143
  /**
1119
1144
  * 描述内嘴巴轮廓的 XX 点,从左侧开始逆时针返回。
1120
1145
  */
1121
- MouthInside: Array<Point>
1146
+ MouthInside?: Array<Point>
1122
1147
  /**
1123
1148
  * 描述鼻子轮廓的 XX 点。
1124
1149
  */
1125
- Nose: Array<Point>
1150
+ Nose?: Array<Point>
1126
1151
  /**
1127
1152
  * 左瞳孔轮廓的 XX 个点。
1128
1153
  */
1129
- LeftPupil: Array<Point>
1154
+ LeftPupil?: Array<Point>
1130
1155
  /**
1131
1156
  * 右瞳孔轮廓的 XX 个点。
1132
1157
  */
1133
- RightPupil: Array<Point>
1158
+ RightPupil?: Array<Point>
1134
1159
  /**
1135
1160
  * 中轴线轮廓的 XX 个点。
1136
1161
  */
1137
- CentralAxis: Array<Point>
1162
+ CentralAxis?: Array<Point>
1138
1163
  /**
1139
1164
  * 下巴轮廓的 XX 个点。
1140
1165
  */
1141
- Chin: Array<Point>
1166
+ Chin?: Array<Point>
1142
1167
  /**
1143
1168
  * 左眼袋的 XX 个点。
1144
1169
  */
1145
- LeftEyeBags: Array<Point>
1170
+ LeftEyeBags?: Array<Point>
1146
1171
  /**
1147
1172
  * 右眼袋的 XX 个点。
1148
1173
  */
1149
- RightEyeBags: Array<Point>
1174
+ RightEyeBags?: Array<Point>
1150
1175
  /**
1151
1176
  * 额头的 XX 个点。
1152
1177
  */
1153
- Forehead: Array<Point>
1178
+ Forehead?: Array<Point>
1154
1179
  }
1155
1180
 
1156
1181
  /**
1157
1182
  * 识别结果。
1158
-
1159
1183
  */
1160
1184
  export interface ResultsReturnsByGroup {
1161
1185
  /**
1162
1186
  * 检测出的人脸框位置。
1163
1187
  */
1164
- FaceRect: FaceRect
1188
+ FaceRect?: FaceRect
1165
1189
  /**
1166
1190
  * 识别结果。
1167
1191
  */
1168
- GroupCandidates: Array<GroupCandidate>
1192
+ GroupCandidates?: Array<GroupCandidate>
1169
1193
  /**
1170
- * 检测出的人脸图片状态返回码。0 表示正常。
1171
- -1601代表不符合图片质量控制要求,此时Candidate内容为空。
1194
+ * 检测出的人脸图片状态返回码。
1195
+ - 0 表示正常。
1196
+ - -1601代表不符合图片质量控制要求,此时Candidate内容为空。
1172
1197
  */
1173
- RetCode: number
1198
+ RetCode?: number
1174
1199
  }
1175
1200
 
1176
1201
  /**
@@ -1178,13 +1203,13 @@ export interface ResultsReturnsByGroup {
1178
1203
  */
1179
1204
  export interface Point {
1180
1205
  /**
1181
- * x坐标
1206
+ * x坐标。
1182
1207
  */
1183
- X: number
1208
+ X?: number
1184
1209
  /**
1185
- * Y坐标
1210
+ * Y坐标。
1186
1211
  */
1187
- Y: number
1212
+ Y?: number
1188
1213
  }
1189
1214
 
1190
1215
  /**
@@ -1228,35 +1253,44 @@ export interface VerifyFaceRequest {
1228
1253
  */
1229
1254
  PersonId: string
1230
1255
  /**
1231
- * 图片 base64 数据,base64 编码后大小不可超过5M。
1232
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1233
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1234
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1256
+ * 图片 base64 数据。
1257
+ - base64 编码后大小不可超过5M
1258
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
1259
+ - 所有格式的图片短边像素不小于64。
1260
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1261
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1235
1262
  */
1236
1263
  Image?: string
1237
1264
  /**
1238
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
1239
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1240
- Url、Image必须提供一个,如果都提供,只使用 Url
1241
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1242
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
1243
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1244
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1265
+ * 图片的 Url 。
1266
+ - 对应图片 base64 编码后大小不可超过5M
1267
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1268
+ - 所有格式的图片短边像素不小于64。
1269
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
1270
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1271
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
1272
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1273
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1245
1274
  */
1246
1275
  Url?: string
1247
1276
  /**
1248
1277
  * 图片质量控制。
1249
- 0: 不进行控制;
1250
- 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
1251
- 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
1252
- 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
1253
- 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
1254
- 默认 0。
1255
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1278
+ - 取值范围:
1279
+ 0: 不进行控制。
1280
+ 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
1281
+ 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
1282
+ 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
1283
+ 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
1284
+ - 默认 0。
1285
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1256
1286
  */
1257
1287
  QualityControl?: number
1258
1288
  /**
1259
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1289
+ * 是否开启图片旋转识别支持。
1290
+ - 取值范围:0为不开启,1为开启。
1291
+ - 默认为0。
1292
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
1293
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1260
1294
  */
1261
1295
  NeedRotateDetection?: number
1262
1296
  }
@@ -1316,18 +1350,19 @@ AttributeItem对应的Type为 —— 0:黑色,1:金色,2:棕色,3:
1316
1350
  */
1317
1351
  export interface Result {
1318
1352
  /**
1319
- * 识别出的最相似候选人
1353
+ * 识别出的最相似候选人。
1320
1354
  */
1321
- Candidates: Array<Candidate>
1355
+ Candidates?: Array<Candidate>
1322
1356
  /**
1323
- * 检测出的人脸框位置
1357
+ * 检测出的人脸框位置。
1324
1358
  */
1325
- FaceRect: FaceRect
1359
+ FaceRect?: FaceRect
1326
1360
  /**
1327
- * 检测出的人脸图片状态返回码。0 表示正常。
1328
- -1601代表不符合图片质量控制要求,此时Candidate内容为空。
1361
+ * 检测出的人脸图片状态返回码。
1362
+ - 0 表示正常。
1363
+ - -1601代表不符合图片质量控制要求,此时Candidate内容为空。
1329
1364
  */
1330
- RetCode: number
1365
+ RetCode?: number
1331
1366
  }
1332
1367
 
1333
1368
  /**
@@ -1503,41 +1538,47 @@ export interface RevertGroupFaceModelVersionRequest {
1503
1538
  */
1504
1539
  export interface FaceQualityCompleteness {
1505
1540
  /**
1506
- * 眉毛的遮挡分数[0,100],分数越高遮挡越少。
1507
- 参考范围:[0,80]表示发生遮挡。
1541
+ * 眉毛的遮挡分数。
1542
+ - 取值范围:[0,100],分数越高遮挡越少。
1543
+ - 参考范围:[0,80]表示发生遮挡。
1508
1544
  注意:此字段可能返回 null,表示取不到有效值。
1509
1545
  */
1510
- Eyebrow: number
1546
+ Eyebrow?: number
1511
1547
  /**
1512
- * 眼睛的遮挡分数[0,100],分数越高遮挡越少。
1513
- 参考范围:[0,80]表示发生遮挡。
1548
+ * 眼睛的遮挡分数。
1549
+ - 取值范围:[0,100],分数越高遮挡越少。
1550
+ - 参考范围:[0,80]表示发生遮挡。
1514
1551
  注意:此字段可能返回 null,表示取不到有效值。
1515
1552
  */
1516
- Eye: number
1553
+ Eye?: number
1517
1554
  /**
1518
- * 鼻子的遮挡分数[0,100],分数越高遮挡越少。
1519
- 参考范围:[0,60]表示发生遮挡。
1555
+ * 鼻子的遮挡分数。
1556
+ - 取值范围:[0,100],分数越高遮挡越少。
1557
+ - 参考范围:[0,60]表示发生遮挡。
1520
1558
  注意:此字段可能返回 null,表示取不到有效值。
1521
1559
  */
1522
- Nose: number
1560
+ Nose?: number
1523
1561
  /**
1524
- * 脸颊的遮挡分数[0,100],分数越高遮挡越少。
1525
- 参考范围:[0,70]表示发生遮挡。
1562
+ * 脸颊的遮挡分数。
1563
+ - 取值范围:[0,100],分数越高遮挡越少。
1564
+ - 参考范围:[0,70]表示发生遮挡。
1526
1565
  注意:此字段可能返回 null,表示取不到有效值。
1527
1566
  */
1528
- Cheek: number
1567
+ Cheek?: number
1529
1568
  /**
1530
- * 嘴巴的遮挡分数[0,100],分数越高遮挡越少。
1531
- 参考范围:[0,50]表示发生遮挡。
1569
+ * 嘴巴的遮挡分数。
1570
+ - 取值范围:[0,100],分数越高遮挡越少。
1571
+ - 参考范围:[0,50]表示发生遮挡。
1532
1572
  注意:此字段可能返回 null,表示取不到有效值。
1533
1573
  */
1534
- Mouth: number
1574
+ Mouth?: number
1535
1575
  /**
1536
- * 下巴的遮挡分数[0,100],分数越高遮挡越少。
1537
- 参考范围:[0,70]表示发生遮挡。
1576
+ * 下巴的遮挡分数。
1577
+ - 取值范围:[0,100],分数越高遮挡越少。
1578
+ - 参考范围:[0,70]表示发生遮挡。
1538
1579
  注意:此字段可能返回 null,表示取不到有效值。
1539
1580
  */
1540
- Chin: number
1581
+ Chin?: number
1541
1582
  }
1542
1583
 
1543
1584
  /**
@@ -1546,57 +1587,81 @@ export interface FaceQualityCompleteness {
1546
1587
  */
1547
1588
  export interface FaceAttributesInfo {
1548
1589
  /**
1549
- * 性别[0~49]为女性,[50,100]为男性,越接近0和100表示置信度越高。NeedFaceAttributes 不为 1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1590
+ * 性别。
1591
+ - 取值说明:[0~49]为女性,[50,100]为男性,越接近0和100表示置信度越高。
1592
+ - NeedFaceAttributes 不为 1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1550
1593
  */
1551
1594
  Gender?: number
1552
1595
  /**
1553
- * 年龄 [0~100]NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1596
+ * 年龄 。
1597
+ - 取值范围:[0~100]。
1598
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1554
1599
  */
1555
1600
  Age?: number
1556
1601
  /**
1557
- * 微笑[0(normal,正常)~100(laugh,大笑)]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1602
+ * 微笑。
1603
+ - 取值说明:[0(normal,正常)~100(laugh,大笑)]。
1604
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1558
1605
  */
1559
1606
  Expression?: number
1560
1607
  /**
1561
- * 是否有眼镜 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1608
+ * 是否有眼镜。
1609
+ - 取值范围: [true,false]。
1610
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1562
1611
  */
1563
1612
  Glass?: boolean
1564
1613
  /**
1565
- * 上下偏移[-30,30],单位角度。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1566
- 建议:人脸入库选择[-10,10]的图片。
1614
+ * 上下偏移。
1615
+ - 取值范围:[-30,30],单位角度。
1616
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1617
+ - 建议:人脸入库选择[-10,10]的图片。
1567
1618
  */
1568
1619
  Pitch?: number
1569
1620
  /**
1570
- * 左右偏移[-30,30],单位角度。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1571
- 建议:人脸入库选择[-10,10]的图片。
1621
+ * 左右偏移。
1622
+ - 取值范围:[-30,30],单位角度。
1623
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1624
+ - 建议:人脸入库选择[-10,10]的图片。
1572
1625
  */
1573
1626
  Yaw?: number
1574
1627
  /**
1575
- * 平面旋转[-180,180],单位角度。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1576
- 建议:人脸入库选择[-20,20]的图片。
1628
+ * 平面旋转。
1629
+ - 取值范围:[-180,180],单位角度。
1630
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1631
+ - 建议:人脸入库选择[-20,20]的图片。
1577
1632
  */
1578
1633
  Roll?: number
1579
1634
  /**
1580
- * 魅力[0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1635
+ * 魅力。
1636
+ - 取值范围:[0~100]。
1637
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1581
1638
  */
1582
1639
  Beauty?: number
1583
1640
  /**
1584
- * 是否有帽子 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1641
+ * 是否有帽子。
1642
+ - 取值范围: [true,false]。
1643
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1585
1644
  注意:此字段可能返回 null,表示取不到有效值。
1586
1645
  */
1587
1646
  Hat?: boolean
1588
1647
  /**
1589
- * 是否有口罩 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1648
+ * 是否有口罩。
1649
+ - 取值范围: [true,false]。
1650
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1590
1651
  注意:此字段可能返回 null,表示取不到有效值。
1591
1652
  */
1592
1653
  Mask?: boolean
1593
1654
  /**
1594
- * 头发信息,包含头发长度(length)、有无刘海(bang)、头发颜色(color)。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1655
+ * 头发信息,包含头发长度(length)、有无刘海(bang)、头发颜色(color)。
1656
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1595
1657
  注意:此字段可能返回 null,表示取不到有效值。
1596
1658
  */
1597
1659
  Hair?: FaceHairAttributesInfo
1598
1660
  /**
1599
- * 双眼是否睁开 [true,false]。只要有超过一只眼睛闭眼,就返回false。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1661
+ * 双眼是否睁开。
1662
+ - 取值范围: [true,false]。
1663
+ - 只要有超过一只眼睛闭眼,就返回false。
1664
+ - NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1600
1665
  注意:此字段可能返回 null,表示取不到有效值。
1601
1666
  */
1602
1667
  EyeOpen?: boolean
@@ -1612,34 +1677,41 @@ export interface VerifyPersonRequest {
1612
1677
  PersonId: string
1613
1678
  /**
1614
1679
  * 图片 base64 数据。
1615
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
1616
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1617
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1680
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
1681
+ - 所有格式的图片短边像素不小于64。
1682
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1683
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1618
1684
  */
1619
1685
  Image?: string
1620
1686
  /**
1621
1687
  * 图片的 Url
1622
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。。
1623
- 图片的 Url、Image必须提供一个,如果都提供,只使用 Url
1624
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1625
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
1626
- 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1627
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1688
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1689
+ - 所有格式的图片短边像素不小于64
1690
+ - 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
1691
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1692
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
1693
+ - 若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1694
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1628
1695
  */
1629
1696
  Url?: string
1630
1697
  /**
1631
1698
  * 图片质量控制。
1632
- 0: 不进行控制;
1633
- 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
1634
- 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况;
1635
- 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况;
1636
- 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题;
1637
- 默认 0。
1638
- 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1699
+ - 取值范围:
1700
+ 0: 不进行控制。
1701
+ 1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
1702
+ 2: 一般的质量要求,图像存在偏亮,偏暗,模糊或一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,至少其中三种的情况。
1703
+ 3: 较高的质量要求,图像存在偏亮,偏暗,一般模糊,眉毛遮挡,脸颊遮挡,下巴遮挡,其中一到两种的情况。
1704
+ 4: 很高的质量要求,各个维度均为最好或最多在某一维度上存在轻微问题。
1705
+ - 默认 0。
1706
+ - 若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1639
1707
  */
1640
1708
  QualityControl?: number
1641
1709
  /**
1642
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1710
+ * 是否开启图片旋转识别支持。
1711
+ - 取值范围:0为不开启,1为开启。
1712
+ - 默认为0。
1713
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
1714
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1643
1715
  */
1644
1716
  NeedRotateDetection?: number
1645
1717
  }
@@ -1689,21 +1761,23 @@ export interface ModifyPersonBaseInfoRequest {
1689
1761
  */
1690
1762
  export interface DetectLiveFaceAccurateRequest {
1691
1763
  /**
1692
- * 图片 base64 数据,base64 编码后大小不可超过5M。
1693
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1694
- 图片的宽高比请接近 3:4,手机拍摄比例最佳。
1695
- 人脸尺寸大于100X100像素。
1696
- 图片格式支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1764
+ * 图片 base64 数据。
1765
+ - base64 编码后大小不可超过5M
1766
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
1767
+ - 图片的宽高比请接近 3:4,手机拍摄比例最佳。
1768
+ - 人脸尺寸大于100X100像素。
1769
+ - 图片格式支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1697
1770
  */
1698
1771
  Image?: string
1699
1772
  /**
1700
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
1701
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1702
- Url、Image必须提供一个,如果都提供,只使用 Url
1703
- 图片的宽高比请接近 3:4,手机拍摄比例最佳。
1704
- 人脸尺寸大于100X100像素。
1705
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。
1706
- 图片格式支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1773
+ * 图片的 Url 。
1774
+ - 对应图片 base64 编码后大小不可超过5M
1775
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
1776
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
1777
+ - 图片的宽高比请接近 3:4,手机拍摄比例最佳。
1778
+ - 人脸尺寸大于100X100像素。
1779
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的Url速度和稳定性可能受一定影响。
1780
+ - 图片格式支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1707
1781
  */
1708
1782
  Url?: string
1709
1783
  /**
@@ -1717,21 +1791,22 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
1717
1791
  */
1718
1792
  export interface VerifyFaceResponse {
1719
1793
  /**
1720
- * 给定的人脸图片与 PersonId 对应人脸的相似度。若 PersonId 下有多张人脸(Face),返回相似度最大的分数。
1721
-
1722
- 不同算法版本返回的相似度分数不同。
1723
- 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
1724
- 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
1794
+ * 给定的人脸图片与 PersonId 对应人脸的相似度。
1795
+ - 若 PersonId 下有多张人脸(Face),返回相似度最大的分数。
1796
+ - 不同算法版本返回的相似度分数不同。
1797
+ - 若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
1798
+ - 2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
1725
1799
  */
1726
- Score: number
1800
+ Score?: number
1727
1801
  /**
1728
- * 是否为同一人判断,固定阈值分数为60分,若想更灵活地调整阈值可取Score参数返回进行判断
1802
+ * 是否为同一人判断,固定阈值分数为60分,若想更灵活地调整阈值可取Score参数返回进行判断。
1729
1803
  */
1730
- IsMatch: boolean
1804
+ IsMatch?: boolean
1731
1805
  /**
1732
- * 人脸识别所用的算法模型版本,是该 Person 所在的人员库的算法模型版本。在创建人员库时设置,详情可参考[算法模型版本](https://cloud.tencent.com/document/product/867/40042)
1806
+ * 人脸识别所用的算法模型版本,是该 Person 所在的人员库的算法模型版本。
1807
+ - 在创建人员库时设置,详情可参考[算法模型版本](https://cloud.tencent.com/document/product/867/40042)
1733
1808
  */
1734
- FaceModelVersion: string
1809
+ FaceModelVersion?: string
1735
1810
  /**
1736
1811
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1737
1812
  */
@@ -1747,11 +1822,9 @@ export interface FaceDetailInfo {
1747
1822
  */
1748
1823
  FaceRect?: FaceRect
1749
1824
  /**
1750
- * 人脸属性信息,根据 FaceAttributesType 输入的类型,返回年龄(Age)、颜值(Beauty)
1751
- 情绪(Emotion)、眼睛信息(Eye)、眉毛(Eyebrow)、性别(Gender)
1752
- 头发(Hair)、帽子(Hat)、姿态(Headpose)、口罩(Mask)、嘴巴(Mouth)、胡子(Moustache)
1753
- 鼻子(Nose)、脸型(Shape)、肤色(Skin)、微笑(Smile)等人脸属性信息。
1754
- 若 FaceAttributesType 没有输入相关类型,则FaceDetaiAttributesInfo返回的细项不具备参考意义。
1825
+ * 人脸属性信息。
1826
+ - 根据 FaceAttributesType 输入的类型,返回年龄(Age)、颜值(Beauty)、情绪(Emotion)、眼睛信息(Eye)、眉毛(Eyebrow)、性别(Gender)、头发(Hair)、帽子(Hat)、姿态(Headpose)、口罩(Mask)、嘴巴(Mouth)、胡子(Moustache、鼻子(Nose)、脸型(Shape)、肤色(Skin)、微笑(Smile)等人脸属性信息。
1827
+ - 若 FaceAttributesType 没有输入相关类型,则FaceDetaiAttributesInfo返回的细项不具备参考意义。
1755
1828
  */
1756
1829
  FaceDetailAttributesInfo?: FaceDetailAttributesInfo
1757
1830
  }
@@ -1891,30 +1964,32 @@ MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要
1891
1964
  */
1892
1965
  export interface PersonInfo {
1893
1966
  /**
1894
- * 人员名称
1967
+ * 人员名称。
1895
1968
  */
1896
- PersonName: string
1969
+ PersonName?: string
1897
1970
  /**
1898
- * 人员Id
1971
+ * 人员Id
1899
1972
  */
1900
- PersonId: string
1973
+ PersonId?: string
1901
1974
  /**
1902
- * 人员性别
1975
+ * 人员性别。
1903
1976
  */
1904
- Gender: number
1977
+ Gender?: number
1905
1978
  /**
1906
- * 人员描述字段内容
1979
+ * 人员描述字段内容。
1907
1980
  */
1908
- PersonExDescriptions: Array<string>
1981
+ PersonExDescriptions?: Array<string>
1909
1982
  /**
1910
- * 包含的人脸照片列表
1983
+ * 包含的人脸照片列表。
1911
1984
  */
1912
- FaceIds: Array<string>
1985
+ FaceIds?: Array<string>
1913
1986
  /**
1914
- * 人员的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Person创建时间的毫秒数。
1915
- Unix 纪元时间是 1970 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。
1987
+ * 人员的创建时间和日期 CreationTimestamp。
1988
+ - CreationTimestamp 的值是自 Unix 纪元时间到Person创建时间的毫秒数。
1989
+ - Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。
1990
+ - 有关更多信息,请参阅 Unix 时间。
1916
1991
  */
1917
- CreationTimestamp: number
1992
+ CreationTimestamp?: number
1918
1993
  }
1919
1994
 
1920
1995
  /**
@@ -1922,11 +1997,11 @@ Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00
1922
1997
  */
1923
1998
  export interface GroupExDescriptionInfo {
1924
1999
  /**
1925
- * 人员库自定义描述字段Index,从0开始
2000
+ * 人员库自定义描述字段Index,从0开始。
1926
2001
  */
1927
2002
  GroupExDescriptionIndex: number
1928
2003
  /**
1929
- * 需要更新的人员库自定义描述字段内容
2004
+ * 需要更新的人员库自定义描述字段内容。
1930
2005
  */
1931
2006
  GroupExDescription: string
1932
2007
  }
@@ -2017,55 +2092,67 @@ export interface AnalyzeFaceResponse {
2017
2092
  */
2018
2093
  export interface DetectFaceRequest {
2019
2094
  /**
2020
- * 最多处理的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为120。
2021
- 此参数用于控制处理待检测图片中的人脸个数,值越小,处理速度越快。
2095
+ * 最多处理的人脸数目。
2096
+ - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为120。
2097
+ - 此参数用于控制处理待检测图片中的人脸个数,值越小,处理速度越快。
2022
2098
  */
2023
2099
  MaxFaceNum?: number
2024
2100
  /**
2025
2101
  * 人脸长和宽的最小尺寸,单位为像素,低于MinFaceSize值的人脸不会被检测。
2026
- 只支持设置34和20,建议使用34。
2027
-
2102
+ - 只支持设置34和20,建议使用34。
2028
2103
  */
2029
2104
  MinFaceSize?: number
2030
2105
  /**
2031
- * 图片 base64 数据,base64 编码后大小不可超过5M。
2032
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2033
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2106
+ * 图片 base64 数据。
2107
+ - base64 编码后大小不可超过5M
2108
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
2109
+ - 所有格式的图片短边像素不小于64。
2110
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2034
2111
  */
2035
2112
  Image?: string
2036
2113
  /**
2037
- * 图片的 Url 。对应图片 base64 编码后大小不可超过5M
2038
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64
2039
- Url、Image必须提供一个,如果都提供,只使用 Url
2040
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2041
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
2042
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2114
+ * 图片的 Url 。
2115
+ - 对应图片 base64 编码后大小不可超过5M
2116
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000
2117
+ - 所有格式的图片短边像素不小于64。
2118
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
2119
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2120
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
2121
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2043
2122
  */
2044
2123
  Url?: string
2045
2124
  /**
2046
- * 是否需要返回人脸属性信息(FaceAttributesInfo)。0 为不需要返回,1 为需要返回。默认为 0。
2047
- 1 值均视为不需要返回,此时 FaceAttributesInfo 不具备参考意义。
2048
- 最多返回面积最大的 5 张人脸属性信息,超过 5 张人脸(第 6 张及以后的人脸)的 FaceAttributesInfo 不具备参考意义。
2049
- 提取人脸属性信息较为耗时,如不需要人脸属性信息,建议关闭此项功能,加快人脸检测速度。
2125
+ * 是否需要返回人脸属性信息(FaceAttributesInfo)。
2126
+ - 0 为不需要返回,1 为需要返回。
2127
+ - 默认为 0。
2128
+ - 非 1 值均视为不需要返回,此时 FaceAttributesInfo 不具备参考意义。
2129
+ - 最多返回面积最大的 5 张人脸属性信息,超过 5 张人脸(第 6 张及以后的人脸)的 FaceAttributesInfo 不具备参考意义。
2130
+ - 提取人脸属性信息较为耗时,如不需要人脸属性信息,建议关闭此项功能,加快人脸检测速度。
2050
2131
  */
2051
2132
  NeedFaceAttributes?: number
2052
2133
  /**
2053
- * 是否开启质量检测。0 为关闭,1 为开启。默认为 0。
2054
- 1 值均视为不进行质量检测。
2055
- 最多返回面积最大的 30 张人脸质量分信息,超过 30 张人脸(第 31 张及以后的人脸)的 FaceQualityInfo不具备参考意义。
2056
- 建议:人脸入库操作建议开启此功能。
2134
+ * 是否开启质量检测。
2135
+ - 0 为关闭,1 为开启。
2136
+ - 默认为 0。
2137
+ - 非 1 值均视为不进行质量检测。
2138
+ - 最多返回面积最大的 30 张人脸质量分信息,超过 30 张人脸(第 31 张及以后的人脸)的 FaceQualityInfo不具备参考意义。
2139
+ - 建议:人脸入库操作建议开启此功能。
2057
2140
  */
2058
2141
  NeedQualityDetection?: number
2059
2142
  /**
2060
2143
  * 人脸识别服务所用的算法模型版本。
2061
- 目前入参支持 “2.0”和“3.0“ 两个输入。
2062
- 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
2063
- 2020年11月26日后开通服务的账号仅支持输入“3.0”。
2064
- 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
2144
+ - 目前入参支持 “2.0”和“3.0“ 两个输入。
2145
+ - 2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
2146
+ - 2020年11月26日后开通服务的账号仅支持输入“3.0”。
2147
+ - 不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
2065
2148
  */
2066
2149
  FaceModelVersion?: string
2067
2150
  /**
2068
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2151
+ * 是否开启图片旋转识别支持。
2152
+ - 0为不开启,1为开启。
2153
+ - 默认为0。
2154
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
2155
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2069
2156
  */
2070
2157
  NeedRotateDetection?: number
2071
2158
  }
@@ -2095,11 +2182,11 @@ export interface DeletePersonResponse {
2095
2182
  */
2096
2183
  export interface PersonExDescriptionInfo {
2097
2184
  /**
2098
- * 人员描述字段Index,从0开始
2185
+ * 人员描述字段Index,从0开始。
2099
2186
  */
2100
2187
  PersonExDescriptionIndex: number
2101
2188
  /**
2102
- * 需要更新的人员描述字段内容
2189
+ * 需要更新的人员描述字段内容。
2103
2190
  */
2104
2191
  PersonExDescription: string
2105
2192
  }
@@ -2129,15 +2216,15 @@ export interface HeadPose {
2129
2216
  /**
2130
2217
  * 上下偏移[-30,30]。
2131
2218
  */
2132
- Pitch: number
2219
+ Pitch?: number
2133
2220
  /**
2134
2221
  * 左右偏移[-30,30]。
2135
2222
  */
2136
- Yaw: number
2223
+ Yaw?: number
2137
2224
  /**
2138
2225
  * 平面旋转[-180,180]。
2139
2226
  */
2140
- Roll: number
2227
+ Roll?: number
2141
2228
  }
2142
2229
 
2143
2230
  /**
@@ -2165,38 +2252,44 @@ export interface GetGroupListResponse {
2165
2252
  export interface DetectFaceAttributesRequest {
2166
2253
  /**
2167
2254
  * 最多处理的人脸数目。
2168
- 默认值为1(仅检测图片中面积最大的那张人脸),最大值为120。
2169
- 此参数用于控制处理待检测图片中的人脸个数,值越小,处理速度越快。
2255
+ - 默认值为1(仅检测图片中面积最大的那张人脸),最大值为120。
2256
+ - 此参数用于控制处理待检测图片中的人脸个数,值越小,处理速度越快。
2170
2257
  */
2171
2258
  MaxFaceNum?: number
2172
2259
  /**
2173
- * 图片 base64 数据,base64 编码后大小不可超过5M。
2174
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。 所有格式的图片短边像素不小于64
2175
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2260
+ * 图片 base64 数据。
2261
+ - base64 编码后大小不可超过5M
2262
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
2263
+ - 所有格式的图片短边像素不小于64。
2264
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2176
2265
  */
2177
2266
  Image?: string
2178
2267
  /**
2179
2268
  * 图片的 Url 。
2180
- 对应图片 base64 编码后大小不可超过5M。
2181
- jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
2182
- Url、Image必须提供一个,如果都提供,只使用 Url。
2183
- 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2184
- 非腾讯云存储的Url速度和稳定性可能受一定影响。
2185
- 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2269
+ - 对应图片 base64 编码后大小不可超过5M。
2270
+ - jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
2271
+ - Url、Image必须提供一个,如果都提供,只使用 Url。
2272
+ - 图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2273
+ - 非腾讯云存储的Url速度和稳定性可能受一定影响。
2274
+ - 支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2186
2275
  */
2187
2276
  Url?: string
2188
2277
  /**
2189
2278
  * 是否返回年龄、性别、情绪等属性。
2190
- 合法值为(大小写不敏感):None、Age、Beauty、Emotion、Eye、Eyebrow、
2191
- Gender、Hair、Hat、Headpose、Mask、Mouth、Moustache、Nose、Shape、Skin、Smile。
2192
- None为不需要返回。默认为 None。即FaceAttributesType属性为空时,各属性返回值为0。
2193
- 需要将属性组成一个用逗号分隔的字符串,属性之间的顺序没有要求。
2194
- 关于各属性的详细描述,参见下文出参。
2195
- 最多返回面积最大的 5 张人脸属性信息,超过 5 张人脸(第 6 张及以后的人脸)的 AttributesInfo 不具备参考意义。
2279
+ - 合法值为(大小写不敏感):None、Age、Beauty、Emotion、Eye、Eyebrow、Gender、Hair、Hat、Headpose、Mask、Mouth、Moustache、Nose、Shape、Skin、Smile。
2280
+ - None为不需要返回。
2281
+ - 默认为 None。即FaceAttributesType属性为空时,各属性返回值为0。
2282
+ - 需要将属性组成一个用逗号分隔的字符串,属性之间的顺序没有要求。
2283
+ - 关于各属性的详细描述,参见下文出参。
2284
+ - 最多返回面积最大的 5 张人脸属性信息,超过 5 张人脸(第 6 张及以后的人脸)的 AttributesInfo 不具备参考意义。
2196
2285
  */
2197
2286
  FaceAttributesType?: string
2198
2287
  /**
2199
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2288
+ * 是否开启图片旋转识别支持。
2289
+ - 0为不开启,1为开启。
2290
+ - 默认为0。
2291
+ - 本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
2292
+ - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2200
2293
  */
2201
2294
  NeedRotateDetection?: number
2202
2295
  /**
@@ -2414,7 +2507,8 @@ export interface VerifyPersonResponse {
2414
2507
  */
2415
2508
  IsMatch?: boolean
2416
2509
  /**
2417
- * 人脸识别所用的算法模型版本,是该 Person 所在的人员库的算法模型版本。在创建人员库时设置,详情可参考[算法模型版本](https://cloud.tencent.com/document/product/867/40042)
2510
+ * 人脸识别所用的算法模型版本,是该 Person 所在的人员库的算法模型版本。
2511
+ - 在创建人员库时设置,详情可参考[算法模型版本](https://cloud.tencent.com/document/product/867/40042)
2418
2512
  */
2419
2513
  FaceModelVersion?: string
2420
2514
  /**
@@ -2436,7 +2530,8 @@ export interface DetectFaceResponse {
2436
2530
  */
2437
2531
  ImageHeight?: number
2438
2532
  /**
2439
- * 人脸信息列表。包含人脸坐标信息、属性信息(若需要)、质量分信息(若需要)。
2533
+ * 人脸信息列表。
2534
+ - 包含人脸坐标信息、属性信息(若需要)、质量分信息(若需要)。
2440
2535
  */
2441
2536
  FaceInfos?: Array<FaceInfo>
2442
2537
  /**
@@ -2539,24 +2634,26 @@ export interface GetPersonListRequest {
2539
2634
  */
2540
2635
  export interface FaceDetailAttributesInfo {
2541
2636
  /**
2542
- * 年龄 [0,65],其中65代表“65岁及以上”。
2543
- FaceAttributesType 不含Age 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2637
+ * 年龄。
2638
+ - 取值范围: [0,65],其中65代表“65岁及以上”。
2639
+ - FaceAttributesType 不含Age 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2544
2640
  */
2545
2641
  Age?: number
2546
2642
  /**
2547
- * 美丑打分[0,100]。
2548
- FaceAttributesType 不含 Beauty 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2643
+ * 美丑打分。
2644
+ - 取值范围:[0,100]。
2645
+ - FaceAttributesType 不含 Beauty 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2549
2646
  */
2550
2647
  Beauty?: number
2551
2648
  /**
2552
2649
  * 情绪,可识别自然、高兴、惊讶、生气、悲伤、厌恶、害怕。
2553
- AttributeItem对应的Type为 —— 0:自然,1:高兴,2:惊讶,3:生气,4:悲伤,5:厌恶,6:害怕
2554
- FaceAttributesType 不含Emotion 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2650
+ - AttributeItem对应的Type为 —— 0:自然,1:高兴,2:惊讶,3:生气,4:悲伤,5:厌恶,6:害怕。
2651
+ - FaceAttributesType 不含Emotion 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2555
2652
  */
2556
2653
  Emotion?: AttributeItem
2557
2654
  /**
2558
2655
  * 眼睛相关信息,可识别是否戴眼镜、是否闭眼、是否双眼皮和眼睛大小。
2559
- FaceAttributesType 不含Eye 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2656
+ - FaceAttributesType 不含Eye 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2560
2657
  */
2561
2658
  Eye?: Eye
2562
2659
  /**
@@ -2566,63 +2663,64 @@ FaceAttributesType 不含Eyebrow 或检测超过 5 张人脸时,此参数仍
2566
2663
  Eyebrow?: Eyebrow
2567
2664
  /**
2568
2665
  * 性别信息。
2569
- AttributeItem对应的Type为 —— 0:男性,1:女性。
2570
- FaceAttributesType 不含Gender 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2666
+ - AttributeItem对应的Type为 —— 0:男性,1:女性。
2667
+ - FaceAttributesType 不含Gender 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2571
2668
  */
2572
2669
  Gender?: AttributeItem
2573
2670
  /**
2574
2671
  * 头发信息,包含头发长度、有无刘海、头发颜色。
2575
- FaceAttributesType 不含Hair 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2672
+ - FaceAttributesType 不含Hair 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2576
2673
  */
2577
2674
  Hair?: Hair
2578
2675
  /**
2579
2676
  * 帽子信息,可识别是否佩戴帽子、帽子款式、帽子颜色。
2580
- FaceAttributesType 不含Hat 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2677
+ - FaceAttributesType 不含Hat 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2581
2678
  */
2582
2679
  Hat?: Hat
2583
2680
  /**
2584
2681
  * 姿态信息,包含人脸的上下偏移、左右偏移、平面旋转信息。
2585
- FaceAttributesType 不含Headpose 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2682
+ - FaceAttributesType 不含Headpose 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2586
2683
  */
2587
2684
  HeadPose?: HeadPose
2588
2685
  /**
2589
2686
  * 口罩佩戴信息。
2590
- AttributeItem对应的Type为 —— 0: 无口罩, 1: 有口罩不遮脸,2: 有口罩遮下巴,3: 有口罩遮嘴,4: 正确佩戴口罩。
2591
- FaceAttributesType 不含Mask 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2687
+ - AttributeItem对应的Type为 —— 0: 无口罩, 1: 有口罩不遮脸,2: 有口罩遮下巴,3: 有口罩遮嘴,4: 正确佩戴口罩。
2688
+ - FaceAttributesType 不含Mask 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2592
2689
  */
2593
2690
  Mask?: AttributeItem
2594
2691
  /**
2595
2692
  * 嘴巴信息,可识别是否张嘴、嘴唇厚度。
2596
- FaceAttributesType 不含 Mouth 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2693
+ - FaceAttributesType 不含 Mouth 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2597
2694
  */
2598
2695
  Mouth?: Mouth
2599
2696
  /**
2600
2697
  * 胡子信息。
2601
- AttributeItem对应的Type为 —— 0:无胡子,1:有胡子。
2602
- FaceAttributesType 不含 Moustache 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2698
+ - AttributeItem对应的Type为 —— 0:无胡子,1:有胡子。
2699
+ - FaceAttributesType 不含 Moustache 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2603
2700
  */
2604
2701
  Moustache?: AttributeItem
2605
2702
  /**
2606
2703
  * 鼻子信息。
2607
- AttributeItem对应的Type为 —— 0:朝天鼻,1:鹰钩鼻,2:普通,3:圆鼻头
2608
- FaceAttributesType 不含 Nose 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2704
+ - AttributeItem对应的Type为 —— 0:朝天鼻,1:鹰钩鼻,2:普通,3:圆鼻头
2705
+ - FaceAttributesType 不含 Nose 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2609
2706
  */
2610
2707
  Nose?: AttributeItem
2611
2708
  /**
2612
2709
  * 脸型信息。
2613
- AttributeItem对应的Type为 —— 0:方脸,1:三角脸,2:鹅蛋脸,3:心形脸,4:圆脸。
2614
- FaceAttributesType 不含 Shape 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2710
+ - AttributeItem对应的Type为 —— 0:方脸,1:三角脸,2:鹅蛋脸,3:心形脸,4:圆脸。
2711
+ - FaceAttributesType 不含 Shape 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2615
2712
  */
2616
2713
  Shape?: AttributeItem
2617
2714
  /**
2618
2715
  * 肤色信息。
2619
- AttributeItem对应的Type为 —— 0:黄色皮肤,1:棕色皮肤,2:黑色皮肤,3:白色皮肤。
2620
- FaceAttributesType 不含 Skin 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2716
+ - AttributeItem对应的Type为 —— 0:黄色皮肤,1:棕色皮肤,2:黑色皮肤,3:白色皮肤。
2717
+ - FaceAttributesType 不含 Skin 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2621
2718
  */
2622
2719
  Skin?: AttributeItem
2623
2720
  /**
2624
- * 微笑程度,[0,100]。
2625
- FaceAttributesType 不含 Smile 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2721
+ * 微笑程度
2722
+ - 取值范围:[0,100]。
2723
+ - FaceAttributesType 不含 Smile 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2626
2724
  */
2627
2725
  Smile?: number
2628
2726
  }
@@ -2632,11 +2730,12 @@ FaceAttributesType 不含 Smile 或检测超过 5 张人脸时,此参数仍返
2632
2730
  */
2633
2731
  export interface AttributeItem {
2634
2732
  /**
2635
- * 属性值
2733
+ * 属性值。
2636
2734
  */
2637
2735
  Type?: number
2638
2736
  /**
2639
- * Type识别概率值,[0,1],代表判断正确的概率。
2737
+ * Type识别概率值。
2738
+ - 取值范围:[0,1],代表判断正确的概率。
2640
2739
  */
2641
2740
  Probability?: number
2642
2741
  }
@@ -2647,24 +2746,24 @@ export interface AttributeItem {
2647
2746
  export interface FaceRect {
2648
2747
  /**
2649
2748
  * 人脸框左上角横坐标。
2650
- 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
2651
- 若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
2749
+ - 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
2750
+ - 若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
2652
2751
  */
2653
- X: number
2752
+ X?: number
2654
2753
  /**
2655
2754
  * 人脸框左上角纵坐标。
2656
- 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
2657
- 若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
2755
+ - 人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
2756
+ - 若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
2658
2757
  */
2659
- Y: number
2758
+ Y?: number
2660
2759
  /**
2661
- * 人脸宽度
2760
+ * 人脸宽度。
2662
2761
  */
2663
- Width: number
2762
+ Width?: number
2664
2763
  /**
2665
- * 人脸高度
2764
+ * 人脸高度。
2666
2765
  */
2667
- Height: number
2766
+ Height?: number
2668
2767
  }
2669
2768
 
2670
2769
  /**