tencentcloud-sdk-nodejs-iai 4.0.431 → 4.0.432

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.
@@ -19,48 +19,46 @@
19
19
  * 眼睛信息
20
20
  */
21
21
  export interface Eye {
22
-
23
- /**
22
+ /**
24
23
  * 识别是否佩戴眼镜。
25
24
  AttributeItem对应的Type为 —— 0:无眼镜,1:普通眼镜,2:墨镜
26
25
  */
27
- Glass: AttributeItem;
28
-
29
- /**
26
+ Glass: AttributeItem
27
+
28
+ /**
30
29
  * 识别眼睛的睁开、闭合状态。
31
30
  AttributeItem对应的Type为 —— 0:睁开,1:闭眼
32
31
  */
33
- EyeOpen: AttributeItem;
34
-
35
- /**
32
+ EyeOpen: AttributeItem
33
+
34
+ /**
36
35
  * 识别是否双眼皮。
37
36
  AttributeItem对应的Type为 —— 0:无,1:有。
38
37
  */
39
- EyelidType: AttributeItem;
40
-
41
- /**
38
+ EyelidType: AttributeItem
39
+
40
+ /**
42
41
  * 眼睛大小。
43
42
  AttributeItem对应的Type为 —— 0:小眼睛,1:普通眼睛,2:大眼睛。
44
43
  */
45
- EyeSize: AttributeItem;
44
+ EyeSize: AttributeItem
46
45
  }
47
46
 
48
47
  /**
49
48
  * 识别出的最相似候选人
50
49
  */
51
50
  export interface Candidate {
51
+ /**
52
+ * 人员ID
53
+ */
54
+ PersonId: string
52
55
 
53
- /**
54
- * 人员ID
55
- */
56
- PersonId: string;
57
-
58
- /**
59
- * 人脸ID,仅在SearchFaces/SearchFacesReturnsByGroup接口返回时有效。人员搜索类接口采用融合特征方式检索,该字段无意义
60
- */
61
- FaceId: string;
62
-
63
- /**
56
+ /**
57
+ * 人脸ID,仅在SearchFaces/SearchFacesReturnsByGroup接口返回时有效。人员搜索类接口采用融合特征方式检索,该字段无意义
58
+ */
59
+ FaceId: string
60
+
61
+ /**
64
62
  * 候选者的匹配得分。
65
63
 
66
64
  1万大小人脸底库下,误识率百分之一对应分数为70分,误识率千分之一对应分数为80分,误识率万分之一对应分数为90分;
@@ -69,164 +67,159 @@ export interface Candidate {
69
67
 
70
68
  一般80分左右可适用大部分场景,建议分数不要超过90分。您可以根据实际情况选择合适的分数。
71
69
  */
72
- Score: number;
73
-
74
- /**
70
+ Score: number
71
+
72
+ /**
75
73
  * 人员名称
76
74
  注意:此字段可能返回 null,表示取不到有效值。
77
75
  */
78
- PersonName: string;
79
-
80
- /**
76
+ PersonName: string
77
+
78
+ /**
81
79
  * 人员性别
82
80
  注意:此字段可能返回 null,表示取不到有效值。
83
81
  */
84
- Gender: number;
85
-
86
- /**
82
+ Gender: number
83
+
84
+ /**
87
85
  * 包含此人员的人员库及描述字段内容列表
88
86
  注意:此字段可能返回 null,表示取不到有效值。
89
87
  */
90
- PersonGroupInfos: Array<PersonGroupInfo>;
88
+ PersonGroupInfos: Array<PersonGroupInfo>
91
89
  }
92
90
 
93
91
  /**
94
92
  * DetectFaceAttributes返回参数结构体
95
93
  */
96
94
  export interface DetectFaceAttributesResponse {
95
+ /**
96
+ * 请求的图片宽度。
97
+ */
98
+ ImageWidth: number
97
99
 
98
- /**
99
- * 请求的图片宽度。
100
- */
101
- ImageWidth: number;
102
-
103
- /**
104
- * 请求的图片高度。
105
- */
106
- ImageHeight: number;
107
-
108
- /**
109
- * 人脸信息列表。
110
- */
111
- FaceDetailInfos: Array<FaceDetailInfo>;
112
-
113
- /**
114
- * 人脸识别所用的算法模型版本。
115
- */
116
- FaceModelVersion: string;
117
-
118
- /**
119
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
120
- */
121
- RequestId?: string;
100
+ /**
101
+ * 请求的图片高度。
102
+ */
103
+ ImageHeight: number
104
+
105
+ /**
106
+ * 人脸信息列表。
107
+ */
108
+ FaceDetailInfos: Array<FaceDetailInfo>
109
+
110
+ /**
111
+ * 人脸识别所用的算法模型版本。
112
+ */
113
+ FaceModelVersion: string
114
+
115
+ /**
116
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
117
+ */
118
+ RequestId?: string
122
119
  }
123
120
 
124
121
  /**
125
122
  * SearchPersonsReturnsByGroup返回参数结构体
126
123
  */
127
124
  export interface SearchPersonsReturnsByGroupResponse {
125
+ /**
126
+ * 搜索的人员库中包含的人员数。若输入图片中所有人脸均不符合质量要求,则返回0。
127
+ */
128
+ PersonNum?: number
128
129
 
129
- /**
130
- * 搜索的人员库中包含的人员数。若输入图片中所有人脸均不符合质量要求,则返回0。
131
- */
132
- PersonNum?: number;
133
-
134
- /**
135
- * 识别结果。
136
- */
137
- ResultsReturnsByGroup?: Array<ResultsReturnsByGroup>;
138
-
139
- /**
140
- * 人脸识别所用的算法模型版本。
141
- */
142
- FaceModelVersion?: string;
143
-
144
- /**
145
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
146
- */
147
- RequestId?: string;
130
+ /**
131
+ * 识别结果。
132
+ */
133
+ ResultsReturnsByGroup?: Array<ResultsReturnsByGroup>
134
+
135
+ /**
136
+ * 人脸识别所用的算法模型版本。
137
+ */
138
+ FaceModelVersion?: string
139
+
140
+ /**
141
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
142
+ */
143
+ RequestId?: string
148
144
  }
149
145
 
150
146
  /**
151
147
  * 包含此人员的人员库及描述字段内容列表
152
148
  */
153
149
  export interface PersonGroupInfo {
150
+ /**
151
+ * 包含此人员的人员库ID
152
+ */
153
+ GroupId: string
154
154
 
155
- /**
156
- * 包含此人员的人员库ID
157
- */
158
- GroupId: string;
159
-
160
- /**
161
- * 人员描述字段内容
162
- */
163
- PersonExDescriptions: Array<string>;
155
+ /**
156
+ * 人员描述字段内容
157
+ */
158
+ PersonExDescriptions: Array<string>
164
159
  }
165
160
 
166
161
  /**
167
162
  * 帽子信息
168
163
  */
169
164
  export interface Hat {
170
-
171
- /**
165
+ /**
172
166
  * 帽子佩戴状态信息。
173
167
  AttributeItem对应的Type为 —— 0:不戴帽子,1:普通帽子,2:头盔,3:保安帽。
174
168
  */
175
- Style: AttributeItem;
176
-
177
- /**
169
+ Style: AttributeItem
170
+
171
+ /**
178
172
  * 帽子颜色。
179
173
  AttributeItem对应的Type为 —— 0:不戴帽子,1:红色系,2:黄色系,3:蓝色系,4:黑色系,5:灰白色系,6:混色系子。
180
174
  */
181
- Color: AttributeItem;
175
+ Color: AttributeItem
182
176
  }
183
177
 
184
178
  /**
185
179
  * CreatePerson请求参数结构体
186
180
  */
187
181
  export interface CreatePersonRequest {
188
-
189
- /**
190
- * 待加入的人员库ID。
191
- */
192
- GroupId: string;
193
-
194
- /**
195
- * 人员名称。[1,60]个字符,可修改,可重复。
196
- */
197
- PersonName: string;
198
-
199
- /**
200
- * 人员ID,单个腾讯云账号下不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B。
201
- */
202
- PersonId: string;
203
-
204
- /**
205
- * 0代表未填写,1代表男性,2代表女性。
206
- */
207
- Gender?: number;
208
-
209
- /**
210
- * 人员描述字段内容,key-value。[0,60]个字符,可修改,可重复。
211
- */
212
- PersonExDescriptionInfos?: Array<PersonExDescriptionInfo>;
213
-
214
- /**
182
+ /**
183
+ * 待加入的人员库ID。
184
+ */
185
+ GroupId: string
186
+
187
+ /**
188
+ * 人员名称。[1,60]个字符,可修改,可重复。
189
+ */
190
+ PersonName: string
191
+
192
+ /**
193
+ * 人员ID,单个腾讯云账号下不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B。
194
+ */
195
+ PersonId: string
196
+
197
+ /**
198
+ * 0代表未填写,1代表男性,2代表女性。
199
+ */
200
+ Gender?: number
201
+
202
+ /**
203
+ * 人员描述字段内容,key-value。[0,60]个字符,可修改,可重复。
204
+ */
205
+ PersonExDescriptionInfos?: Array<PersonExDescriptionInfo>
206
+
207
+ /**
215
208
  * 图片 base64 数据,base64 编码后大小不可超过5M。
216
209
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
217
210
  */
218
- Image?: string;
219
-
220
- /**
211
+ Image?: string
212
+
213
+ /**
221
214
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
222
215
  Url、Image必须提供一个,如果都提供,只使用 Url。
223
216
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
224
217
  非腾讯云存储的Url速度和稳定性可能受一定影响。
225
218
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
226
219
  */
227
- Url?: string;
228
-
229
- /**
220
+ Url?: string
221
+
222
+ /**
230
223
  * 此参数用于控制判断 Image 或 Url 中图片包含的人脸,是否在人员库中已有疑似的同一人。
231
224
  如果判断为已有相同人在人员库中,则不会创建新的人员,返回疑似同一人的人员信息。
232
225
  如果判断没有,则完成创建人员。
@@ -238,9 +231,9 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
238
231
  默认 0。
239
232
  注: 要求越高,则疑似同一人的概率越小。不同要求对应的误识别率仅为参考值,您可以根据实际情况调整。
240
233
  */
241
- UniquePersonControl?: number;
242
-
243
- /**
234
+ UniquePersonControl?: number
235
+
236
+ /**
244
237
  * 图片质量控制。
245
238
  0: 不进行控制;
246
239
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -250,102 +243,99 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
250
243
  默认 0。
251
244
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
252
245
  */
253
- QualityControl?: number;
254
-
255
- /**
256
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
257
- */
258
- NeedRotateDetection?: number;
246
+ QualityControl?: number
247
+
248
+ /**
249
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
250
+ */
251
+ NeedRotateDetection?: number
259
252
  }
260
253
 
261
254
  /**
262
255
  * CreateFace返回参数结构体
263
256
  */
264
257
  export interface CreateFaceResponse {
258
+ /**
259
+ * 加入成功的人脸数量
260
+ */
261
+ SucFaceNum: number
265
262
 
266
- /**
267
- * 加入成功的人脸数量
268
- */
269
- SucFaceNum: number;
270
-
271
- /**
272
- * 加入成功的人脸ID列表
273
- */
274
- SucFaceIds: Array<string>;
275
-
276
- /**
263
+ /**
264
+ * 加入成功的人脸ID列表
265
+ */
266
+ SucFaceIds: Array<string>
267
+
268
+ /**
277
269
  * 每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,
278
270
  -1601代表不符合图片质量控制要求, -1604 代表人脸相似度没有超过FaceMatchThreshold。
279
271
  其他非 0 值代表算法服务异常。
280
272
  RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
281
273
  */
282
- RetCode: Array<number>;
283
-
284
- /**
274
+ RetCode: Array<number>
275
+
276
+ /**
285
277
  * 加入成功的人脸索引。索引顺序和入参中 Images 或 Urls 的顺序一致。
286
278
  例, Urls 中 有 3 个 url,第二个 url 失败,则 SucIndexes 值为 [0,2] 。
287
279
  */
288
- SucIndexes: Array<number>;
289
-
290
- /**
291
- * 加入成功的人脸框位置。顺序和入参中 Images 或 Urls 的顺序一致。
292
- */
293
- SucFaceRects: Array<FaceRect>;
294
-
295
- /**
296
- * 人脸识别所用的算法模型版本。
297
- */
298
- FaceModelVersion: string;
299
-
300
- /**
301
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
302
- */
303
- RequestId?: string;
280
+ SucIndexes: Array<number>
281
+
282
+ /**
283
+ * 加入成功的人脸框位置。顺序和入参中 Images 或 Urls 的顺序一致。
284
+ */
285
+ SucFaceRects: Array<FaceRect>
286
+
287
+ /**
288
+ * 人脸识别所用的算法模型版本。
289
+ */
290
+ FaceModelVersion: string
291
+
292
+ /**
293
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
294
+ */
295
+ RequestId?: string
304
296
  }
305
297
 
306
298
  /**
307
299
  * 人脸属性中的发型信息。
308
300
  */
309
301
  export interface FaceHairAttributesInfo {
310
-
311
- /**
302
+ /**
312
303
  * 0:光头,1:短发,2:中发,3:长发,4:绑发
313
304
  注意:此字段可能返回 null,表示取不到有效值。
314
305
  */
315
- Length: number;
316
-
317
- /**
306
+ Length: number
307
+
308
+ /**
318
309
  * 0:有刘海,1:无刘海
319
310
  注意:此字段可能返回 null,表示取不到有效值。
320
311
  */
321
- Bang: number;
322
-
323
- /**
312
+ Bang: number
313
+
314
+ /**
324
315
  * 0:黑色,1:金色,2:棕色,3:灰白色
325
316
  注意:此字段可能返回 null,表示取不到有效值。
326
317
  */
327
- Color: number;
318
+ Color: number
328
319
  }
329
320
 
330
321
  /**
331
322
  * CreateFace请求参数结构体
332
323
  */
333
324
  export interface CreateFaceRequest {
325
+ /**
326
+ * 人员ID。
327
+ */
328
+ PersonId: string
334
329
 
335
- /**
336
- * 人员ID。
337
- */
338
- PersonId: string;
339
-
340
- /**
330
+ /**
341
331
  * 图片 base64 数据,base64 编码后大小不可超过5M。
342
332
  人员人脸总数量不可超过5张。
343
333
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
344
334
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
345
335
  */
346
- Images?: Array<string>;
347
-
348
- /**
336
+ Images?: Array<string>
337
+
338
+ /**
349
339
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
350
340
  Url、Image必须提供一个,如果都提供,只使用 Url。
351
341
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
@@ -354,15 +344,15 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
354
344
  人员人脸总数量不可超过5张。
355
345
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
356
346
  */
357
- Urls?: Array<string>;
358
-
359
- /**
347
+ Urls?: Array<string>
348
+
349
+ /**
360
350
  * 只有和该人员已有的人脸相似度超过FaceMatchThreshold值的人脸,才能增加人脸成功。
361
351
  默认值60分。取值范围[0,100] 。
362
352
  */
363
- FaceMatchThreshold?: number;
364
-
365
- /**
353
+ FaceMatchThreshold?: number
354
+
355
+ /**
366
356
  * 图片质量控制。
367
357
  0: 不进行控制;
368
358
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -372,30 +362,29 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
372
362
  默认 0。
373
363
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
374
364
  */
375
- QualityControl?: number;
376
-
377
- /**
378
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
379
- */
380
- NeedRotateDetection?: number;
365
+ QualityControl?: number
366
+
367
+ /**
368
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
369
+ */
370
+ NeedRotateDetection?: number
381
371
  }
382
372
 
383
373
  /**
384
374
  * CreateGroup请求参数结构体
385
375
  */
386
376
  export interface CreateGroupRequest {
377
+ /**
378
+ * 人员库名称,[1,60]个字符,可修改,不可重复。
379
+ */
380
+ GroupName: string
387
381
 
388
- /**
389
- * 人员库名称,[1,60]个字符,可修改,不可重复。
390
- */
391
- GroupName: string;
392
-
393
- /**
394
- * 人员库 ID,不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B。
395
- */
396
- GroupId: string;
397
-
398
- /**
382
+ /**
383
+ * 人员库 ID,不可修改,不可重复。支持英文、数字、-%@#&_,长度限制64B。
384
+ */
385
+ GroupId: string
386
+
387
+ /**
399
388
  * 人员库自定义描述字段,用于描述人员库中人员属性,该人员库下所有人员将拥有此描述字段。
400
389
  最多可以创建5个。
401
390
  每个自定义描述字段支持[1,30]个字符。
@@ -404,14 +393,14 @@ export interface CreateGroupRequest {
404
393
  则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段,
405
394
  可在对应人员描述字段中填写内容,登记该人员的学号、工号、手机号等信息。
406
395
  */
407
- GroupExDescriptions?: Array<string>;
408
-
409
- /**
410
- * 人员库信息备注,[0,40]个字符。
411
- */
412
- Tag?: string;
413
-
414
- /**
396
+ GroupExDescriptions?: Array<string>
397
+
398
+ /**
399
+ * 人员库信息备注,[0,40]个字符。
400
+ */
401
+ Tag?: string
402
+
403
+ /**
415
404
  * 人脸识别服务所用的算法模型版本。
416
405
 
417
406
  目前入参支持 “2.0”和“3.0“ 两个输入。
@@ -422,116 +411,112 @@ export interface CreateGroupRequest {
422
411
 
423
412
  不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
424
413
  */
425
- FaceModelVersion?: string;
414
+ FaceModelVersion?: string
426
415
  }
427
416
 
428
417
  /**
429
418
  * GetPersonGroupInfo请求参数结构体
430
419
  */
431
420
  export interface GetPersonGroupInfoRequest {
421
+ /**
422
+ * 人员ID
423
+ */
424
+ PersonId: string
432
425
 
433
- /**
434
- * 人员ID
435
- */
436
- PersonId: string;
437
-
438
- /**
439
- * 起始序号,默认值为0
440
- */
441
- Offset?: number;
442
-
443
- /**
444
- * 返回数量,默认值为10,最大值为100
445
- */
446
- Limit?: number;
426
+ /**
427
+ * 起始序号,默认值为0
428
+ */
429
+ Offset?: number
430
+
431
+ /**
432
+ * 返回数量,默认值为10,最大值为100
433
+ */
434
+ Limit?: number
447
435
  }
448
436
 
449
437
  /**
450
438
  * 人脸信息列表。
451
439
  */
452
440
  export interface FaceInfo {
453
-
454
- /**
441
+ /**
455
442
  * 人脸框左上角横坐标。
456
443
  人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
457
444
  若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
458
445
  */
459
- X: number;
460
-
461
- /**
446
+ X: number
447
+
448
+ /**
462
449
  * 人脸框左上角纵坐标。
463
450
  人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
464
451
  若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
465
452
  */
466
- Y: number;
467
-
468
- /**
469
- * 人脸框宽度。
470
- */
471
- Width: number;
472
-
473
- /**
474
- * 人脸框高度。
475
- */
476
- Height: number;
477
-
478
- /**
453
+ Y: number
454
+
455
+ /**
456
+ * 人脸框宽度。
457
+ */
458
+ Width: number
459
+
460
+ /**
461
+ * 人脸框高度。
462
+ */
463
+ Height: number
464
+
465
+ /**
479
466
  * 人脸属性信息,包含性别( gender )、年龄( age )、表情( expression )、
480
467
  魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息。
481
468
  */
482
- FaceAttributesInfo: FaceAttributesInfo;
483
-
484
- /**
469
+ FaceAttributesInfo: FaceAttributesInfo
470
+
471
+ /**
485
472
  * 人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。
486
473
  注意:此字段可能返回 null,表示取不到有效值。
487
474
  */
488
- FaceQualityInfo: FaceQualityInfo;
475
+ FaceQualityInfo: FaceQualityInfo
489
476
  }
490
477
 
491
478
  /**
492
479
  * 眉毛信息
493
480
  */
494
481
  export interface Eyebrow {
495
-
496
- /**
482
+ /**
497
483
  * 眉毛浓密。
498
484
  AttributeItem对应的Type为 —— 0:淡眉,1:浓眉。
499
485
  */
500
- EyebrowDensity: AttributeItem;
501
-
502
- /**
486
+ EyebrowDensity: AttributeItem
487
+
488
+ /**
503
489
  * 眉毛弯曲。
504
490
  AttributeItem对应的Type为 —— 0:不弯,1:弯眉。
505
491
  */
506
- EyebrowCurve: AttributeItem;
507
-
508
- /**
492
+ EyebrowCurve: AttributeItem
493
+
494
+ /**
509
495
  * 眉毛长短。
510
496
  AttributeItem对应的Type为 —— 0:短眉毛,1:长眉毛。
511
497
  */
512
- EyebrowLength: AttributeItem;
498
+ EyebrowLength: AttributeItem
513
499
  }
514
500
 
515
501
  /**
516
502
  * AnalyzeDenseLandmarks请求参数结构体
517
503
  */
518
504
  export interface AnalyzeDenseLandmarksRequest {
519
-
520
- /**
505
+ /**
521
506
  * 检测模式。0 为检测所有出现的人脸, 1 为检测面积最大的人脸。
522
507
  默认为 0。
523
508
  最多返回 5 张人脸的五官定位(人脸关键点)具体信息。
524
509
  */
525
- Mode?: number;
526
-
527
- /**
510
+ Mode?: number
511
+
512
+ /**
528
513
  * 图片 base64 数据,base64 编码后大小不可超过5M。
529
514
  jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
530
515
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
531
516
  */
532
- Image?: string;
533
-
534
- /**
517
+ Image?: string
518
+
519
+ /**
535
520
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
536
521
  jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
537
522
  Url、Image必须提供一个,如果都提供,只使用 Url。
@@ -539,133 +524,129 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
539
524
  非腾讯云存储的Url速度和稳定性可能受一定影响。
540
525
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
541
526
  */
542
- Url?: string;
543
-
544
- /**
545
- * 人脸识别服务所用的算法模型版本。本接口仅支持 “3.0“ 输入。
546
- */
547
- FaceModelVersion?: string;
548
-
549
- /**
550
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
551
- */
552
- NeedRotateDetection?: number;
527
+ Url?: string
528
+
529
+ /**
530
+ * 人脸识别服务所用的算法模型版本。本接口仅支持 “3.0“ 输入。
531
+ */
532
+ FaceModelVersion?: string
533
+
534
+ /**
535
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
536
+ */
537
+ NeedRotateDetection?: number
553
538
  }
554
539
 
555
540
  /**
556
541
  * GetGroupList请求参数结构体
557
542
  */
558
543
  export interface GetGroupListRequest {
544
+ /**
545
+ * 起始序号,默认值为0
546
+ */
547
+ Offset?: number
559
548
 
560
- /**
561
- * 起始序号,默认值为0
562
- */
563
- Offset?: number;
564
-
565
- /**
566
- * 返回数量,默认值为10,最大值为1000
567
- */
568
- Limit?: number;
549
+ /**
550
+ * 返回数量,默认值为10,最大值为1000
551
+ */
552
+ Limit?: number
569
553
  }
570
554
 
571
555
  /**
572
556
  * GetUpgradeGroupFaceModelVersionJobList请求参数结构体
573
557
  */
574
558
  export interface GetUpgradeGroupFaceModelVersionJobListRequest {
559
+ /**
560
+ * 起始序号,默认值为0。
561
+ */
562
+ Offset?: number
575
563
 
576
- /**
577
- * 起始序号,默认值为0
578
- */
579
- Offset?: number;
580
-
581
- /**
582
- * 返回数量,默认值为10,最大值为1000。
583
- */
584
- Limit?: number;
564
+ /**
565
+ * 返回数量,默认值为10,最大值为1000
566
+ */
567
+ Limit?: number
585
568
  }
586
569
 
587
570
  /**
588
571
  * GetUpgradeGroupFaceModelVersionResult返回参数结构体
589
572
  */
590
573
  export interface GetUpgradeGroupFaceModelVersionResultResponse {
591
-
592
- /**
574
+ /**
593
575
  * 人员升级任务预估结束时间。 StartTimestamp的值是自 Unix 纪元时间到人员查重任务预估结束的毫秒数。
594
576
  Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。
595
577
  如果为0表示这个任务已经执行完毕。
596
578
  */
597
- EndTimestamp: number;
598
-
599
- /**
600
- * 升级任务完成进度。取值[0.0,100.0]。
601
- */
602
- Progress: number;
603
-
604
- /**
605
- * 0表示升级中,1表示升级完毕,2表示回滚完毕。
606
- */
607
- Status: number;
608
-
609
- /**
579
+ EndTimestamp: number
580
+
581
+ /**
582
+ * 升级任务完成进度。取值[0.0,100.0]。
583
+ */
584
+ Progress: number
585
+
586
+ /**
587
+ * 0表示升级中,1表示升级完毕,2表示回滚完毕。
588
+ */
589
+ Status: number
590
+
591
+ /**
610
592
  * 升级起始时间。
611
593
  StartTime的值是自 Unix 纪元时间到Group创建时间的毫秒数。
612
594
  Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。
613
595
  有关更多信息,请参阅 Unix 时间。
614
596
  */
615
- StartTime: number;
616
-
617
- /**
618
- * 当前算法模型版本。
619
- */
620
- FromFaceModelVersion: string;
621
-
622
- /**
623
- * 目标算法模型版本。
624
- */
625
- ToFaceModelVersion: string;
626
-
627
- /**
628
- * 人员库ID。
629
- */
630
- GroupId: string;
631
-
632
- /**
633
- * 无法升级的人脸Id信息,文件格式为json。半小时有效
634
- */
635
- FailedFacesUrl: string;
636
-
637
- /**
638
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
639
- */
640
- RequestId?: string;
597
+ StartTime: number
598
+
599
+ /**
600
+ * 当前算法模型版本。
601
+ */
602
+ FromFaceModelVersion: string
603
+
604
+ /**
605
+ * 目标算法模型版本。
606
+ */
607
+ ToFaceModelVersion: string
608
+
609
+ /**
610
+ * 人员库ID。
611
+ */
612
+ GroupId: string
613
+
614
+ /**
615
+ * 无法升级的人脸Id信息,文件格式为json。半小时有效
616
+ */
617
+ FailedFacesUrl: string
618
+
619
+ /**
620
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
621
+ */
622
+ RequestId?: string
641
623
  }
642
624
 
643
625
  /**
644
626
  * AnalyzeFace请求参数结构体
645
627
  */
646
628
  export interface AnalyzeFaceRequest {
629
+ /**
630
+ * 检测模式。0 为检测所有出现的人脸, 1 为检测面积最大的人脸。默认为 0。最多返回 10 张人脸的五官定位(人脸关键点)具体信息。
631
+ */
632
+ Mode?: number
647
633
 
648
- /**
649
- * 检测模式。0 为检测所有出现的人脸, 1 为检测面积最大的人脸。默认为 0。最多返回 10 张人脸的五官定位(人脸关键点)具体信息。
650
- */
651
- Mode?: number;
652
-
653
- /**
634
+ /**
654
635
  * 图片 base64 数据,base64 编码后大小不可超过5M。
655
636
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
656
637
  */
657
- Image?: string;
658
-
659
- /**
638
+ Image?: string
639
+
640
+ /**
660
641
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
661
642
  Url、Image必须提供一个,如果都提供,只使用 Url。
662
643
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
663
644
  非腾讯云存储的Url速度和稳定性可能受一定影响。
664
645
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
665
646
  */
666
- Url?: string;
667
-
668
- /**
647
+ Url?: string
648
+
649
+ /**
669
650
  * 人脸识别服务所用的算法模型版本。
670
651
 
671
652
  目前入参支持 “2.0”和“3.0“ 两个输入。
@@ -676,251 +657,239 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
676
657
 
677
658
  不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
678
659
  */
679
- FaceModelVersion?: string;
680
-
681
- /**
682
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
683
- */
684
- NeedRotateDetection?: number;
660
+ FaceModelVersion?: string
661
+
662
+ /**
663
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
664
+ */
665
+ NeedRotateDetection?: number
685
666
  }
686
667
 
687
668
  /**
688
669
  * CreatePerson返回参数结构体
689
670
  */
690
671
  export interface CreatePersonResponse {
672
+ /**
673
+ * 人脸图片唯一标识。
674
+ */
675
+ FaceId?: string
691
676
 
692
- /**
693
- * 人脸图片唯一标识。
694
- */
695
- FaceId?: string;
696
-
697
- /**
677
+ /**
698
678
  * 检测出的人脸框的位置。
699
679
  注意:此字段可能返回 null,表示取不到有效值。
700
680
  */
701
- FaceRect?: FaceRect;
702
-
703
- /**
681
+ FaceRect?: FaceRect
682
+
683
+ /**
704
684
  * 疑似同一人的PersonId。
705
685
  当 UniquePersonControl 参数不为0且人员库中有疑似的同一人,此参数才有意义。
706
686
  */
707
- SimilarPersonId?: string;
708
-
709
- /**
710
- * 人脸识别所用的算法模型版本。
711
- */
712
- FaceModelVersion?: string;
713
-
714
- /**
715
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
716
- */
717
- RequestId?: string;
687
+ SimilarPersonId?: string
688
+
689
+ /**
690
+ * 人脸识别所用的算法模型版本。
691
+ */
692
+ FaceModelVersion?: string
693
+
694
+ /**
695
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
696
+ */
697
+ RequestId?: string
718
698
  }
719
699
 
720
700
  /**
721
701
  * SearchFaces返回参数结构体
722
702
  */
723
703
  export interface SearchFacesResponse {
704
+ /**
705
+ * 识别结果。
706
+ */
707
+ Results: Array<Result>
724
708
 
725
- /**
726
- * 识别结果。
727
- */
728
- Results: Array<Result>;
729
-
730
- /**
731
- * 搜索的人员库中包含的人脸数。
732
- */
733
- FaceNum: number;
734
-
735
- /**
736
- * 人脸识别所用的算法模型版本。
737
- */
738
- FaceModelVersion: string;
739
-
740
- /**
741
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
742
- */
743
- RequestId?: string;
709
+ /**
710
+ * 搜索的人员库中包含的人脸数。
711
+ */
712
+ FaceNum: number
713
+
714
+ /**
715
+ * 人脸识别所用的算法模型版本。
716
+ */
717
+ FaceModelVersion: string
718
+
719
+ /**
720
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
721
+ */
722
+ RequestId?: string
744
723
  }
745
724
 
746
725
  /**
747
726
  * CopyPerson返回参数结构体
748
727
  */
749
728
  export interface CopyPersonResponse {
729
+ /**
730
+ * 成功加入的人员库数量
731
+ */
732
+ SucGroupNum?: number
750
733
 
751
- /**
752
- * 成功加入的人员库数量
753
- */
754
- SucGroupNum?: number;
755
-
756
- /**
757
- * 成功加入的人员库列表
758
- */
759
- SucGroupIds?: Array<string>;
760
-
761
- /**
762
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
763
- */
764
- RequestId?: string;
734
+ /**
735
+ * 成功加入的人员库列表
736
+ */
737
+ SucGroupIds?: Array<string>
738
+
739
+ /**
740
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
741
+ */
742
+ RequestId?: string
765
743
  }
766
744
 
767
745
  /**
768
746
  * 分组识别结果Item
769
747
  */
770
748
  export interface GroupCandidate {
749
+ /**
750
+ * 人员库ID 。
751
+ */
752
+ GroupId: string
771
753
 
772
- /**
773
- * 人员库ID 。
774
- */
775
- GroupId: string;
776
-
777
- /**
778
- * 识别出的最相似候选人。
779
- */
780
- Candidates: Array<Candidate>;
754
+ /**
755
+ * 识别出的最相似候选人。
756
+ */
757
+ Candidates: Array<Candidate>
781
758
  }
782
759
 
783
760
  /**
784
761
  * DeleteFace返回参数结构体
785
762
  */
786
763
  export interface DeleteFaceResponse {
764
+ /**
765
+ * 删除成功的人脸数量
766
+ */
767
+ SucDeletedNum?: number
787
768
 
788
- /**
789
- * 删除成功的人脸数量
790
- */
791
- SucDeletedNum?: number;
792
-
793
- /**
794
- * 删除成功的人脸ID列表
795
- */
796
- SucFaceIds?: Array<string>;
797
-
798
- /**
799
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
800
- */
801
- RequestId?: string;
769
+ /**
770
+ * 删除成功的人脸ID列表
771
+ */
772
+ SucFaceIds?: Array<string>
773
+
774
+ /**
775
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
776
+ */
777
+ RequestId?: string
802
778
  }
803
779
 
804
780
  /**
805
781
  * DeletePerson请求参数结构体
806
782
  */
807
783
  export interface DeletePersonRequest {
808
-
809
- /**
810
- * 人员ID
811
- */
812
- PersonId: string;
784
+ /**
785
+ * 人员ID
786
+ */
787
+ PersonId: string
813
788
  }
814
789
 
815
790
  /**
816
791
  * DetectLiveFace返回参数结构体
817
792
  */
818
793
  export interface DetectLiveFaceResponse {
819
-
820
- /**
794
+ /**
821
795
  * 活体打分,取值范围 [0,100],分数一般落于[80, 100]区间内,0分也为常见值。推荐相大于 87 时可判断为活体。可根据具体场景自行调整阈值。
822
796
  本字段当且仅当FaceModelVersion为2.0时才具备参考意义。
823
797
  */
824
- Score: number;
825
-
826
- /**
827
- * 人脸识别所用的算法模型版本。
828
- */
829
- FaceModelVersion: string;
830
-
831
- /**
798
+ Score: number
799
+
800
+ /**
801
+ * 人脸识别所用的算法模型版本。
802
+ */
803
+ FaceModelVersion: string
804
+
805
+ /**
832
806
  * 活体检测是否通过。
833
807
  本字段只有FaceModelVersion为3.0时才具备参考意义。
834
808
  */
835
- IsLiveness: boolean;
836
-
837
- /**
838
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
839
- */
840
- RequestId?: string;
809
+ IsLiveness: boolean
810
+
811
+ /**
812
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
813
+ */
814
+ RequestId?: string
841
815
  }
842
816
 
843
817
  /**
844
818
  * DeleteFace请求参数结构体
845
819
  */
846
820
  export interface DeleteFaceRequest {
821
+ /**
822
+ * 人员ID
823
+ */
824
+ PersonId: string
847
825
 
848
- /**
849
- * 人员ID
850
- */
851
- PersonId: string;
852
-
853
- /**
854
- * 待删除的人脸ID列表
855
- */
856
- FaceIds: Array<string>;
826
+ /**
827
+ * 待删除的人脸ID列表
828
+ */
829
+ FaceIds: Array<string>
857
830
  }
858
831
 
859
832
  /**
860
833
  * ModifyGroup请求参数结构体
861
834
  */
862
835
  export interface ModifyGroupRequest {
836
+ /**
837
+ * 人员库ID
838
+ */
839
+ GroupId: string
863
840
 
864
- /**
865
- * 人员库ID
866
- */
867
- GroupId: string;
868
-
869
- /**
870
- * 人员库名称
871
- */
872
- GroupName?: string;
873
-
874
- /**
875
- * 需要修改的人员库自定义描述字段,key-value
876
- */
877
- GroupExDescriptionInfos?: Array<GroupExDescriptionInfo>;
878
-
879
- /**
880
- * 人员库信息备注
881
- */
882
- Tag?: string;
841
+ /**
842
+ * 人员库名称
843
+ */
844
+ GroupName?: string
845
+
846
+ /**
847
+ * 需要修改的人员库自定义描述字段,key-value
848
+ */
849
+ GroupExDescriptionInfos?: Array<GroupExDescriptionInfo>
850
+
851
+ /**
852
+ * 人员库信息备注
853
+ */
854
+ Tag?: string
883
855
  }
884
856
 
885
857
  /**
886
858
  * DeleteGroup请求参数结构体
887
859
  */
888
860
  export interface DeleteGroupRequest {
889
-
890
- /**
891
- * 人员库ID。
892
- */
893
- GroupId: string;
861
+ /**
862
+ * 人员库ID。
863
+ */
864
+ GroupId: string
894
865
  }
895
866
 
896
867
  /**
897
868
  * UpgradeGroupFaceModelVersion请求参数结构体
898
869
  */
899
870
  export interface UpgradeGroupFaceModelVersionRequest {
871
+ /**
872
+ * 需要升级的人员库ID。
873
+ */
874
+ GroupId: string
900
875
 
901
- /**
902
- * 需要升级的人员库ID。
903
- */
904
- GroupId: string;
905
-
906
- /**
907
- * 需要升级至的算法模型版本。默认为最新版本。不可逆向升级
908
- */
909
- FaceModelVersion: string;
876
+ /**
877
+ * 需要升级至的算法模型版本。默认为最新版本。不可逆向升级
878
+ */
879
+ FaceModelVersion: string
910
880
  }
911
881
 
912
882
  /**
913
883
  * DetectLiveFace请求参数结构体
914
884
  */
915
885
  export interface DetectLiveFaceRequest {
916
-
917
- /**
886
+ /**
918
887
  * 图片 base64 数据,base64 编码后大小不可超过5M(图片的宽高比请接近3:4,不符合宽高比的图片返回的分值不具备参考意义)。
919
888
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
920
889
  */
921
- Image?: string;
922
-
923
- /**
890
+ Image?: string
891
+
892
+ /**
924
893
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
925
894
  Url、Image必须提供一个,如果都提供,只使用 Url。
926
895
  (图片的宽高比请接近 3:4,不符合宽高比的图片返回的分值不具备参考意义)
@@ -928,9 +897,9 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
928
897
  非腾讯云存储的Url速度和稳定性可能受一定影响。
929
898
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
930
899
  */
931
- Url?: string;
932
-
933
- /**
900
+ Url?: string
901
+
902
+ /**
934
903
  * 人脸识别服务所用的算法模型版本。
935
904
 
936
905
  目前入参支持 “2.0”和“3.0“ 两个输入。
@@ -941,237 +910,229 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
941
910
 
942
911
  不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
943
912
  */
944
- FaceModelVersion?: string;
913
+ FaceModelVersion?: string
945
914
  }
946
915
 
947
916
  /**
948
917
  * GetPersonBaseInfo返回参数结构体
949
918
  */
950
919
  export interface GetPersonBaseInfoResponse {
920
+ /**
921
+ * 人员名称
922
+ */
923
+ PersonName?: string
951
924
 
952
- /**
953
- * 人员名称
954
- */
955
- PersonName?: string;
956
-
957
- /**
958
- * 人员性别
959
- */
960
- Gender?: number;
961
-
962
- /**
963
- * 包含的人脸 ID 列表
964
- */
965
- FaceIds?: Array<string>;
966
-
967
- /**
968
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
969
- */
970
- RequestId?: string;
925
+ /**
926
+ * 人员性别
927
+ */
928
+ Gender?: number
929
+
930
+ /**
931
+ * 包含的人脸 ID 列表
932
+ */
933
+ FaceIds?: Array<string>
934
+
935
+ /**
936
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
937
+ */
938
+ RequestId?: string
971
939
  }
972
940
 
973
941
  /**
974
942
  * SearchPersons返回参数结构体
975
943
  */
976
944
  export interface SearchPersonsResponse {
945
+ /**
946
+ * 识别结果。
947
+ */
948
+ Results: Array<Result>
977
949
 
978
- /**
979
- * 识别结果。
980
- */
981
- Results: Array<Result>;
982
-
983
- /**
984
- * 搜索的人员库中包含的人员数。若输入图片中所有人脸均不符合质量要求,则返回0。
985
- */
986
- PersonNum: number;
987
-
988
- /**
950
+ /**
951
+ * 搜索的人员库中包含的人员数。若输入图片中所有人脸均不符合质量要求,则返回0。
952
+ */
953
+ PersonNum: number
954
+
955
+ /**
989
956
  * 人脸识别所用的算法模型版本。
990
957
  注意:此字段可能返回 null,表示取不到有效值。
991
958
  */
992
- FaceModelVersion: string;
993
-
994
- /**
995
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
996
- */
997
- RequestId?: string;
959
+ FaceModelVersion: string
960
+
961
+ /**
962
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
963
+ */
964
+ RequestId?: string
998
965
  }
999
966
 
1000
967
  /**
1001
968
  * GetUpgradeGroupFaceModelVersionResult请求参数结构体
1002
969
  */
1003
970
  export interface GetUpgradeGroupFaceModelVersionResultRequest {
1004
-
1005
- /**
1006
- * 升级任务ID,用于查询、获取人员库升级的进度和结果。
1007
- */
1008
- JobId: string;
971
+ /**
972
+ * 升级任务ID,用于查询、获取人员库升级的进度和结果。
973
+ */
974
+ JobId: string
1009
975
  }
1010
976
 
1011
977
  /**
1012
978
  * 返回的人员库信息
1013
979
  */
1014
980
  export interface GroupInfo {
981
+ /**
982
+ * 人员库名称
983
+ */
984
+ GroupName: string
1015
985
 
1016
- /**
1017
- * 人员库名称
1018
- */
1019
- GroupName: string;
1020
-
1021
- /**
1022
- * 人员库ID
1023
- */
1024
- GroupId: string;
1025
-
1026
- /**
986
+ /**
987
+ * 人员库ID
988
+ */
989
+ GroupId: string
990
+
991
+ /**
1027
992
  * 人员库自定义描述字段
1028
993
  注意:此字段可能返回 null,表示取不到有效值。
1029
994
  */
1030
- GroupExDescriptions: Array<string>;
1031
-
1032
- /**
995
+ GroupExDescriptions: Array<string>
996
+
997
+ /**
1033
998
  * 人员库信息备注
1034
999
  注意:此字段可能返回 null,表示取不到有效值。
1035
1000
  */
1036
- Tag: string;
1037
-
1038
- /**
1001
+ Tag: string
1002
+
1003
+ /**
1039
1004
  * 人脸识别所用的算法模型版本。
1040
1005
  注意:此字段可能返回 null,表示取不到有效值。
1041
1006
  */
1042
- FaceModelVersion: string;
1043
-
1044
- /**
1007
+ FaceModelVersion: string
1008
+
1009
+ /**
1045
1010
  * Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
1046
1011
  Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。
1047
1012
  注意:此字段可能返回 null,表示取不到有效值。
1048
1013
  */
1049
- CreationTimestamp: number;
1014
+ CreationTimestamp: number
1050
1015
  }
1051
1016
 
1052
1017
  /**
1053
1018
  * 人脸质量信息,包含质量分(score)、模糊分(sharpness)、光照分(brightness)、遮挡分(completeness)。只有当NeedFaceDetection设为1时才返回有效信息。
1054
1019
  */
1055
1020
  export interface FaceQualityInfo {
1056
-
1057
- /**
1021
+ /**
1058
1022
  * 质量分: [0,100],综合评价图像质量是否适合人脸识别,分数越高质量越好。
1059
1023
  正常情况,只需要使用Score作为质量分总体的判断标准即可。Sharpness、Brightness、Completeness等细项分仅供参考。
1060
1024
  参考范围:[0,40]较差,[40,60] 一般,[60,80]较好,[80,100]很好。
1061
1025
  建议:人脸入库选取70以上的图片。
1062
1026
  注意:此字段可能返回 null,表示取不到有效值。
1063
1027
  */
1064
- Score: number;
1065
-
1066
- /**
1028
+ Score: number
1029
+
1030
+ /**
1067
1031
  * 清晰分:[0,100],评价图片清晰程度,分数越高越清晰。
1068
1032
  参考范围:[0,40]特别模糊,[40,60]模糊,[60,80]一般,[80,100]清晰。
1069
1033
  建议:人脸入库选取80以上的图片。
1070
1034
  注意:此字段可能返回 null,表示取不到有效值。
1071
1035
  */
1072
- Sharpness: number;
1073
-
1074
- /**
1036
+ Sharpness: number
1037
+
1038
+ /**
1075
1039
  * 光照分:[0,100],评价图片光照程度,分数越高越亮。
1076
1040
  参考范围: [0,30]偏暗,[30,70]光照正常,[70,100]偏亮。
1077
1041
  建议:人脸入库选取[30,70]的图片。
1078
1042
  注意:此字段可能返回 null,表示取不到有效值。
1079
1043
  */
1080
- Brightness: number;
1081
-
1082
- /**
1044
+ Brightness: number
1045
+
1046
+ /**
1083
1047
  * 五官遮挡分,评价眉毛(Eyebrow)、眼睛(Eye)、鼻子(Nose)、脸颊(Cheek)、嘴巴(Mouth)、下巴(Chin)的被遮挡程度。
1084
1048
  注意:此字段可能返回 null,表示取不到有效值。
1085
1049
  */
1086
- Completeness: FaceQualityCompleteness;
1050
+ Completeness: FaceQualityCompleteness
1087
1051
  }
1088
1052
 
1089
1053
  /**
1090
1054
  * SearchFacesReturnsByGroup返回参数结构体
1091
1055
  */
1092
1056
  export interface SearchFacesReturnsByGroupResponse {
1057
+ /**
1058
+ * 搜索的人员库中包含的人脸数。
1059
+ */
1060
+ FaceNum: number
1093
1061
 
1094
- /**
1095
- * 搜索的人员库中包含的人脸数。
1096
- */
1097
- FaceNum: number;
1098
-
1099
- /**
1100
- * 识别结果。
1101
- */
1102
- ResultsReturnsByGroup: Array<ResultsReturnsByGroup>;
1103
-
1104
- /**
1105
- * 人脸识别所用的算法模型版本。
1106
- */
1107
- FaceModelVersion: string;
1108
-
1109
- /**
1110
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1111
- */
1112
- RequestId?: string;
1062
+ /**
1063
+ * 识别结果。
1064
+ */
1065
+ ResultsReturnsByGroup: Array<ResultsReturnsByGroup>
1066
+
1067
+ /**
1068
+ * 人脸识别所用的算法模型版本。
1069
+ */
1070
+ FaceModelVersion: string
1071
+
1072
+ /**
1073
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1074
+ */
1075
+ RequestId?: string
1113
1076
  }
1114
1077
 
1115
1078
  /**
1116
1079
  * CopyPerson请求参数结构体
1117
1080
  */
1118
1081
  export interface CopyPersonRequest {
1082
+ /**
1083
+ * 人员ID
1084
+ */
1085
+ PersonId: string
1119
1086
 
1120
- /**
1121
- * 人员ID
1122
- */
1123
- PersonId: string;
1124
-
1125
- /**
1126
- * 待加入的人员库列表
1127
- */
1128
- GroupIds: Array<string>;
1087
+ /**
1088
+ * 待加入的人员库列表
1089
+ */
1090
+ GroupIds: Array<string>
1129
1091
  }
1130
1092
 
1131
1093
  /**
1132
1094
  * SearchPersonsReturnsByGroup请求参数结构体
1133
1095
  */
1134
1096
  export interface SearchPersonsReturnsByGroupRequest {
1097
+ /**
1098
+ * 希望搜索的人员库列表,上限60个。
1099
+ */
1100
+ GroupIds: Array<string>
1135
1101
 
1136
- /**
1137
- * 希望搜索的人员库列表,上限60个。
1138
- */
1139
- GroupIds: Array<string>;
1140
-
1141
- /**
1102
+ /**
1142
1103
  * 图片 base64 数据,base64 编码后大小不可超过5M。
1143
1104
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1144
1105
  */
1145
- Image?: string;
1146
-
1147
- /**
1106
+ Image?: string
1107
+
1108
+ /**
1148
1109
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
1149
1110
  Url、Image必须提供一个,如果都提供,只使用 Url。
1150
1111
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1151
1112
  非腾讯云存储的Url速度和稳定性可能受一定影响。
1152
1113
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1153
1114
  */
1154
- Url?: string;
1155
-
1156
- /**
1115
+ Url?: string
1116
+
1117
+ /**
1157
1118
  * 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1158
1119
  MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1159
1120
  例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1160
1121
  */
1161
- MaxFaceNum?: number;
1162
-
1163
- /**
1164
- * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
1165
- */
1166
- MinFaceSize?: number;
1167
-
1168
- /**
1122
+ MaxFaceNum?: number
1123
+
1124
+ /**
1125
+ * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
1126
+ */
1127
+ MinFaceSize?: number
1128
+
1129
+ /**
1169
1130
  * 被检测到的人脸,对应最多返回的最相似人员数目。默认值为5,最大值为10。
1170
1131
  例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
1171
1132
  */
1172
- MaxPersonNumPerGroup?: number;
1173
-
1174
- /**
1133
+ MaxPersonNumPerGroup?: number
1134
+
1135
+ /**
1175
1136
  * 图片质量控制。
1176
1137
  0: 不进行控制;
1177
1138
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -1181,129 +1142,127 @@ MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要
1181
1142
  默认 0。
1182
1143
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1183
1144
  */
1184
- QualityControl?: number;
1185
-
1186
- /**
1187
- * 出参Score中,只有超过FaceMatchThreshold值的结果才会返回。默认为0。
1188
- */
1189
- FaceMatchThreshold?: number;
1190
-
1191
- /**
1192
- * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1193
- */
1194
- NeedPersonInfo?: number;
1195
-
1196
- /**
1197
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1198
- */
1199
- NeedRotateDetection?: number;
1145
+ QualityControl?: number
1146
+
1147
+ /**
1148
+ * 出参Score中,只有超过FaceMatchThreshold值的结果才会返回。默认为0。
1149
+ */
1150
+ FaceMatchThreshold?: number
1151
+
1152
+ /**
1153
+ * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1154
+ */
1155
+ NeedPersonInfo?: number
1156
+
1157
+ /**
1158
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1159
+ */
1160
+ NeedRotateDetection?: number
1200
1161
  }
1201
1162
 
1202
1163
  /**
1203
1164
  * DeletePersonFromGroup返回参数结构体
1204
1165
  */
1205
1166
  export interface DeletePersonFromGroupResponse {
1206
-
1207
- /**
1208
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1209
- */
1210
- RequestId?: string;
1167
+ /**
1168
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1169
+ */
1170
+ RequestId?: string
1211
1171
  }
1212
1172
 
1213
1173
  /**
1214
1174
  * 稠密关键点详细信息
1215
1175
  */
1216
1176
  export interface DenseFaceShape {
1217
-
1218
- /**
1219
- * 人脸框左上角横坐标。
1220
- */
1221
- X: number;
1222
-
1223
- /**
1224
- * 人脸框左上角纵坐标。
1225
- */
1226
- Y: number;
1227
-
1228
- /**
1229
- * 人脸框宽度。
1230
- */
1231
- Width: number;
1232
-
1233
- /**
1234
- * 人脸框高度。
1235
- */
1236
- Height: number;
1237
-
1238
- /**
1239
- * 描述左侧眼睛轮廓的 XX 点。
1240
- */
1241
- LeftEye: Array<Point>;
1242
-
1243
- /**
1244
- * 描述右侧眼睛轮廓的 XX 点。
1245
- */
1246
- RightEye: Array<Point>;
1247
-
1248
- /**
1249
- * 描述左侧眉毛轮廓的 XX 点。
1250
- */
1251
- LeftEyeBrow: Array<Point>;
1252
-
1253
- /**
1254
- * 描述右侧眉毛轮廓的 XX 点。
1255
- */
1256
- RightEyeBrow: Array<Point>;
1257
-
1258
- /**
1259
- * 描述外嘴巴轮廓的 XX 点, 从左侧开始逆时针返回。
1260
- */
1261
- MouthOutside: Array<Point>;
1262
-
1263
- /**
1264
- * 描述内嘴巴轮廓的 XX 点,从左侧开始逆时针返回。
1265
- */
1266
- MouthInside: Array<Point>;
1267
-
1268
- /**
1269
- * 描述鼻子轮廓的 XX 点。
1270
- */
1271
- Nose: Array<Point>;
1272
-
1273
- /**
1274
- * 左瞳孔轮廓的 XX 个点。
1275
- */
1276
- LeftPupil: Array<Point>;
1277
-
1278
- /**
1279
- * 右瞳孔轮廓的 XX 个点。
1280
- */
1281
- RightPupil: Array<Point>;
1282
-
1283
- /**
1284
- * 中轴线轮廓的 XX 个点。
1285
- */
1286
- CentralAxis: Array<Point>;
1287
-
1288
- /**
1289
- * 下巴轮廓的 XX 个点。
1290
- */
1291
- Chin: Array<Point>;
1292
-
1293
- /**
1294
- * 左眼袋的 XX 个点。
1295
- */
1296
- LeftEyeBags: Array<Point>;
1297
-
1298
- /**
1299
- * 右眼袋的 XX 个点。
1300
- */
1301
- RightEyeBags: Array<Point>;
1302
-
1303
- /**
1304
- * 额头的 XX 个点。
1305
- */
1306
- Forehead: Array<Point>;
1177
+ /**
1178
+ * 人脸框左上角横坐标。
1179
+ */
1180
+ X: number
1181
+
1182
+ /**
1183
+ * 人脸框左上角纵坐标。
1184
+ */
1185
+ Y: number
1186
+
1187
+ /**
1188
+ * 人脸框宽度。
1189
+ */
1190
+ Width: number
1191
+
1192
+ /**
1193
+ * 人脸框高度。
1194
+ */
1195
+ Height: number
1196
+
1197
+ /**
1198
+ * 描述左侧眼睛轮廓的 XX 点。
1199
+ */
1200
+ LeftEye: Array<Point>
1201
+
1202
+ /**
1203
+ * 描述右侧眼睛轮廓的 XX 点。
1204
+ */
1205
+ RightEye: Array<Point>
1206
+
1207
+ /**
1208
+ * 描述左侧眉毛轮廓的 XX 点。
1209
+ */
1210
+ LeftEyeBrow: Array<Point>
1211
+
1212
+ /**
1213
+ * 描述右侧眉毛轮廓的 XX 点。
1214
+ */
1215
+ RightEyeBrow: Array<Point>
1216
+
1217
+ /**
1218
+ * 描述外嘴巴轮廓的 XX 点, 从左侧开始逆时针返回。
1219
+ */
1220
+ MouthOutside: Array<Point>
1221
+
1222
+ /**
1223
+ * 描述内嘴巴轮廓的 XX 点,从左侧开始逆时针返回。
1224
+ */
1225
+ MouthInside: Array<Point>
1226
+
1227
+ /**
1228
+ * 描述鼻子轮廓的 XX 点。
1229
+ */
1230
+ Nose: Array<Point>
1231
+
1232
+ /**
1233
+ * 左瞳孔轮廓的 XX 个点。
1234
+ */
1235
+ LeftPupil: Array<Point>
1236
+
1237
+ /**
1238
+ * 右瞳孔轮廓的 XX 个点。
1239
+ */
1240
+ RightPupil: Array<Point>
1241
+
1242
+ /**
1243
+ * 中轴线轮廓的 XX 个点。
1244
+ */
1245
+ CentralAxis: Array<Point>
1246
+
1247
+ /**
1248
+ * 下巴轮廓的 XX 个点。
1249
+ */
1250
+ Chin: Array<Point>
1251
+
1252
+ /**
1253
+ * 左眼袋的 XX 个点。
1254
+ */
1255
+ LeftEyeBags: Array<Point>
1256
+
1257
+ /**
1258
+ * 右眼袋的 XX 个点。
1259
+ */
1260
+ RightEyeBags: Array<Point>
1261
+
1262
+ /**
1263
+ * 额头的 XX 个点。
1264
+ */
1265
+ Forehead: Array<Point>
1307
1266
  }
1308
1267
 
1309
1268
  /**
@@ -1311,95 +1270,90 @@ export interface DenseFaceShape {
1311
1270
 
1312
1271
  */
1313
1272
  export interface ResultsReturnsByGroup {
1273
+ /**
1274
+ * 检测出的人脸框位置。
1275
+ */
1276
+ FaceRect: FaceRect
1314
1277
 
1315
- /**
1316
- * 检测出的人脸框位置。
1317
- */
1318
- FaceRect: FaceRect;
1319
-
1320
- /**
1321
- * 识别结果。
1322
- */
1323
- GroupCandidates: Array<GroupCandidate>;
1324
-
1325
- /**
1278
+ /**
1279
+ * 识别结果。
1280
+ */
1281
+ GroupCandidates: Array<GroupCandidate>
1282
+
1283
+ /**
1326
1284
  * 检测出的人脸图片状态返回码。0 表示正常。
1327
1285
  -1601代表不符合图片质量控制要求,此时Candidate内容为空。
1328
1286
  */
1329
- RetCode: number;
1287
+ RetCode: number
1330
1288
  }
1331
1289
 
1332
1290
  /**
1333
1291
  * 坐标
1334
1292
  */
1335
1293
  export interface Point {
1294
+ /**
1295
+ * x坐标
1296
+ */
1297
+ X: number
1336
1298
 
1337
- /**
1338
- * x坐标
1339
- */
1340
- X: number;
1341
-
1342
- /**
1343
- * Y坐标
1344
- */
1345
- Y: number;
1299
+ /**
1300
+ * Y坐标
1301
+ */
1302
+ Y: number
1346
1303
  }
1347
1304
 
1348
1305
  /**
1349
1306
  * GetPersonListNum返回参数结构体
1350
1307
  */
1351
1308
  export interface GetPersonListNumResponse {
1309
+ /**
1310
+ * 人员数量
1311
+ */
1312
+ PersonNum?: number
1352
1313
 
1353
- /**
1354
- * 人员数量
1355
- */
1356
- PersonNum?: number;
1357
-
1358
- /**
1359
- * 人脸数量
1360
- */
1361
- FaceNum?: number;
1362
-
1363
- /**
1364
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1365
- */
1366
- RequestId?: string;
1314
+ /**
1315
+ * 人脸数量
1316
+ */
1317
+ FaceNum?: number
1318
+
1319
+ /**
1320
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1321
+ */
1322
+ RequestId?: string
1367
1323
  }
1368
1324
 
1369
1325
  /**
1370
1326
  * DeletePersonFromGroup请求参数结构体
1371
1327
  */
1372
1328
  export interface DeletePersonFromGroupRequest {
1329
+ /**
1330
+ * 人员ID
1331
+ */
1332
+ PersonId: string
1373
1333
 
1374
- /**
1375
- * 人员ID
1376
- */
1377
- PersonId: string;
1378
-
1379
- /**
1380
- * 人员库ID
1381
- */
1382
- GroupId: string;
1334
+ /**
1335
+ * 人员库ID
1336
+ */
1337
+ GroupId: string
1383
1338
  }
1384
1339
 
1385
1340
  /**
1386
1341
  * VerifyFace请求参数结构体
1387
1342
  */
1388
1343
  export interface VerifyFaceRequest {
1344
+ /**
1345
+ * 待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。
1346
+ */
1347
+ PersonId: string
1389
1348
 
1390
- /**
1391
- * 待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。
1392
- */
1393
- PersonId: string;
1394
-
1395
- /**
1349
+ /**
1396
1350
  * 图片 base64 数据,base64 编码后大小不可超过5M。
1397
1351
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1398
1352
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1399
1353
  */
1400
- Image?: string;
1401
-
1402
- /**
1354
+ Image?: string
1355
+
1356
+ /**
1403
1357
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
1404
1358
  Url、Image必须提供一个,如果都提供,只使用 Url。
1405
1359
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
@@ -1407,9 +1361,9 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
1407
1361
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1408
1362
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1409
1363
  */
1410
- Url?: string;
1411
-
1412
- /**
1364
+ Url?: string
1365
+
1366
+ /**
1413
1367
  * 图片质量控制。
1414
1368
  0: 不进行控制;
1415
1369
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -1419,187 +1373,181 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
1419
1373
  默认 0。
1420
1374
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1421
1375
  */
1422
- QualityControl?: number;
1423
-
1424
- /**
1425
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1426
- */
1427
- NeedRotateDetection?: number;
1376
+ QualityControl?: number
1377
+
1378
+ /**
1379
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1380
+ */
1381
+ NeedRotateDetection?: number
1428
1382
  }
1429
1383
 
1430
1384
  /**
1431
1385
  * GetPersonList返回参数结构体
1432
1386
  */
1433
1387
  export interface GetPersonListResponse {
1388
+ /**
1389
+ * 返回的人员信息
1390
+ */
1391
+ PersonInfos?: Array<PersonInfo>
1434
1392
 
1435
- /**
1436
- * 返回的人员信息
1437
- */
1438
- PersonInfos?: Array<PersonInfo>;
1439
-
1440
- /**
1393
+ /**
1441
1394
  * 该人员库的人员数量
1442
1395
  注意:此字段可能返回 null,表示取不到有效值。
1443
1396
  */
1444
- PersonNum?: number;
1445
-
1446
- /**
1397
+ PersonNum?: number
1398
+
1399
+ /**
1447
1400
  * 该人员库的人脸数量
1448
1401
  注意:此字段可能返回 null,表示取不到有效值。
1449
1402
  */
1450
- FaceNum?: number;
1451
-
1452
- /**
1403
+ FaceNum?: number
1404
+
1405
+ /**
1453
1406
  * 人脸识别所用的算法模型版本。
1454
1407
  注意:此字段可能返回 null,表示取不到有效值。
1455
1408
  */
1456
- FaceModelVersion?: string;
1457
-
1458
- /**
1459
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1460
- */
1461
- RequestId?: string;
1409
+ FaceModelVersion?: string
1410
+
1411
+ /**
1412
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1413
+ */
1414
+ RequestId?: string
1462
1415
  }
1463
1416
 
1464
1417
  /**
1465
1418
  * 头发信息
1466
1419
  */
1467
1420
  export interface Hair {
1468
-
1469
- /**
1421
+ /**
1470
1422
  * 头发长度信息。
1471
1423
  AttributeItem对应的Type为 —— 0:光头,1:短发,2:中发,3:长发,4:绑发。
1472
1424
  */
1473
- Length: AttributeItem;
1474
-
1475
- /**
1425
+ Length: AttributeItem
1426
+
1427
+ /**
1476
1428
  * 刘海信息。
1477
1429
  AttributeItem对应的Type为 —— 0:无刘海,1:有刘海。
1478
1430
  */
1479
- Bang: AttributeItem;
1480
-
1481
- /**
1431
+ Bang: AttributeItem
1432
+
1433
+ /**
1482
1434
  * 头发颜色信息。
1483
1435
  AttributeItem对应的Type为 —— 0:黑色,1:金色,2:棕色,3:灰白色。
1484
1436
  */
1485
- Color: AttributeItem;
1437
+ Color: AttributeItem
1486
1438
  }
1487
1439
 
1488
1440
  /**
1489
1441
  * 人脸的识别结果
1490
1442
  */
1491
1443
  export interface Result {
1444
+ /**
1445
+ * 识别出的最相似候选人
1446
+ */
1447
+ Candidates: Array<Candidate>
1492
1448
 
1493
- /**
1494
- * 识别出的最相似候选人
1495
- */
1496
- Candidates: Array<Candidate>;
1497
-
1498
- /**
1499
- * 检测出的人脸框位置
1500
- */
1501
- FaceRect: FaceRect;
1502
-
1503
- /**
1449
+ /**
1450
+ * 检测出的人脸框位置
1451
+ */
1452
+ FaceRect: FaceRect
1453
+
1454
+ /**
1504
1455
  * 检测出的人脸图片状态返回码。0 表示正常。
1505
1456
  -1601代表不符合图片质量控制要求,此时Candidate内容为空。
1506
1457
  */
1507
- RetCode: number;
1458
+ RetCode: number
1508
1459
  }
1509
1460
 
1510
1461
  /**
1511
1462
  * GetPersonGroupInfo返回参数结构体
1512
1463
  */
1513
1464
  export interface GetPersonGroupInfoResponse {
1465
+ /**
1466
+ * 包含此人员的人员库及描述字段内容列表
1467
+ */
1468
+ PersonGroupInfos?: Array<PersonGroupInfo>
1514
1469
 
1515
- /**
1516
- * 包含此人员的人员库及描述字段内容列表
1517
- */
1518
- PersonGroupInfos?: Array<PersonGroupInfo>;
1519
-
1520
- /**
1470
+ /**
1521
1471
  * 人员库总数量
1522
1472
  注意:此字段可能返回 null,表示取不到有效值。
1523
1473
  */
1524
- GroupNum?: number;
1525
-
1526
- /**
1474
+ GroupNum?: number
1475
+
1476
+ /**
1527
1477
  * 人脸识别服务所用的算法模型版本。
1528
1478
  注意:此字段可能返回 null,表示取不到有效值。
1529
1479
  */
1530
- FaceModelVersion?: string;
1531
-
1532
- /**
1533
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1534
- */
1535
- RequestId?: string;
1480
+ FaceModelVersion?: string
1481
+
1482
+ /**
1483
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1484
+ */
1485
+ RequestId?: string
1536
1486
  }
1537
1487
 
1538
1488
  /**
1539
1489
  * UpgradeGroupFaceModelVersion返回参数结构体
1540
1490
  */
1541
1491
  export interface UpgradeGroupFaceModelVersionResponse {
1492
+ /**
1493
+ * 升级任务ID,用于查询、获取升级的进度和结果。
1494
+ */
1495
+ JobId: string
1542
1496
 
1543
- /**
1544
- * 升级任务ID,用于查询、获取升级的进度和结果。
1545
- */
1546
- JobId: string;
1547
-
1548
- /**
1549
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1550
- */
1551
- RequestId?: string;
1497
+ /**
1498
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1499
+ */
1500
+ RequestId?: string
1552
1501
  }
1553
1502
 
1554
1503
  /**
1555
1504
  * SearchFacesReturnsByGroup请求参数结构体
1556
1505
  */
1557
1506
  export interface SearchFacesReturnsByGroupRequest {
1507
+ /**
1508
+ * 希望搜索的人员库列表,上限60个。
1509
+ */
1510
+ GroupIds: Array<string>
1558
1511
 
1559
- /**
1560
- * 希望搜索的人员库列表,上限60个。
1561
- */
1562
- GroupIds: Array<string>;
1563
-
1564
- /**
1512
+ /**
1565
1513
  * 图片 base64 数据,base64 编码后大小不可超过5M。
1566
1514
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1567
1515
  */
1568
- Image?: string;
1569
-
1570
- /**
1516
+ Image?: string
1517
+
1518
+ /**
1571
1519
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
1572
1520
  Url、Image必须提供一个,如果都提供,只使用 Url。
1573
1521
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1574
1522
  非腾讯云存储的Url速度和稳定性可能受一定影响。
1575
1523
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1576
1524
  */
1577
- Url?: string;
1578
-
1579
- /**
1525
+ Url?: string
1526
+
1527
+ /**
1580
1528
  * 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1581
1529
  MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1582
1530
  例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1583
1531
  */
1584
- MaxFaceNum?: number;
1585
-
1586
- /**
1587
- * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
1588
- */
1589
- MinFaceSize?: number;
1590
-
1591
- /**
1532
+ MaxFaceNum?: number
1533
+
1534
+ /**
1535
+ * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
1536
+ */
1537
+ MinFaceSize?: number
1538
+
1539
+ /**
1592
1540
  * 被检测到的人脸,对应最多返回的最相似人员数目。默认值为5,最大值为10。
1593
1541
  例,设MaxFaceNum为3,MaxPersonNumPerGroup为5,GroupIds长度为3,则最多可能返回3*5*3=45个人员。
1594
1542
  */
1595
- MaxPersonNumPerGroup?: number;
1596
-
1597
- /**
1598
- * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1599
- */
1600
- NeedPersonInfo?: number;
1601
-
1602
- /**
1543
+ MaxPersonNumPerGroup?: number
1544
+
1545
+ /**
1546
+ * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1547
+ */
1548
+ NeedPersonInfo?: number
1549
+
1550
+ /**
1603
1551
  * 图片质量控制。
1604
1552
  0: 不进行控制;
1605
1553
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -1609,141 +1557,136 @@ MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要
1609
1557
  默认 0。
1610
1558
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1611
1559
  */
1612
- QualityControl?: number;
1613
-
1614
- /**
1560
+ QualityControl?: number
1561
+
1562
+ /**
1615
1563
  * 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。
1616
1564
  默认为0。
1617
1565
  取值范围[0.0,100.0) 。
1618
1566
  */
1619
- FaceMatchThreshold?: number;
1620
-
1621
- /**
1622
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1623
- */
1624
- NeedRotateDetection?: number;
1567
+ FaceMatchThreshold?: number
1568
+
1569
+ /**
1570
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1571
+ */
1572
+ NeedRotateDetection?: number
1625
1573
  }
1626
1574
 
1627
1575
  /**
1628
1576
  * AnalyzeDenseLandmarks返回参数结构体
1629
1577
  */
1630
1578
  export interface AnalyzeDenseLandmarksResponse {
1579
+ /**
1580
+ * 请求的图片宽度。
1581
+ */
1582
+ ImageWidth?: number
1631
1583
 
1632
- /**
1633
- * 请求的图片宽度。
1634
- */
1635
- ImageWidth?: number;
1636
-
1637
- /**
1638
- * 请求的图片高度。
1639
- */
1640
- ImageHeight?: number;
1641
-
1642
- /**
1643
- * 稠密人脸关键点具体信息。
1644
- */
1645
- DenseFaceShapeSet?: Array<DenseFaceShape>;
1646
-
1647
- /**
1648
- * 人脸识别服务所用的算法模型版本。本接口仅支持 “3.0“ 输入。
1649
- */
1650
- FaceModelVersion?: string;
1651
-
1652
- /**
1653
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1654
- */
1655
- RequestId?: string;
1584
+ /**
1585
+ * 请求的图片高度。
1586
+ */
1587
+ ImageHeight?: number
1588
+
1589
+ /**
1590
+ * 稠密人脸关键点具体信息。
1591
+ */
1592
+ DenseFaceShapeSet?: Array<DenseFaceShape>
1593
+
1594
+ /**
1595
+ * 人脸识别服务所用的算法模型版本。本接口仅支持 “3.0“ 输入。
1596
+ */
1597
+ FaceModelVersion?: string
1598
+
1599
+ /**
1600
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1601
+ */
1602
+ RequestId?: string
1656
1603
  }
1657
1604
 
1658
1605
  /**
1659
1606
  * ModifyPersonBaseInfo返回参数结构体
1660
1607
  */
1661
1608
  export interface ModifyPersonBaseInfoResponse {
1662
-
1663
- /**
1664
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1665
- */
1666
- RequestId?: string;
1609
+ /**
1610
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1611
+ */
1612
+ RequestId?: string
1667
1613
  }
1668
1614
 
1669
1615
  /**
1670
1616
  * ModifyPersonGroupInfo请求参数结构体
1671
1617
  */
1672
1618
  export interface ModifyPersonGroupInfoRequest {
1619
+ /**
1620
+ * 人员库ID
1621
+ */
1622
+ GroupId: string
1673
1623
 
1674
- /**
1675
- * 人员库ID
1676
- */
1677
- GroupId: string;
1678
-
1679
- /**
1680
- * 人员ID
1681
- */
1682
- PersonId: string;
1683
-
1684
- /**
1685
- * 需要修改的人员描述字段内容,key-value
1686
- */
1687
- PersonExDescriptionInfos: Array<PersonExDescriptionInfo>;
1624
+ /**
1625
+ * 人员ID
1626
+ */
1627
+ PersonId: string
1628
+
1629
+ /**
1630
+ * 需要修改的人员描述字段内容,key-value
1631
+ */
1632
+ PersonExDescriptionInfos: Array<PersonExDescriptionInfo>
1688
1633
  }
1689
1634
 
1690
1635
  /**
1691
1636
  * RevertGroupFaceModelVersion请求参数结构体
1692
1637
  */
1693
1638
  export interface RevertGroupFaceModelVersionRequest {
1694
-
1695
- /**
1696
- * 需要回滚的升级任务ID。
1697
- */
1698
- JobId: string;
1639
+ /**
1640
+ * 需要回滚的升级任务ID。
1641
+ */
1642
+ JobId: string
1699
1643
  }
1700
1644
 
1701
1645
  /**
1702
1646
  * 五官遮挡分,评价眉毛(Eyebrow)、眼睛(Eye)、鼻子(Nose)、脸颊(Cheek)、嘴巴(Mouth)、下巴(Chin)的被遮挡程度。
1703
1647
  */
1704
1648
  export interface FaceQualityCompleteness {
1705
-
1706
- /**
1649
+ /**
1707
1650
  * 眉毛的遮挡分数[0,100],分数越高遮挡越少。
1708
1651
  参考范围:[0,80]表示发生遮挡。
1709
1652
  注意:此字段可能返回 null,表示取不到有效值。
1710
1653
  */
1711
- Eyebrow: number;
1712
-
1713
- /**
1654
+ Eyebrow: number
1655
+
1656
+ /**
1714
1657
  * 眼睛的遮挡分数[0,100],分数越高遮挡越少。
1715
1658
  参考范围:[0,80]表示发生遮挡。
1716
1659
  注意:此字段可能返回 null,表示取不到有效值。
1717
1660
  */
1718
- Eye: number;
1719
-
1720
- /**
1661
+ Eye: number
1662
+
1663
+ /**
1721
1664
  * 鼻子的遮挡分数[0,100],分数越高遮挡越少。
1722
1665
  参考范围:[0,60]表示发生遮挡。
1723
1666
  注意:此字段可能返回 null,表示取不到有效值。
1724
1667
  */
1725
- Nose: number;
1726
-
1727
- /**
1668
+ Nose: number
1669
+
1670
+ /**
1728
1671
  * 脸颊的遮挡分数[0,100],分数越高遮挡越少。
1729
1672
  参考范围:[0,70]表示发生遮挡。
1730
1673
  注意:此字段可能返回 null,表示取不到有效值。
1731
1674
  */
1732
- Cheek: number;
1733
-
1734
- /**
1675
+ Cheek: number
1676
+
1677
+ /**
1735
1678
  * 嘴巴的遮挡分数[0,100],分数越高遮挡越少。
1736
1679
  参考范围:[0,50]表示发生遮挡。
1737
1680
  注意:此字段可能返回 null,表示取不到有效值。
1738
1681
  */
1739
- Mouth: number;
1740
-
1741
- /**
1682
+ Mouth: number
1683
+
1684
+ /**
1742
1685
  * 下巴的遮挡分数[0,100],分数越高遮挡越少。
1743
1686
  参考范围:[0,70]表示发生遮挡。
1744
1687
  注意:此字段可能返回 null,表示取不到有效值。
1745
1688
  */
1746
- Chin: number;
1689
+ Chin: number
1747
1690
  }
1748
1691
 
1749
1692
  /**
@@ -1751,102 +1694,100 @@ export interface FaceQualityCompleteness {
1751
1694
  魅力( beauty )、眼镜( glass )、口罩(mask)、头发(hair)和姿态 (pitch,roll,yaw )。只有当 NeedFaceAttributes 设为 1 时才返回有效信息,最多返回面积最大的 5 张人脸属性信息,超过 5 张人脸(第 6 张及以后的人脸)的 FaceAttributesInfo 不具备参考意义。
1752
1695
  */
1753
1696
  export interface FaceAttributesInfo {
1754
-
1755
- /**
1756
- * 性别[0~49]为女性,[50,100]为男性,越接近0和100表示置信度越高。NeedFaceAttributes 不为 1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1757
- */
1758
- Gender: number;
1759
-
1760
- /**
1761
- * 年龄 [0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1762
- */
1763
- Age: number;
1764
-
1765
- /**
1766
- * 微笑[0(normal,正常)~50(smile,微笑)~100(laugh,大笑)]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1767
- */
1768
- Expression: number;
1769
-
1770
- /**
1771
- * 是否有眼镜 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1772
- */
1773
- Glass: boolean;
1774
-
1775
- /**
1697
+ /**
1698
+ * 性别[0~49]为女性,[50,100]为男性,越接近0和100表示置信度越高。NeedFaceAttributes 不为 1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1699
+ */
1700
+ Gender: number
1701
+
1702
+ /**
1703
+ * 年龄 [0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1704
+ */
1705
+ Age: number
1706
+
1707
+ /**
1708
+ * 微笑[0(normal,正常)~50(smile,微笑)~100(laugh,大笑)]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1709
+ */
1710
+ Expression: number
1711
+
1712
+ /**
1713
+ * 是否有眼镜 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1714
+ */
1715
+ Glass: boolean
1716
+
1717
+ /**
1776
1718
  * 上下偏移[-30,30],单位角度。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1777
1719
  建议:人脸入库选择[-10,10]的图片。
1778
1720
  */
1779
- Pitch: number;
1780
-
1781
- /**
1721
+ Pitch: number
1722
+
1723
+ /**
1782
1724
  * 左右偏移[-30,30],单位角度。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1783
1725
  建议:人脸入库选择[-10,10]的图片。
1784
1726
  */
1785
- Yaw: number;
1786
-
1787
- /**
1727
+ Yaw: number
1728
+
1729
+ /**
1788
1730
  * 平面旋转[-180,180],单位角度。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1789
1731
  建议:人脸入库选择[-20,20]的图片。
1790
1732
  */
1791
- Roll: number;
1792
-
1793
- /**
1794
- * 魅力[0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1795
- */
1796
- Beauty: number;
1797
-
1798
- /**
1733
+ Roll: number
1734
+
1735
+ /**
1736
+ * 魅力[0~100]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1737
+ */
1738
+ Beauty: number
1739
+
1740
+ /**
1799
1741
  * 是否有帽子 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1800
1742
  注意:此字段可能返回 null,表示取不到有效值。
1801
1743
  */
1802
- Hat: boolean;
1803
-
1804
- /**
1744
+ Hat: boolean
1745
+
1746
+ /**
1805
1747
  * 是否有口罩 [true,false]。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1806
1748
  注意:此字段可能返回 null,表示取不到有效值。
1807
1749
  */
1808
- Mask: boolean;
1809
-
1810
- /**
1750
+ Mask: boolean
1751
+
1752
+ /**
1811
1753
  * 头发信息,包含头发长度(length)、有无刘海(bang)、头发颜色(color)。NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1812
1754
  注意:此字段可能返回 null,表示取不到有效值。
1813
1755
  */
1814
- Hair: FaceHairAttributesInfo;
1815
-
1816
- /**
1756
+ Hair: FaceHairAttributesInfo
1757
+
1758
+ /**
1817
1759
  * 双眼是否睁开 [true,false]。只要有超过一只眼睛闭眼,就返回false。 NeedFaceAttributes 不为1 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
1818
1760
  注意:此字段可能返回 null,表示取不到有效值。
1819
1761
  */
1820
- EyeOpen: boolean;
1762
+ EyeOpen: boolean
1821
1763
  }
1822
1764
 
1823
1765
  /**
1824
1766
  * VerifyPerson请求参数结构体
1825
1767
  */
1826
1768
  export interface VerifyPersonRequest {
1769
+ /**
1770
+ * 待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。
1771
+ */
1772
+ PersonId: string
1827
1773
 
1828
- /**
1829
- * 待验证的人员ID。人员ID具体信息请参考人员库管理相关接口。
1830
- */
1831
- PersonId: string;
1832
-
1833
- /**
1774
+ /**
1834
1775
  * 图片 base64 数据。
1835
1776
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1836
1777
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1837
1778
  */
1838
- Image?: string;
1839
-
1840
- /**
1779
+ Image?: string
1780
+
1781
+ /**
1841
1782
  * 图片的 Url 。 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
1842
1783
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1843
1784
  非腾讯云存储的Url速度和稳定性可能受一定影响。
1844
1785
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
1845
1786
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1846
1787
  */
1847
- Url?: string;
1848
-
1849
- /**
1788
+ Url?: string
1789
+
1790
+ /**
1850
1791
  * 图片质量控制。
1851
1792
  0: 不进行控制;
1852
1793
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -1856,135 +1797,131 @@ export interface VerifyPersonRequest {
1856
1797
  默认 0。
1857
1798
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1858
1799
  */
1859
- QualityControl?: number;
1860
-
1861
- /**
1862
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1863
- */
1864
- NeedRotateDetection?: number;
1800
+ QualityControl?: number
1801
+
1802
+ /**
1803
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1804
+ */
1805
+ NeedRotateDetection?: number
1865
1806
  }
1866
1807
 
1867
1808
  /**
1868
1809
  * ModifyPersonBaseInfo请求参数结构体
1869
1810
  */
1870
1811
  export interface ModifyPersonBaseInfoRequest {
1812
+ /**
1813
+ * 人员ID
1814
+ */
1815
+ PersonId: string
1871
1816
 
1872
- /**
1873
- * 人员ID
1874
- */
1875
- PersonId: string;
1876
-
1877
- /**
1878
- * 需要修改的人员名称
1879
- */
1880
- PersonName?: string;
1881
-
1882
- /**
1883
- * 需要修改的人员性别
1884
- */
1885
- Gender?: number;
1817
+ /**
1818
+ * 需要修改的人员名称
1819
+ */
1820
+ PersonName?: string
1821
+
1822
+ /**
1823
+ * 需要修改的人员性别
1824
+ */
1825
+ Gender?: number
1886
1826
  }
1887
1827
 
1888
1828
  /**
1889
1829
  * VerifyFace返回参数结构体
1890
1830
  */
1891
1831
  export interface VerifyFaceResponse {
1892
-
1893
- /**
1832
+ /**
1894
1833
  * 给定的人脸图片与 PersonId 对应人脸的相似度。若 PersonId 下有多张人脸(Face),返回相似度最大的分数。
1895
1834
 
1896
1835
  不同算法版本返回的相似度分数不同。
1897
1836
  若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
1898
1837
  2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
1899
1838
  */
1900
- Score: number;
1901
-
1902
- /**
1903
- * 是否为同一人的判断。
1904
- */
1905
- IsMatch: boolean;
1906
-
1907
- /**
1908
- * 人脸识别所用的算法模型版本。
1909
- */
1910
- FaceModelVersion: string;
1911
-
1912
- /**
1913
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1914
- */
1915
- RequestId?: string;
1839
+ Score: number
1840
+
1841
+ /**
1842
+ * 是否为同一人的判断。
1843
+ */
1844
+ IsMatch: boolean
1845
+
1846
+ /**
1847
+ * 人脸识别所用的算法模型版本。
1848
+ */
1849
+ FaceModelVersion: string
1850
+
1851
+ /**
1852
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1853
+ */
1854
+ RequestId?: string
1916
1855
  }
1917
1856
 
1918
1857
  /**
1919
1858
  * 人脸信息列表。
1920
1859
  */
1921
1860
  export interface FaceDetailInfo {
1861
+ /**
1862
+ * 检测出的人脸框位置。
1863
+ */
1864
+ FaceRect: FaceRect
1922
1865
 
1923
- /**
1924
- * 检测出的人脸框位置。
1925
- */
1926
- FaceRect: FaceRect;
1927
-
1928
- /**
1866
+ /**
1929
1867
  * 人脸属性信息,根据 FaceAttributesType 输入的类型,返回年龄(Age)、颜值(Beauty)
1930
1868
  情绪(Emotion)、眼睛信息(Eye)、眉毛(Eyebrow)、性别(Gender)
1931
1869
  头发(Hair)、帽子(Hat)、姿态(Headpose)、口罩(Mask)、嘴巴(Mouse)、胡子(Moustache)
1932
1870
  鼻子(Nose)、脸型(Shape)、肤色(Skin)、微笑(Smile)等人脸属性信息。
1933
1871
  若 FaceAttributesType 没有输入相关类型,则FaceDetaiAttributesInfo返回的细项不具备参考意义。
1934
1872
  */
1935
- FaceDetailAttributesInfo: FaceDetailAttributesInfo;
1873
+ FaceDetailAttributesInfo: FaceDetailAttributesInfo
1936
1874
  }
1937
1875
 
1938
1876
  /**
1939
1877
  * SearchFaces请求参数结构体
1940
1878
  */
1941
1879
  export interface SearchFacesRequest {
1880
+ /**
1881
+ * 希望搜索的人员库列表,上限100个。
1882
+ */
1883
+ GroupIds: Array<string>
1942
1884
 
1943
- /**
1944
- * 希望搜索的人员库列表,上限100个。
1945
- */
1946
- GroupIds: Array<string>;
1947
-
1948
- /**
1885
+ /**
1949
1886
  * 图片 base64 数据,base64 编码后大小不可超过5M。
1950
1887
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1951
1888
  */
1952
- Image?: string;
1953
-
1954
- /**
1889
+ Image?: string
1890
+
1891
+ /**
1955
1892
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
1956
1893
  Url、Image必须提供一个,如果都提供,只使用 Url。
1957
1894
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
1958
1895
  非腾讯云存储的Url速度和稳定性可能受一定影响。
1959
1896
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
1960
1897
  */
1961
- Url?: string;
1962
-
1963
- /**
1898
+ Url?: string
1899
+
1900
+ /**
1964
1901
  * 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
1965
1902
  MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
1966
1903
  例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
1967
1904
  */
1968
- MaxFaceNum?: number;
1969
-
1970
- /**
1971
- * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
1972
- */
1973
- MinFaceSize?: number;
1974
-
1975
- /**
1905
+ MaxFaceNum?: number
1906
+
1907
+ /**
1908
+ * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
1909
+ */
1910
+ MinFaceSize?: number
1911
+
1912
+ /**
1976
1913
  * 单张被识别的人脸返回的最相似人员数量。默认值为5,最大值为100。
1977
1914
  例,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
1978
1915
  值越大,需要处理的时间越长。建议不要超过10。
1979
1916
  */
1980
- MaxPersonNum?: number;
1981
-
1982
- /**
1983
- * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1984
- */
1985
- NeedPersonInfo?: number;
1986
-
1987
- /**
1917
+ MaxPersonNum?: number
1918
+
1919
+ /**
1920
+ * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
1921
+ */
1922
+ NeedPersonInfo?: number
1923
+
1924
+ /**
1988
1925
  * 图片质量控制。
1989
1926
  0: 不进行控制;
1990
1927
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -1994,65 +1931,64 @@ MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要
1994
1931
  默认 0。
1995
1932
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
1996
1933
  */
1997
- QualityControl?: number;
1998
-
1999
- /**
2000
- * 出参Score中,只有超过FaceMatchThreshold值的结果才会返回。默认为0。
2001
- */
2002
- FaceMatchThreshold?: number;
2003
-
2004
- /**
2005
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2006
- */
2007
- NeedRotateDetection?: number;
1934
+ QualityControl?: number
1935
+
1936
+ /**
1937
+ * 出参Score中,只有超过FaceMatchThreshold值的结果才会返回。默认为0。
1938
+ */
1939
+ FaceMatchThreshold?: number
1940
+
1941
+ /**
1942
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
1943
+ */
1944
+ NeedRotateDetection?: number
2008
1945
  }
2009
1946
 
2010
1947
  /**
2011
1948
  * SearchPersons请求参数结构体
2012
1949
  */
2013
1950
  export interface SearchPersonsRequest {
1951
+ /**
1952
+ * 希望搜索的人员库列表,上限100个。
1953
+ */
1954
+ GroupIds: Array<string>
2014
1955
 
2015
- /**
2016
- * 希望搜索的人员库列表,上限100个。
2017
- */
2018
- GroupIds: Array<string>;
2019
-
2020
- /**
1956
+ /**
2021
1957
  * 图片 base64 数据,base64 编码后大小不可超过5M。
2022
1958
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2023
1959
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2024
1960
  */
2025
- Image?: string;
2026
-
2027
- /**
1961
+ Image?: string
1962
+
1963
+ /**
2028
1964
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
2029
1965
  Url、Image必须提供一个,如果都提供,只使用 Url。
2030
1966
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2031
1967
  非腾讯云存储的Url速度和稳定性可能受一定影响。
2032
1968
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2033
1969
  */
2034
- Url?: string;
2035
-
2036
- /**
1970
+ Url?: string
1971
+
1972
+ /**
2037
1973
  * 最多识别的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为10。
2038
1974
  MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要搜索的人脸的数量。
2039
1975
  例:输入的Image或Url中的图片包含多张人脸,设MaxFaceNum=5,则会识别图片中面积最大的5张人脸。
2040
1976
  */
2041
- MaxFaceNum?: number;
2042
-
2043
- /**
2044
- * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
2045
- */
2046
- MinFaceSize?: number;
2047
-
2048
- /**
1977
+ MaxFaceNum?: number
1978
+
1979
+ /**
1980
+ * 人脸长和宽的最小尺寸,单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
1981
+ */
1982
+ MinFaceSize?: number
1983
+
1984
+ /**
2049
1985
  * 单张被识别的人脸返回的最相似人员数量。默认值为5,最大值为100。
2050
1986
  例,设MaxFaceNum为1,MaxPersonNum为8,则返回Top8相似的人员信息。
2051
1987
  值越大,需要处理的时间越长。建议不要超过10。
2052
1988
  */
2053
- MaxPersonNum?: number;
2054
-
2055
- /**
1989
+ MaxPersonNum?: number
1990
+
1991
+ /**
2056
1992
  * 图片质量控制。
2057
1993
  0: 不进行控制;
2058
1994
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -2062,294 +1998,283 @@ MaxFaceNum用于,当输入的待识别图片包含多张人脸时,设定要
2062
1998
  默认 0。
2063
1999
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
2064
2000
  */
2065
- QualityControl?: number;
2066
-
2067
- /**
2068
- * 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。默认为0。取值范围[0.0,100.0) 。
2069
- */
2070
- FaceMatchThreshold?: number;
2071
-
2072
- /**
2073
- * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
2074
- */
2075
- NeedPersonInfo?: number;
2076
-
2077
- /**
2078
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2079
- */
2080
- NeedRotateDetection?: number;
2001
+ QualityControl?: number
2002
+
2003
+ /**
2004
+ * 出参Score中,只有大于等于FaceMatchThreshold值的结果才会返回。默认为0。取值范围[0.0,100.0) 。
2005
+ */
2006
+ FaceMatchThreshold?: number
2007
+
2008
+ /**
2009
+ * 是否返回人员具体信息。0 为关闭,1 为开启。默认为 0。其他非0非1值默认为0
2010
+ */
2011
+ NeedPersonInfo?: number
2012
+
2013
+ /**
2014
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2015
+ */
2016
+ NeedRotateDetection?: number
2081
2017
  }
2082
2018
 
2083
2019
  /**
2084
2020
  * 返回的人员信息
2085
2021
  */
2086
2022
  export interface PersonInfo {
2087
-
2088
- /**
2089
- * 人员名称
2090
- */
2091
- PersonName: string;
2092
-
2093
- /**
2094
- * 人员Id
2095
- */
2096
- PersonId: string;
2097
-
2098
- /**
2099
- * 人员性别
2100
- */
2101
- Gender: number;
2102
-
2103
- /**
2104
- * 人员描述字段内容
2105
- */
2106
- PersonExDescriptions: Array<string>;
2107
-
2108
- /**
2109
- * 包含的人脸照片列表
2110
- */
2111
- FaceIds: Array<string>;
2112
-
2113
- /**
2023
+ /**
2024
+ * 人员名称
2025
+ */
2026
+ PersonName: string
2027
+
2028
+ /**
2029
+ * 人员Id
2030
+ */
2031
+ PersonId: string
2032
+
2033
+ /**
2034
+ * 人员性别
2035
+ */
2036
+ Gender: number
2037
+
2038
+ /**
2039
+ * 人员描述字段内容
2040
+ */
2041
+ PersonExDescriptions: Array<string>
2042
+
2043
+ /**
2044
+ * 包含的人脸照片列表
2045
+ */
2046
+ FaceIds: Array<string>
2047
+
2048
+ /**
2114
2049
  * 人员的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
2115
2050
  Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。有关更多信息,请参阅 Unix 时间。
2116
2051
  */
2117
- CreationTimestamp: number;
2052
+ CreationTimestamp: number
2118
2053
  }
2119
2054
 
2120
2055
  /**
2121
2056
  * 需要修改的人员库自定义描述字段key-value
2122
2057
  */
2123
2058
  export interface GroupExDescriptionInfo {
2124
-
2125
- /**
2059
+ /**
2126
2060
  * 人员库自定义描述字段Index,从0开始
2127
2061
  注意:此字段可能返回 null,表示取不到有效值。
2128
2062
  */
2129
- GroupExDescriptionIndex: number;
2130
-
2131
- /**
2132
- * 需要更新的人员库自定义描述字段内容
2133
- */
2134
- GroupExDescription: string;
2063
+ GroupExDescriptionIndex: number
2064
+
2065
+ /**
2066
+ * 需要更新的人员库自定义描述字段内容
2067
+ */
2068
+ GroupExDescription: string
2135
2069
  }
2136
2070
 
2137
2071
  /**
2138
2072
  * AnalyzeFace返回参数结构体
2139
2073
  */
2140
2074
  export interface AnalyzeFaceResponse {
2075
+ /**
2076
+ * 请求的图片宽度。
2077
+ */
2078
+ ImageWidth: number
2141
2079
 
2142
- /**
2143
- * 请求的图片宽度。
2144
- */
2145
- ImageWidth: number;
2146
-
2147
- /**
2148
- * 请求的图片高度。
2149
- */
2150
- ImageHeight: number;
2151
-
2152
- /**
2153
- * 五官定位(人脸关键点)具体信息。
2154
- */
2155
- FaceShapeSet: Array<FaceShape>;
2156
-
2157
- /**
2158
- * 人脸识别所用的算法模型版本。
2159
- */
2160
- FaceModelVersion: string;
2161
-
2162
- /**
2163
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2164
- */
2165
- RequestId?: string;
2080
+ /**
2081
+ * 请求的图片高度。
2082
+ */
2083
+ ImageHeight: number
2084
+
2085
+ /**
2086
+ * 五官定位(人脸关键点)具体信息。
2087
+ */
2088
+ FaceShapeSet: Array<FaceShape>
2089
+
2090
+ /**
2091
+ * 人脸识别所用的算法模型版本。
2092
+ */
2093
+ FaceModelVersion: string
2094
+
2095
+ /**
2096
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2097
+ */
2098
+ RequestId?: string
2166
2099
  }
2167
2100
 
2168
2101
  /**
2169
2102
  * DetectFace请求参数结构体
2170
2103
  */
2171
2104
  export interface DetectFaceRequest {
2172
-
2173
- /**
2105
+ /**
2174
2106
  * 最多处理的人脸数目。默认值为1(仅检测图片中面积最大的那张人脸),最大值为120。
2175
2107
  此参数用于控制处理待检测图片中的人脸个数,值越小,处理速度越快。
2176
2108
  */
2177
- MaxFaceNum?: number;
2178
-
2179
- /**
2109
+ MaxFaceNum?: number
2110
+
2111
+ /**
2180
2112
  * 人脸长和宽的最小尺寸,单位为像素。
2181
2113
  默认为34。建议不低于34。
2182
2114
  低于MinFaceSize值的人脸不会被检测。
2183
2115
  */
2184
- MinFaceSize?: number;
2185
-
2186
- /**
2116
+ MinFaceSize?: number
2117
+
2118
+ /**
2187
2119
  * 图片 base64 数据,base64 编码后大小不可超过5M。
2188
2120
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2189
2121
  */
2190
- Image?: string;
2191
-
2192
- /**
2122
+ Image?: string
2123
+
2124
+ /**
2193
2125
  * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
2194
2126
  Url、Image必须提供一个,如果都提供,只使用 Url。
2195
2127
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
2196
2128
  非腾讯云存储的Url速度和稳定性可能受一定影响。
2197
2129
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2198
2130
  */
2199
- Url?: string;
2200
-
2201
- /**
2131
+ Url?: string
2132
+
2133
+ /**
2202
2134
  * 是否需要返回人脸属性信息(FaceAttributesInfo)。0 为不需要返回,1 为需要返回。默认为 0。
2203
2135
  非 1 值均视为不需要返回,此时 FaceAttributesInfo 不具备参考意义。
2204
2136
  最多返回面积最大的 5 张人脸属性信息,超过 5 张人脸(第 6 张及以后的人脸)的 FaceAttributesInfo 不具备参考意义。
2205
2137
  提取人脸属性信息较为耗时,如不需要人脸属性信息,建议关闭此项功能,加快人脸检测速度。
2206
2138
  */
2207
- NeedFaceAttributes?: number;
2208
-
2209
- /**
2139
+ NeedFaceAttributes?: number
2140
+
2141
+ /**
2210
2142
  * 是否开启质量检测。0 为关闭,1 为开启。默认为 0。
2211
2143
  非 1 值均视为不进行质量检测。
2212
2144
  最多返回面积最大的 30 张人脸质量分信息,超过 30 张人脸(第 31 张及以后的人脸)的 FaceQualityInfo不具备参考意义。
2213
2145
  建议:人脸入库操作建议开启此功能。
2214
2146
  */
2215
- NeedQualityDetection?: number;
2216
-
2217
- /**
2147
+ NeedQualityDetection?: number
2148
+
2149
+ /**
2218
2150
  * 人脸识别服务所用的算法模型版本。目前入参支持 “2.0”和“3.0“ 两个输入。
2219
2151
  2020年4月2日开始,默认为“3.0”,之前使用过本接口的账号若未填写本参数默认为“2.0”。
2220
2152
  不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
2221
2153
  */
2222
- FaceModelVersion?: string;
2223
-
2224
- /**
2225
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2226
- */
2227
- NeedRotateDetection?: number;
2154
+ FaceModelVersion?: string
2155
+
2156
+ /**
2157
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2158
+ */
2159
+ NeedRotateDetection?: number
2228
2160
  }
2229
2161
 
2230
2162
  /**
2231
2163
  * GetPersonBaseInfo请求参数结构体
2232
2164
  */
2233
2165
  export interface GetPersonBaseInfoRequest {
2234
-
2235
- /**
2236
- * 人员ID
2237
- */
2238
- PersonId: string;
2166
+ /**
2167
+ * 人员ID
2168
+ */
2169
+ PersonId: string
2239
2170
  }
2240
2171
 
2241
2172
  /**
2242
2173
  * DeletePerson返回参数结构体
2243
2174
  */
2244
2175
  export interface DeletePersonResponse {
2245
-
2246
- /**
2247
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2248
- */
2249
- RequestId?: string;
2176
+ /**
2177
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2178
+ */
2179
+ RequestId?: string
2250
2180
  }
2251
2181
 
2252
2182
  /**
2253
2183
  * 需要修改的人员描述字段内容,key-value
2254
2184
  */
2255
2185
  export interface PersonExDescriptionInfo {
2256
-
2257
- /**
2186
+ /**
2258
2187
  * 人员描述字段Index,从0开始
2259
2188
  注意:此字段可能返回 null,表示取不到有效值。
2260
2189
  */
2261
- PersonExDescriptionIndex: number;
2262
-
2263
- /**
2264
- * 需要更新的人员描述字段内容
2265
- */
2266
- PersonExDescription: string;
2190
+ PersonExDescriptionIndex: number
2191
+
2192
+ /**
2193
+ * 需要更新的人员描述字段内容
2194
+ */
2195
+ PersonExDescription: string
2267
2196
  }
2268
2197
 
2269
2198
  /**
2270
2199
  * GetUpgradeGroupFaceModelVersionJobList返回参数结构体
2271
2200
  */
2272
2201
  export interface GetUpgradeGroupFaceModelVersionJobListResponse {
2202
+ /**
2203
+ * 人员库升级任务信息列表。
2204
+ */
2205
+ JobInfos?: Array<UpgradeJobInfo>
2273
2206
 
2274
- /**
2275
- * 人员库升级任务信息列表。
2276
- */
2277
- JobInfos?: Array<UpgradeJobInfo>;
2278
-
2279
- /**
2280
- * 升级任务总数量。
2281
- */
2282
- JobNum?: number;
2283
-
2284
- /**
2285
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2286
- */
2287
- RequestId?: string;
2207
+ /**
2208
+ * 升级任务总数量。
2209
+ */
2210
+ JobNum?: number
2211
+
2212
+ /**
2213
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2214
+ */
2215
+ RequestId?: string
2288
2216
  }
2289
2217
 
2290
2218
  /**
2291
2219
  * 姿态信息
2292
2220
  */
2293
2221
  export interface HeadPose {
2222
+ /**
2223
+ * 上下偏移[-30,30]。
2224
+ */
2225
+ Pitch: number
2294
2226
 
2295
- /**
2296
- * 上下偏移[-30,30]。
2297
- */
2298
- Pitch: number;
2299
-
2300
- /**
2301
- * 左右偏移[-30,30]。
2302
- */
2303
- Yaw: number;
2304
-
2305
- /**
2306
- * 平面旋转[-180,180]。
2307
- */
2308
- Roll: number;
2227
+ /**
2228
+ * 左右偏移[-30,30]。
2229
+ */
2230
+ Yaw: number
2231
+
2232
+ /**
2233
+ * 平面旋转[-180,180]。
2234
+ */
2235
+ Roll: number
2309
2236
  }
2310
2237
 
2311
2238
  /**
2312
2239
  * GetGroupList返回参数结构体
2313
2240
  */
2314
2241
  export interface GetGroupListResponse {
2242
+ /**
2243
+ * 返回的人员库信息
2244
+ */
2245
+ GroupInfos: Array<GroupInfo>
2315
2246
 
2316
- /**
2317
- * 返回的人员库信息
2318
- */
2319
- GroupInfos: Array<GroupInfo>;
2320
-
2321
- /**
2247
+ /**
2322
2248
  * 人员库总数量
2323
2249
  注意:此字段可能返回 null,表示取不到有效值。
2324
2250
  */
2325
- GroupNum: number;
2326
-
2327
- /**
2328
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2329
- */
2330
- RequestId?: string;
2251
+ GroupNum: number
2252
+
2253
+ /**
2254
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2255
+ */
2256
+ RequestId?: string
2331
2257
  }
2332
2258
 
2333
2259
  /**
2334
2260
  * DetectFaceAttributes请求参数结构体
2335
2261
  */
2336
2262
  export interface DetectFaceAttributesRequest {
2337
-
2338
- /**
2263
+ /**
2339
2264
  * 最多处理的人脸数目。
2340
2265
  默认值为1(仅检测图片中面积最大的那张人脸),最大值为120。
2341
2266
  此参数用于控制处理待检测图片中的人脸个数,值越小,处理速度越快。
2342
2267
  */
2343
- MaxFaceNum?: number;
2344
-
2345
- /**
2268
+ MaxFaceNum?: number
2269
+
2270
+ /**
2346
2271
  * 图片 base64 数据,base64 编码后大小不可超过5M。
2347
2272
  jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
2348
2273
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2349
2274
  */
2350
- Image?: string;
2351
-
2352
- /**
2275
+ Image?: string
2276
+
2277
+ /**
2353
2278
  * 图片的 Url 。
2354
2279
  对应图片 base64 编码后大小不可超过5M。
2355
2280
  jpg格式长边像素不可超过4000,其他格式图片长边像素不可超2000。
@@ -2358,9 +2283,9 @@ Url、Image必须提供一个,如果都提供,只使用 Url。
2358
2283
  非腾讯云存储的Url速度和稳定性可能受一定影响。
2359
2284
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2360
2285
  */
2361
- Url?: string;
2362
-
2363
- /**
2286
+ Url?: string
2287
+
2288
+ /**
2364
2289
  * 是否返回年龄、性别、情绪等属性。
2365
2290
  合法值为(大小写不敏感):None、Age、Beauty、Emotion、Eye、Eyebrow、
2366
2291
  Gender、Hair、Hat、Headpose、Mask、Mouth、Moustache、Nose、Shape、Skin、Smile。
@@ -2369,190 +2294,183 @@ None为不需要返回。默认为 None。
2369
2294
  关于各属性的详细描述,参见下文出参。
2370
2295
  最多返回面积最大的 5 张人脸属性信息,超过 5 张人脸(第 6 张及以后的人脸)的 AttributesInfo 不具备参考意义。
2371
2296
  */
2372
- FaceAttributesType?: string;
2373
-
2374
- /**
2375
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2376
- */
2377
- NeedRotateDetection?: number;
2378
-
2379
- /**
2380
- * 人脸识别服务所用的算法模型版本。本接口仅支持“3.0”输入
2381
- */
2382
- FaceModelVersion?: string;
2297
+ FaceAttributesType?: string
2298
+
2299
+ /**
2300
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2301
+ */
2302
+ NeedRotateDetection?: number
2303
+
2304
+ /**
2305
+ * 人脸识别服务所用的算法模型版本。本接口仅支持“3.0”输入
2306
+ */
2307
+ FaceModelVersion?: string
2383
2308
  }
2384
2309
 
2385
2310
  /**
2386
2311
  * GetGroupInfo返回参数结构体
2387
2312
  */
2388
2313
  export interface GetGroupInfoResponse {
2314
+ /**
2315
+ * 人员库名称
2316
+ */
2317
+ GroupName?: string
2389
2318
 
2390
- /**
2391
- * 人员库名称
2392
- */
2393
- GroupName?: string;
2394
-
2395
- /**
2396
- * 人员库ID
2397
- */
2398
- GroupId?: string;
2399
-
2400
- /**
2401
- * 人员库自定义描述字段
2402
- */
2403
- GroupExDescriptions?: Array<string>;
2404
-
2405
- /**
2406
- * 人员库信息备注
2407
- */
2408
- Tag?: string;
2409
-
2410
- /**
2411
- * 人脸识别所用的算法模型版本。
2412
- */
2413
- FaceModelVersion?: string;
2414
-
2415
- /**
2416
- * Group的创建时间和日期 CreationTimestampCreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
2417
- */
2418
- CreationTimestamp?: number;
2419
-
2420
- /**
2421
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2422
- */
2423
- RequestId?: string;
2319
+ /**
2320
+ * 人员库ID
2321
+ */
2322
+ GroupId?: string
2323
+
2324
+ /**
2325
+ * 人员库自定义描述字段
2326
+ */
2327
+ GroupExDescriptions?: Array<string>
2328
+
2329
+ /**
2330
+ * 人员库信息备注
2331
+ */
2332
+ Tag?: string
2333
+
2334
+ /**
2335
+ * 人脸识别所用的算法模型版本。
2336
+ */
2337
+ FaceModelVersion?: string
2338
+
2339
+ /**
2340
+ * Group的创建时间和日期 CreationTimestamp。CreationTimestamp 的值是自 Unix 纪元时间到Group创建时间的毫秒数。
2341
+ */
2342
+ CreationTimestamp?: number
2343
+
2344
+ /**
2345
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
2346
+ */
2347
+ RequestId?: string
2424
2348
  }
2425
2349
 
2426
2350
  /**
2427
2351
  * CompareFace返回参数结构体
2428
2352
  */
2429
2353
  export interface CompareFaceResponse {
2430
-
2431
- /**
2354
+ /**
2432
2355
  * 两张图片中人脸的相似度分数。
2433
2356
  不同算法版本返回的相似度分数不同。
2434
2357
  若需要验证两张图片中人脸是否为同一人,3.0版本误识率千分之一对应分数为40分,误识率万分之一对应分数为50分,误识率十万分之一对应分数为60分。 一般超过50分则可认定为同一人。
2435
2358
  2.0版本误识率千分之一对应分数为70分,误识率万分之一对应分数为80分,误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
2436
2359
  若需要验证两张图片中的人脸是否为同一人,建议使用人脸验证接口。
2437
2360
  */
2438
- Score: number;
2439
-
2440
- /**
2441
- * 人脸识别所用的算法模型版本。
2442
- */
2443
- FaceModelVersion: string;
2444
-
2445
- /**
2446
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2447
- */
2448
- RequestId?: string;
2361
+ Score: number
2362
+
2363
+ /**
2364
+ * 人脸识别所用的算法模型版本。
2365
+ */
2366
+ FaceModelVersion: string
2367
+
2368
+ /**
2369
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2370
+ */
2371
+ RequestId?: string
2449
2372
  }
2450
2373
 
2451
2374
  /**
2452
2375
  * 嘴巴信息。
2453
2376
  */
2454
2377
  export interface Mouth {
2455
-
2456
- /**
2378
+ /**
2457
2379
  * 是否张嘴信息。
2458
2380
  AttributeItem对应的Type为 —— 0:不张嘴,1:张嘴。
2459
2381
  */
2460
- MouthOpen: AttributeItem;
2382
+ MouthOpen: AttributeItem
2461
2383
  }
2462
2384
 
2463
2385
  /**
2464
2386
  * RevertGroupFaceModelVersion返回参数结构体
2465
2387
  */
2466
2388
  export interface RevertGroupFaceModelVersionResponse {
2467
-
2468
- /**
2469
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2470
- */
2471
- RequestId?: string;
2389
+ /**
2390
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2391
+ */
2392
+ RequestId?: string
2472
2393
  }
2473
2394
 
2474
2395
  /**
2475
2396
  * DeleteGroup返回参数结构体
2476
2397
  */
2477
2398
  export interface DeleteGroupResponse {
2478
-
2479
- /**
2480
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2481
- */
2482
- RequestId?: string;
2399
+ /**
2400
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2401
+ */
2402
+ RequestId?: string
2483
2403
  }
2484
2404
 
2485
2405
  /**
2486
2406
  * 五官定位(人脸关键点)具体信息。
2487
2407
  */
2488
2408
  export interface FaceShape {
2409
+ /**
2410
+ * 描述脸型轮廓的 21 点。
2411
+ */
2412
+ FaceProfile: Array<Point>
2489
2413
 
2490
- /**
2491
- * 描述脸型轮廓的 21 点。
2492
- */
2493
- FaceProfile: Array<Point>;
2494
-
2495
- /**
2496
- * 描述左侧眼睛轮廓的 8 点。
2497
- */
2498
- LeftEye: Array<Point>;
2499
-
2500
- /**
2501
- * 描述右侧眼睛轮廓的 8 点。
2502
- */
2503
- RightEye: Array<Point>;
2504
-
2505
- /**
2506
- * 描述左侧眉毛轮廓的 8 点。
2507
- */
2508
- LeftEyeBrow: Array<Point>;
2509
-
2510
- /**
2511
- * 描述右侧眉毛轮廓的 8 点。
2512
- */
2513
- RightEyeBrow: Array<Point>;
2514
-
2515
- /**
2516
- * 描述嘴巴轮廓的 22 点。
2517
- */
2518
- Mouth: Array<Point>;
2519
-
2520
- /**
2521
- * 描述鼻子轮廓的 13 点。
2522
- */
2523
- Nose: Array<Point>;
2524
-
2525
- /**
2526
- * 左瞳孔轮廓的 1 个点。
2527
- */
2528
- LeftPupil: Array<Point>;
2529
-
2530
- /**
2531
- * 右瞳孔轮廓的 1 个点。
2532
- */
2533
- RightPupil: Array<Point>;
2414
+ /**
2415
+ * 描述左侧眼睛轮廓的 8 点。
2416
+ */
2417
+ LeftEye: Array<Point>
2418
+
2419
+ /**
2420
+ * 描述右侧眼睛轮廓的 8 点。
2421
+ */
2422
+ RightEye: Array<Point>
2423
+
2424
+ /**
2425
+ * 描述左侧眉毛轮廓的 8 点。
2426
+ */
2427
+ LeftEyeBrow: Array<Point>
2428
+
2429
+ /**
2430
+ * 描述右侧眉毛轮廓的 8 点。
2431
+ */
2432
+ RightEyeBrow: Array<Point>
2433
+
2434
+ /**
2435
+ * 描述嘴巴轮廓的 22 点。
2436
+ */
2437
+ Mouth: Array<Point>
2438
+
2439
+ /**
2440
+ * 描述鼻子轮廓的 13 点。
2441
+ */
2442
+ Nose: Array<Point>
2443
+
2444
+ /**
2445
+ * 左瞳孔轮廓的 1 个点。
2446
+ */
2447
+ LeftPupil: Array<Point>
2448
+
2449
+ /**
2450
+ * 右瞳孔轮廓的 1 个点。
2451
+ */
2452
+ RightPupil: Array<Point>
2534
2453
  }
2535
2454
 
2536
2455
  /**
2537
2456
  * CompareFace请求参数结构体
2538
2457
  */
2539
2458
  export interface CompareFaceRequest {
2540
-
2541
- /**
2459
+ /**
2542
2460
  * A 图片 base64 数据,base64 编码后大小不可超过5M。
2543
2461
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2544
2462
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2545
2463
  */
2546
- ImageA?: string;
2547
-
2548
- /**
2464
+ ImageA?: string
2465
+
2466
+ /**
2549
2467
  * B 图片 base64 数据,base64 编码后大小不可超过5M。
2550
2468
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2551
2469
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2552
2470
  */
2553
- ImageB?: string;
2554
-
2555
- /**
2471
+ ImageB?: string
2472
+
2473
+ /**
2556
2474
  * A 图片的 Url ,对应图片 base64 编码后大小不可超过5M。
2557
2475
  A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2558
2476
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
@@ -2560,9 +2478,9 @@ A 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2560
2478
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2561
2479
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2562
2480
  */
2563
- UrlA?: string;
2564
-
2565
- /**
2481
+ UrlA?: string
2482
+
2483
+ /**
2566
2484
  * B 图片的 Url ,对应图片 base64 编码后大小不可超过5M。
2567
2485
  B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2568
2486
  图片存储于腾讯云的Url可保障更高下载速度和稳定性,建议图片存储于腾讯云。
@@ -2570,9 +2488,9 @@ B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2570
2488
  若图片中包含多张人脸,只选取其中人脸面积最大的人脸。
2571
2489
  支持PNG、JPG、JPEG、BMP,不支持 GIF 图片。
2572
2490
  */
2573
- UrlB?: string;
2574
-
2575
- /**
2491
+ UrlB?: string
2492
+
2493
+ /**
2576
2494
  * 人脸识别服务所用的算法模型版本。
2577
2495
 
2578
2496
  目前入参支持 “2.0”和“3.0“ 两个输入。
@@ -2583,9 +2501,9 @@ B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2583
2501
 
2584
2502
  不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
2585
2503
  */
2586
- FaceModelVersion?: string;
2587
-
2588
- /**
2504
+ FaceModelVersion?: string
2505
+
2506
+ /**
2589
2507
  * 图片质量控制。
2590
2508
  0: 不进行控制;
2591
2509
  1:较低的质量要求,图像存在非常模糊,眼睛鼻子嘴巴遮挡至少其中一种或多种的情况;
@@ -2595,61 +2513,59 @@ B 图片的 Url、Image必须提供一个,如果都提供,只使用 Url。
2595
2513
  默认 0。
2596
2514
  若图片质量不满足要求,则返回结果中会提示图片质量检测不符要求。
2597
2515
  */
2598
- QualityControl?: number;
2599
-
2600
- /**
2601
- * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2602
- */
2603
- NeedRotateDetection?: number;
2516
+ QualityControl?: number
2517
+
2518
+ /**
2519
+ * 是否开启图片旋转识别支持。0为不开启,1为开启。默认为0。本参数的作用为,当图片中的人脸被旋转且图片没有exif信息时,如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况,请不要开启本参数。开启后,整体耗时将可能增加数百毫秒。
2520
+ */
2521
+ NeedRotateDetection?: number
2604
2522
  }
2605
2523
 
2606
2524
  /**
2607
2525
  * VerifyPerson返回参数结构体
2608
2526
  */
2609
2527
  export interface VerifyPersonResponse {
2528
+ /**
2529
+ * 给定的人脸照片与 PersonId 对应的相似度。若 PersonId 下有多张人脸(Face),会融合多张人脸信息进行验证。
2530
+ */
2531
+ Score?: number
2610
2532
 
2611
- /**
2612
- * 给定的人脸照片与 PersonId 对应的相似度。若 PersonId 下有多张人脸(Face),会融合多张人脸信息进行验证。
2613
- */
2614
- Score?: number;
2615
-
2616
- /**
2617
- * 是否为同一人的判断。
2618
- */
2619
- IsMatch?: boolean;
2620
-
2621
- /**
2622
- * 人脸识别所用的算法模型版本。
2623
- */
2624
- FaceModelVersion?: string;
2625
-
2626
- /**
2627
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2628
- */
2629
- RequestId?: string;
2533
+ /**
2534
+ * 是否为同一人的判断。
2535
+ */
2536
+ IsMatch?: boolean
2537
+
2538
+ /**
2539
+ * 人脸识别所用的算法模型版本。
2540
+ */
2541
+ FaceModelVersion?: string
2542
+
2543
+ /**
2544
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2545
+ */
2546
+ RequestId?: string
2630
2547
  }
2631
2548
 
2632
2549
  /**
2633
2550
  * DetectFace返回参数结构体
2634
2551
  */
2635
2552
  export interface DetectFaceResponse {
2636
-
2637
- /**
2638
- * 请求的图片宽度。
2639
- */
2640
- ImageWidth: number;
2641
-
2642
- /**
2643
- * 请求的图片高度。
2644
- */
2645
- ImageHeight: number;
2646
-
2647
- /**
2648
- * 人脸信息列表。包含人脸坐标信息、属性信息(若需要)、质量分信息(若需要)。
2649
- */
2650
- FaceInfos: Array<FaceInfo>;
2651
-
2652
- /**
2553
+ /**
2554
+ * 请求的图片宽度。
2555
+ */
2556
+ ImageWidth: number
2557
+
2558
+ /**
2559
+ * 请求的图片高度。
2560
+ */
2561
+ ImageHeight: number
2562
+
2563
+ /**
2564
+ * 人脸信息列表。包含人脸坐标信息、属性信息(若需要)、质量分信息(若需要)。
2565
+ */
2566
+ FaceInfos: Array<FaceInfo>
2567
+
2568
+ /**
2653
2569
  * 人脸识别服务所用的算法模型版本。
2654
2570
 
2655
2571
  目前入参支持 “2.0”和“3.0“ 两个输入。
@@ -2660,105 +2576,100 @@ export interface DetectFaceResponse {
2660
2576
 
2661
2577
  不同算法模型版本对应的人脸识别算法不同,新版本的整体效果会优于旧版本,建议使用“3.0”版本。
2662
2578
  */
2663
- FaceModelVersion: string;
2664
-
2665
- /**
2666
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2667
- */
2668
- RequestId?: string;
2579
+ FaceModelVersion: string
2580
+
2581
+ /**
2582
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2583
+ */
2584
+ RequestId?: string
2669
2585
  }
2670
2586
 
2671
2587
  /**
2672
2588
  * GetPersonListNum请求参数结构体
2673
2589
  */
2674
2590
  export interface GetPersonListNumRequest {
2675
-
2676
- /**
2677
- * 人员库ID
2678
- */
2679
- GroupId: string;
2591
+ /**
2592
+ * 人员库ID
2593
+ */
2594
+ GroupId: string
2680
2595
  }
2681
2596
 
2682
2597
  /**
2683
2598
  * GetGroupInfo请求参数结构体
2684
2599
  */
2685
2600
  export interface GetGroupInfoRequest {
2686
-
2687
- /**
2688
- * 人员库 ID。
2689
- */
2690
- GroupId: string;
2601
+ /**
2602
+ * 人员库 ID。
2603
+ */
2604
+ GroupId: string
2691
2605
  }
2692
2606
 
2693
2607
  /**
2694
2608
  * 人员库升级任务信息
2695
2609
  */
2696
2610
  export interface UpgradeJobInfo {
2697
-
2698
- /**
2699
- * 人员库升级任务ID,用于查询、获取升级的进度和结果。
2700
- */
2701
- JobId: string;
2702
-
2703
- /**
2704
- * 人员库ID。
2705
- */
2706
- GroupId: string;
2707
-
2708
- /**
2709
- * 当前算法模型版本。
2710
- */
2711
- FromFaceModelVersion: string;
2712
-
2713
- /**
2714
- * 目标算法模型版本。
2715
- */
2716
- ToFaceModelVersion: string;
2717
-
2718
- /**
2611
+ /**
2612
+ * 人员库升级任务ID,用于查询、获取升级的进度和结果。
2613
+ */
2614
+ JobId: string
2615
+
2616
+ /**
2617
+ * 人员库ID。
2618
+ */
2619
+ GroupId: string
2620
+
2621
+ /**
2622
+ * 当前算法模型版本。
2623
+ */
2624
+ FromFaceModelVersion: string
2625
+
2626
+ /**
2627
+ * 目标算法模型版本。
2628
+ */
2629
+ ToFaceModelVersion: string
2630
+
2631
+ /**
2719
2632
  * 升级起始时间。
2720
2633
  StartTime的值是自 Unix 纪元时间到Group创建时间的毫秒数。
2721
2634
  Unix 纪元时间是 1970 年 1 月 1 日星期四,协调世界时 (UTC) 00:00:00。
2722
2635
  有关更多信息,请参阅 Unix 时间。
2723
2636
  */
2724
- StartTime: number;
2725
-
2726
- /**
2727
- * 0表示升级中,1表示升级完毕,2表示回滚完毕。
2728
- */
2729
- Status: number;
2637
+ StartTime: number
2638
+
2639
+ /**
2640
+ * 0表示升级中,1表示升级完毕,2表示回滚完毕。
2641
+ */
2642
+ Status: number
2730
2643
  }
2731
2644
 
2732
2645
  /**
2733
2646
  * ModifyGroup返回参数结构体
2734
2647
  */
2735
2648
  export interface ModifyGroupResponse {
2736
-
2737
- /**
2738
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2739
- */
2740
- RequestId?: string;
2649
+ /**
2650
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2651
+ */
2652
+ RequestId?: string
2741
2653
  }
2742
2654
 
2743
2655
  /**
2744
2656
  * GetPersonList请求参数结构体
2745
2657
  */
2746
2658
  export interface GetPersonListRequest {
2659
+ /**
2660
+ * 人员库ID
2661
+ */
2662
+ GroupId: string
2747
2663
 
2748
- /**
2749
- * 人员库ID
2750
- */
2751
- GroupId: string;
2752
-
2753
- /**
2754
- * 起始序号,默认值为0
2755
- */
2756
- Offset?: number;
2757
-
2758
- /**
2759
- * 返回数量,默认值为10,最大值为1000
2760
- */
2761
- Limit?: number;
2664
+ /**
2665
+ * 起始序号,默认值为0
2666
+ */
2667
+ Offset?: number
2668
+
2669
+ /**
2670
+ * 返回数量,默认值为10,最大值为1000
2671
+ */
2672
+ Limit?: number
2762
2673
  }
2763
2674
 
2764
2675
  /**
@@ -2769,181 +2680,175 @@ export interface GetPersonListRequest {
2769
2680
  若 FaceAttributesType 没有输入相关类型,则FaceDetaiAttributesInfo返回的细项不具备参考意义。
2770
2681
  */
2771
2682
  export interface FaceDetailAttributesInfo {
2772
-
2773
- /**
2683
+ /**
2774
2684
  * 年龄 [0,65],其中65代表“65岁及以上”。
2775
2685
  FaceAttributesType 不为含Age 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2776
2686
  */
2777
- Age: number;
2778
-
2779
- /**
2687
+ Age: number
2688
+
2689
+ /**
2780
2690
  * 美丑打分[0,100]。
2781
2691
  FaceAttributesType 不含 Beauty 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2782
2692
  */
2783
- Beauty: number;
2784
-
2785
- /**
2693
+ Beauty: number
2694
+
2695
+ /**
2786
2696
  * 情绪,可识别自然、高兴、惊讶、生气、悲伤、厌恶、害怕。
2787
2697
  AttributeItem对应的Type为 —— 0:自然,1:高兴,2:惊讶,3:生气,4:悲伤,5:厌恶,6:害怕
2788
2698
  FaceAttributesType 不含Emotion 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2789
2699
  */
2790
- Emotion: AttributeItem;
2791
-
2792
- /**
2700
+ Emotion: AttributeItem
2701
+
2702
+ /**
2793
2703
  * 眼睛相关信息,可识别是否戴眼镜、是否闭眼、是否双眼皮和眼睛大小。
2794
2704
  FaceAttributesType 不含Eye 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2795
2705
  */
2796
- Eye: Eye;
2797
-
2798
- /**
2706
+ Eye: Eye
2707
+
2708
+ /**
2799
2709
  * 眉毛相关信息,可识别眉毛浓密、弯曲、长短信息。
2800
2710
  FaceAttributesType 不含Eyebrow 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2801
2711
  */
2802
- Eyebrow: Eyebrow;
2803
-
2804
- /**
2712
+ Eyebrow: Eyebrow
2713
+
2714
+ /**
2805
2715
  * 性别信息。
2806
2716
  AttributeItem对应的Type为 —— 0:男性,1:女性。
2807
2717
  FaceAttributesType 不含Gender 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2808
2718
  */
2809
- Gender: AttributeItem;
2810
-
2811
- /**
2719
+ Gender: AttributeItem
2720
+
2721
+ /**
2812
2722
  * 头发信息,包含头发长度、有无刘海、头发颜色。
2813
2723
  FaceAttributesType 不含Hair 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2814
2724
  */
2815
- Hair: Hair;
2816
-
2817
- /**
2725
+ Hair: Hair
2726
+
2727
+ /**
2818
2728
  * 帽子信息,可识别是否佩戴帽子、帽子款式、帽子颜色。
2819
2729
  FaceAttributesType 不含Hat 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2820
2730
  */
2821
- Hat: Hat;
2822
-
2823
- /**
2731
+ Hat: Hat
2732
+
2733
+ /**
2824
2734
  * 姿态信息,包含人脸的上下偏移、左右偏移、平面旋转信息。
2825
2735
  FaceAttributesType 不含Headpose 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2826
2736
  */
2827
- HeadPose: HeadPose;
2828
-
2829
- /**
2737
+ HeadPose: HeadPose
2738
+
2739
+ /**
2830
2740
  * 口罩佩戴信息。
2831
2741
  AttributeItem对应的Type为 —— 0: 无口罩, 1: 有口罩不遮脸,2: 有口罩遮下巴,3: 有口罩遮嘴,4: 正确佩戴口罩。
2832
2742
  FaceAttributesType 不含Mask 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2833
2743
  */
2834
- Mask: AttributeItem;
2835
-
2836
- /**
2744
+ Mask: AttributeItem
2745
+
2746
+ /**
2837
2747
  * 嘴巴信息,可识别是否张嘴、嘴唇厚度。
2838
2748
  FaceAttributesType 不含 Mouth 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2839
2749
  */
2840
- Mouth: Mouth;
2841
-
2842
- /**
2750
+ Mouth: Mouth
2751
+
2752
+ /**
2843
2753
  * 胡子信息。
2844
2754
  AttributeItem对应的Type为 —— 0:无胡子,1:有胡子。
2845
2755
  FaceAttributesType 不含 Moustache 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2846
2756
  */
2847
- Moustache: AttributeItem;
2848
-
2849
- /**
2757
+ Moustache: AttributeItem
2758
+
2759
+ /**
2850
2760
  * 鼻子信息。
2851
2761
  AttributeItem对应的Type为 —— 0:朝天鼻,1:鹰钩鼻,2:普通,3:圆鼻头
2852
2762
  FaceAttributesType 不含 Nose 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2853
2763
  */
2854
- Nose: AttributeItem;
2855
-
2856
- /**
2764
+ Nose: AttributeItem
2765
+
2766
+ /**
2857
2767
  * 脸型信息。
2858
2768
  AttributeItem对应的Type为 —— 0:方脸,1:三角脸,2:鹅蛋脸,3:心形脸,4:圆脸。
2859
2769
  FaceAttributesType 不含 Shape 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2860
2770
  */
2861
- Shape: AttributeItem;
2862
-
2863
- /**
2771
+ Shape: AttributeItem
2772
+
2773
+ /**
2864
2774
  * 肤色信息。
2865
2775
  AttributeItem对应的Type为 —— 0:黄色皮肤,1:棕色皮肤,2:黑色皮肤,3:白色皮肤。
2866
2776
  FaceAttributesType 不含 Skin 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2867
2777
  */
2868
- Skin: AttributeItem;
2869
-
2870
- /**
2778
+ Skin: AttributeItem
2779
+
2780
+ /**
2871
2781
  * 微笑程度,[0,100]。
2872
2782
  FaceAttributesType 不含 Smile 或检测超过 5 张人脸时,此参数仍返回,但不具备参考意义。
2873
2783
  */
2874
- Smile: number;
2784
+ Smile: number
2875
2785
  }
2876
2786
 
2877
2787
  /**
2878
2788
  * 人脸属性信息
2879
2789
  */
2880
2790
  export interface AttributeItem {
2791
+ /**
2792
+ * 属性值
2793
+ */
2794
+ Type: number
2881
2795
 
2882
- /**
2883
- * 属性值
2884
- */
2885
- Type: number;
2886
-
2887
- /**
2888
- * Type识别概率值,【0,1】,代表判断正确的概率。
2889
- */
2890
- Probability: number;
2796
+ /**
2797
+ * Type识别概率值,【0,1】,代表判断正确的概率。
2798
+ */
2799
+ Probability: number
2891
2800
  }
2892
2801
 
2893
2802
  /**
2894
2803
  * 检测出的人脸框的位置
2895
2804
  */
2896
2805
  export interface FaceRect {
2897
-
2898
- /**
2806
+ /**
2899
2807
  * 人脸框左上角横坐标。
2900
2808
  人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
2901
2809
  若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
2902
2810
  */
2903
- X: number;
2904
-
2905
- /**
2811
+ X: number
2812
+
2813
+ /**
2906
2814
  * 人脸框左上角纵坐标。
2907
2815
  人脸框包含人脸五官位置并在此基础上进行一定的扩展,若人脸框超出图片范围,会导致坐标负值。
2908
2816
  若需截取完整人脸,可以在完整分completess满足需求的情况下,将负值坐标取0。
2909
2817
  */
2910
- Y: number;
2911
-
2912
- /**
2913
- * 人脸宽度
2914
- */
2915
- Width: number;
2916
-
2917
- /**
2918
- * 人脸高度
2919
- */
2920
- Height: number;
2818
+ Y: number
2819
+
2820
+ /**
2821
+ * 人脸宽度
2822
+ */
2823
+ Width: number
2824
+
2825
+ /**
2826
+ * 人脸高度
2827
+ */
2828
+ Height: number
2921
2829
  }
2922
2830
 
2923
2831
  /**
2924
2832
  * ModifyPersonGroupInfo返回参数结构体
2925
2833
  */
2926
2834
  export interface ModifyPersonGroupInfoResponse {
2927
-
2928
- /**
2929
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2930
- */
2931
- RequestId?: string;
2835
+ /**
2836
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2837
+ */
2838
+ RequestId?: string
2932
2839
  }
2933
2840
 
2934
2841
  /**
2935
2842
  * CreateGroup返回参数结构体
2936
2843
  */
2937
2844
  export interface CreateGroupResponse {
2845
+ /**
2846
+ * 人脸识别所用的算法模型版本。
2847
+ */
2848
+ FaceModelVersion: string
2938
2849
 
2939
- /**
2940
- * 人脸识别所用的算法模型版本。
2941
- */
2942
- FaceModelVersion: string;
2943
-
2944
- /**
2945
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2946
- */
2947
- RequestId?: string;
2850
+ /**
2851
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2852
+ */
2853
+ RequestId?: string
2948
2854
  }
2949
-