@regulaforensics/facesdk-webclient 5.2.7 → 6.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +1 -1
  2. package/dist/main/index.cjs +1 -1
  3. package/dist/module/index.js +1 -1
  4. package/lib/index.d.ts +663 -393
  5. package/package.json +1 -1
package/lib/index.d.ts CHANGED
@@ -1,9 +1,9 @@
1
1
  import { AxiosRequestConfig, AxiosInstance } from "axios";
2
2
  /**
3
3
  * Regula FaceSDK Web API
4
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
4
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
5
5
  *
6
- * The version of the OpenAPI document: 5.2.0
6
+ * The version of the OpenAPI document: 6.1.0
7
7
  *
8
8
  *
9
9
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -84,9 +84,9 @@ export class Configuration {
84
84
  }
85
85
  /**
86
86
  * Regula FaceSDK Web API
87
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
87
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
88
88
  *
89
- * The version of the OpenAPI document: 5.2.0
89
+ * The version of the OpenAPI document: 6.1.0
90
90
  *
91
91
  *
92
92
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -94,54 +94,155 @@ export class Configuration {
94
94
  * Do not edit the class manually.
95
95
  */
96
96
  /**
97
- * The aspect ratio according to which face alignment is performed during face detection.
97
+ * Set to resize the original image.
98
98
  * @export
99
- * @enum {string}
99
+ * @interface ResizeOptions
100
100
  */
101
- export const FaceImageQualityAlignType: {
102
- readonly ALIGN_3x4: 0;
103
- readonly ALIGN_4x5: 1;
104
- readonly ALIGN_2x3: 2;
105
- readonly ALIGN_1x1: 3;
106
- readonly ALIGN_7x9: 4;
107
- };
108
- export type FaceImageQualityAlignType = (typeof FaceImageQualityAlignType)[keyof typeof FaceImageQualityAlignType];
101
+ export interface ResizeOptions {
102
+ /**
103
+ * Resized image width, px.
104
+ * @type {number}
105
+ * @memberof ResizeOptions
106
+ */
107
+ 'width'?: number;
108
+ /**
109
+ * Resized image height, px.
110
+ * @type {number}
111
+ * @memberof ResizeOptions
112
+ */
113
+ 'height'?: number;
114
+ /**
115
+ * Resized image quality, percent.
116
+ * @type {number}
117
+ * @memberof ResizeOptions
118
+ */
119
+ 'quality'?: number;
120
+ }
121
+ type Base64String = string;
122
+ type ImageData = Base64String | ArrayBuffer;
109
123
  /**
110
- * Whether to return the Base64 of an aligned and cropped portrait in the crop field.
124
+ * Uploaded image.
111
125
  * @export
112
- * @interface Crop
126
+ * @interface AddImageToPersonRequestImage
113
127
  */
114
- export interface Crop {
128
+ export interface AddImageToPersonRequestImage {
129
+ /**
130
+ * Original media type of the uploaded image.
131
+ * @type {string}
132
+ * @memberof AddImageToPersonRequestImage
133
+ */
134
+ 'contentType'?: string;
115
135
  /**
116
136
  *
117
- * @type {FaceImageQualityAlignType}
118
- * @memberof Crop
137
+ * @type {ImageData}
138
+ * @memberof AddImageToPersonRequestImage
119
139
  */
120
- 'type'?: FaceImageQualityAlignType;
140
+ 'content'?: ImageData;
121
141
  /**
122
- * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
123
- * @type {Array<number>}
124
- * @memberof Crop
142
+ * Image URL.
143
+ * @type {string}
144
+ * @memberof AddImageToPersonRequestImage
125
145
  */
126
- 'padColor'?: Array<number>;
146
+ 'imageUrl'?: string;
127
147
  /**
128
- * The resize value in case type matches this value. If it doesn\'t, no resize is done.
129
- * @type {Array<number>}
130
- * @memberof Crop
148
+ *
149
+ * @type {ResizeOptions}
150
+ * @memberof AddImageToPersonRequestImage
131
151
  */
132
- 'size'?: Array<number>;
152
+ 'resizeOptions'?: ResizeOptions;
153
+ }
154
+ /**
155
+ * Image in the request data, includes image and contentType.
156
+ * @export
157
+ * @interface AddImageToPersonRequest
158
+ */
159
+ export interface AddImageToPersonRequest {
133
160
  /**
134
- * Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.
135
- * @type {boolean}
136
- * @memberof Crop
161
+ * Session identificator.
162
+ * @type {string}
163
+ * @memberof AddImageToPersonRequest
137
164
  */
138
- 'returnOriginalRect'?: boolean;
165
+ 'tag'?: string;
166
+ /**
167
+ *
168
+ * @type {AddImageToPersonRequestImage}
169
+ * @memberof AddImageToPersonRequest
170
+ */
171
+ 'image': AddImageToPersonRequestImage;
172
+ /**
173
+ * The similarity threshold.
174
+ * @type {number}
175
+ * @memberof AddImageToPersonRequest
176
+ */
177
+ 'threshold'?: number;
178
+ /**
179
+ * The maximum number of results to be returned.
180
+ * @type {number}
181
+ * @memberof AddImageToPersonRequest
182
+ */
183
+ 'limit'?: number;
139
184
  }
140
185
  /**
141
186
  * Regula FaceSDK Web API
142
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
187
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
143
188
  *
144
- * The version of the OpenAPI document: 5.2.0
189
+ * The version of the OpenAPI document: 6.1.0
190
+ *
191
+ *
192
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
193
+ * https://openapi-generator.tech
194
+ * Do not edit the class manually.
195
+ */
196
+ /**
197
+ * Image in the response.
198
+ * @export
199
+ * @interface AddImageToPersonResponse
200
+ */
201
+ export interface AddImageToPersonResponse {
202
+ /**
203
+ * Response image ID. The list is sorted by decreasing ID value.
204
+ * @type {string}
205
+ * @memberof AddImageToPersonResponse
206
+ */
207
+ 'id'?: string;
208
+ /**
209
+ * Original media type of the returned image.
210
+ * @type {string}
211
+ * @memberof AddImageToPersonResponse
212
+ */
213
+ 'contentType'?: string;
214
+ /**
215
+ * Returned image creation date.
216
+ * @type {string}
217
+ * @memberof AddImageToPersonResponse
218
+ */
219
+ 'createdAt'?: string;
220
+ /**
221
+ * Returned image path.
222
+ * @type {string}
223
+ * @memberof AddImageToPersonResponse
224
+ */
225
+ 'path'?: string;
226
+ /**
227
+ * Returned image URL.
228
+ * @type {string}
229
+ * @memberof AddImageToPersonResponse
230
+ */
231
+ 'url'?: string;
232
+ /**
233
+ * A free-form object containing person\'s extended attributes.
234
+ * @type {{ [key: string]: object; }}
235
+ * @memberof AddImageToPersonResponse
236
+ */
237
+ 'metadata'?: {
238
+ [key: string]: object;
239
+ };
240
+ }
241
+ /**
242
+ * Regula FaceSDK Web API
243
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
244
+ *
245
+ * The version of the OpenAPI document: 6.1.0
145
246
  *
146
247
  *
147
248
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -170,42 +271,78 @@ export const FaceAttribute: {
170
271
  };
171
272
  export type FaceAttribute = (typeof FaceAttribute)[keyof typeof FaceAttribute];
172
273
  /**
173
- * The configuration that defines the list of returned quality check characteristics.
274
+ * The configuration that defines the list of returned attribute check characteristics.
174
275
  * @export
175
- * @interface QualityConfig
276
+ * @interface AttributeConfig
176
277
  */
177
- export interface QualityConfig {
278
+ export interface AttributeConfig {
178
279
  /**
179
280
  *
180
281
  * @type {FaceAttribute}
181
- * @memberof QualityConfig
282
+ * @memberof AttributeConfig
182
283
  */
183
284
  'name'?: FaceAttribute;
184
- /**
185
- * The range of applicable values for this characteristic. If the returned in the Response value fits this range, the value is identified as compliant with the requirements.
186
- * @type {Array<number>}
187
- * @memberof QualityConfig
188
- */
189
- 'range'?: Array<number>;
190
285
  }
191
286
  /**
192
- * Whether to evaluate attributes, such as age and emotions.
287
+ * Regula FaceSDK Web API
288
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
289
+ *
290
+ * The version of the OpenAPI document: 6.1.0
291
+ *
292
+ *
293
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
294
+ * https://openapi-generator.tech
295
+ * Do not edit the class manually.
296
+ */
297
+ /**
298
+ * The aspect ratio according to which face alignment is performed during face detection.
193
299
  * @export
194
- * @interface DetectRequestAttributes
300
+ * @enum {string}
195
301
  */
196
- export interface DetectRequestAttributes {
302
+ export const FaceImageQualityAlignType: {
303
+ readonly ALIGN_3x4: 0;
304
+ readonly ALIGN_4x5: 1;
305
+ readonly ALIGN_2x3: 2;
306
+ readonly ALIGN_1x1: 3;
307
+ readonly ALIGN_7x9: 4;
308
+ };
309
+ export type FaceImageQualityAlignType = (typeof FaceImageQualityAlignType)[keyof typeof FaceImageQualityAlignType];
310
+ /**
311
+ * Whether to return the Base64 image of an aligned and cropped portrait in the `crop` field.
312
+ * @export
313
+ * @interface Crop
314
+ */
315
+ export interface Crop {
197
316
  /**
198
317
  *
199
- * @type {Array<QualityConfig>}
200
- * @memberof DetectRequestAttributes
318
+ * @type {FaceImageQualityAlignType}
319
+ * @memberof Crop
201
320
  */
202
- 'config'?: Array<QualityConfig>;
321
+ 'type'?: FaceImageQualityAlignType;
322
+ /**
323
+ * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
324
+ * @type {Array<number>}
325
+ * @memberof Crop
326
+ */
327
+ 'padColor'?: Array<number>;
328
+ /**
329
+ * The resize value in case `type` matches this value. If it doesn\'t, no resize is performed.
330
+ * @type {Array<number>}
331
+ * @memberof Crop
332
+ */
333
+ 'size'?: Array<number>;
334
+ /**
335
+ * Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.
336
+ * @type {boolean}
337
+ * @memberof Crop
338
+ */
339
+ 'returnOriginalRect'?: boolean;
203
340
  }
204
341
  /**
205
342
  * Regula FaceSDK Web API
206
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
343
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
207
344
  *
208
- * The version of the OpenAPI document: 5.2.0
345
+ * The version of the OpenAPI document: 6.1.0
209
346
  *
210
347
  *
211
348
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -226,6 +363,7 @@ export const FaceQualityScenarios: {
226
363
  readonly CROP_CENTRAL_FACE: "CropCentralFace";
227
364
  readonly CROP_ALL_FACES: "CropAllFaces";
228
365
  readonly THUMBNAIL: "Thumbnail";
366
+ readonly EMPTY: "";
229
367
  };
230
368
  export type FaceQualityScenarios = (typeof FaceQualityScenarios)[keyof typeof FaceQualityScenarios];
231
369
  /**
@@ -233,19 +371,118 @@ export type FaceQualityScenarios = (typeof FaceQualityScenarios)[keyof typeof Fa
233
371
  * @export
234
372
  * @interface OutputImageParams
235
373
  */
236
- export interface OutputImageParams {
374
+ export interface OutputImageParams {
375
+ /**
376
+ * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
377
+ * @type {Array<number>}
378
+ * @memberof OutputImageParams
379
+ */
380
+ 'backgroundColor'?: Array<number>;
381
+ /**
382
+ *
383
+ * @type {Crop}
384
+ * @memberof OutputImageParams
385
+ */
386
+ 'crop'?: Crop;
387
+ }
388
+ /**
389
+ * If set, the selected attributes, such as age or emotions, are evaluated.
390
+ * @export
391
+ * @interface ProcessParamAttributes
392
+ */
393
+ export interface ProcessParamAttributes {
394
+ /**
395
+ *
396
+ * @type {Array<AttributeConfig>}
397
+ * @memberof ProcessParamAttributes
398
+ */
399
+ 'config'?: Array<AttributeConfig>;
400
+ }
401
+ /**
402
+ * Regula FaceSDK Web API
403
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
404
+ *
405
+ * The version of the OpenAPI document: 6.1.0
406
+ *
407
+ *
408
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
409
+ * https://openapi-generator.tech
410
+ * Do not edit the class manually.
411
+ */
412
+ /**
413
+ * All image characteristics that can be assessed during face image quality assessment.
414
+ * @export
415
+ * @enum {string}
416
+ */
417
+ export const FaceQualityConfigName: {
418
+ readonly IMAGE_WIDTH: "ImageWidth";
419
+ readonly IMAGE_HEIGHT: "ImageHeight";
420
+ readonly IMAGE_WIDTH_TO_HEIGHT: "ImageWidthToHeight";
421
+ readonly IMAGE_CHANNELS_NUMBER: "ImageChannelsNumber";
422
+ readonly PADDING_RATIO: "PaddingRatio";
423
+ readonly FACE_MID_POINT_HORIZONTAL_POSITION: "FaceMidPointHorizontalPosition";
424
+ readonly FACE_MID_POINT_VERTICAL_POSITION: "FaceMidPointVerticalPosition";
425
+ readonly HEAD_WIDTH_RATIO: "HeadWidthRatio";
426
+ readonly HEAD_HEIGHT_RATIO: "HeadHeightRatio";
427
+ readonly EYES_DISTANCE: "EyesDistance";
428
+ readonly YAW: "Yaw";
429
+ readonly PITCH: "Pitch";
430
+ readonly ROLL: "Roll";
431
+ readonly BLUR_LEVEL: "BlurLevel";
432
+ readonly NOISE_LEVEL: "NoiseLevel";
433
+ readonly EYE_RIGHT_CLOSED: "EyeRightClosed";
434
+ readonly EYE_LEFT_CLOSED: "EyeLeftClosed";
435
+ readonly EYE_RIGHT_OCCLUDED: "EyeRightOccluded";
436
+ readonly EYE_LEFT_OCCLUDED: "EyeLeftOccluded";
437
+ readonly EYES_RED: "EyesRed";
438
+ readonly EYE_RIGHT_COVERED_WITH_HAIR: "EyeRightCoveredWithHair";
439
+ readonly EYE_LEFT_COVERED_WITH_HAIR: "EyeLeftCoveredWithHair";
440
+ readonly OFF_GAZE: "OffGaze";
441
+ readonly FACE_DYNAMIC_RANGE: "FaceDynamicRange";
442
+ readonly UNNATURAL_SKIN_TONE: "UnnaturalSkinTone";
443
+ readonly TOO_DARK: "TooDark";
444
+ readonly TOO_LIGHT: "TooLight";
445
+ readonly FACE_GLARE: "FaceGlare";
446
+ readonly SHADOWS_ON_FACE: "ShadowsOnFace";
447
+ readonly DARK_GLASSES: "DarkGlasses";
448
+ readonly REFLECTION_ON_GLASSES: "ReflectionOnGlasses";
449
+ readonly FRAMES_TOO_HEAVY: "FramesTooHeavy";
450
+ readonly FACE_OCCLUDED: "FaceOccluded";
451
+ readonly HEAD_COVERING: "HeadCovering";
452
+ readonly BACKGROUND_UNIFORMITY: "BackgroundUniformity";
453
+ readonly SHADOWS_ON_BACKGROUND: "ShadowsOnBackground";
454
+ readonly OTHER_FACES: "OtherFaces";
455
+ readonly SHOULDERS_POSE: "ShouldersPose";
456
+ readonly EXPRESSION_LEVEL: "ExpressionLevel";
457
+ readonly MOUTH_OPEN: "MouthOpen";
458
+ readonly FOREHEAD_COVERING: "ForeheadCovering";
459
+ readonly SMILE: "Smile";
460
+ readonly STRONG_MAKEUP: "StrongMakeup";
461
+ readonly HEADPHONES: "Headphones";
462
+ readonly MEDICAL_MASK: "MedicalMask";
463
+ readonly BACKGROUND_COLOR_MATCH: "BackgroundColorMatch";
464
+ readonly ART_FACE: "ArtFace";
465
+ readonly CONTACT_LENSES: "ContactLenses";
466
+ };
467
+ export type FaceQualityConfigName = (typeof FaceQualityConfigName)[keyof typeof FaceQualityConfigName];
468
+ /**
469
+ * The configuration that defines the list of returned quality check characteristics.
470
+ * @export
471
+ * @interface QualityConfig
472
+ */
473
+ export interface QualityConfig {
237
474
  /**
238
- * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
239
- * @type {Array<number>}
240
- * @memberof OutputImageParams
475
+ *
476
+ * @type {FaceQualityConfigName}
477
+ * @memberof QualityConfig
241
478
  */
242
- 'backgroundColor'?: Array<number>;
479
+ 'name'?: FaceQualityConfigName;
243
480
  /**
244
- *
245
- * @type {Crop}
246
- * @memberof OutputImageParams
481
+ * The range of applicable values for this characteristic. If the returned in the Response value fits this range, the value is identified as compliant with the requirements.
482
+ * @type {Array<number>}
483
+ * @memberof QualityConfig
247
484
  */
248
- 'crop'?: Crop;
485
+ 'range'?: Array<number>;
249
486
  }
250
487
  /**
251
488
  * Whether to perform the portrait quality check.
@@ -297,14 +534,12 @@ export interface ProcessParam {
297
534
  */
298
535
  'quality'?: QualityRequest;
299
536
  /**
300
- * Whether to evaluate attributes, such as age and emotions.
301
- * @type {boolean}
537
+ *
538
+ * @type {ProcessParamAttributes}
302
539
  * @memberof ProcessParam
303
540
  */
304
- 'attributes'?: boolean;
541
+ 'attributes'?: ProcessParamAttributes;
305
542
  }
306
- export type Base64String = string;
307
- export type ImageData = Base64String | ArrayBuffer;
308
543
  /**
309
544
  *
310
545
  * @export
@@ -330,23 +565,17 @@ export interface DetectRequest {
330
565
  */
331
566
  'image'?: ImageData;
332
567
  /**
333
- * Whether to return the cropped portrains with the detected faces.
568
+ * Deprecated, use the `crop` field in `processParam` instead.
334
569
  * @type {boolean}
335
570
  * @memberof DetectRequest
336
571
  */
337
572
  'thumbnails'?: boolean;
338
- /**
339
- *
340
- * @type {DetectRequestAttributes}
341
- * @memberof DetectRequest
342
- */
343
- 'attributes'?: DetectRequestAttributes;
344
573
  }
345
574
  /**
346
575
  * Regula FaceSDK Web API
347
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
576
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
348
577
  *
349
- * The version of the OpenAPI document: 5.2.0
578
+ * The version of the OpenAPI document: 6.1.0
350
579
  *
351
580
  *
352
581
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -376,76 +605,9 @@ export interface DetectionAttributes {
376
605
  }
377
606
  /**
378
607
  * Regula FaceSDK Web API
379
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
380
- *
381
- * The version of the OpenAPI document: 5.2.0
382
- *
383
- *
384
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
385
- * https://openapi-generator.tech
386
- * Do not edit the class manually.
387
- */
388
- /**
389
- * All image characteristics that can be assessed during face image quality assessment.
390
- * @export
391
- * @enum {string}
392
- */
393
- export const FaceQualityConfigName: {
394
- readonly IMAGE_WIDTH: "ImageWidth";
395
- readonly IMAGE_HEIGHT: "ImageHeight";
396
- readonly IMAGE_WIDTH_TO_HEIGHT: "ImageWidthToHeight";
397
- readonly IMAGE_CHANNELS_NUMBER: "ImageChannelsNumber";
398
- readonly PADDING_RATIO: "PaddingRatio";
399
- readonly FACE_MID_POINT_HORIZONTAL_POSITION: "FaceMidPointHorizontalPosition";
400
- readonly FACE_MID_POINT_VERTICAL_POSITION: "FaceMidPointVerticalPosition";
401
- readonly HEAD_WIDTH_RATIO: "HeadWidthRatio";
402
- readonly HEAD_HEIGHT_RATIO: "HeadHeightRatio";
403
- readonly EYES_DISTANCE: "EyesDistance";
404
- readonly YAW: "Yaw";
405
- readonly PITCH: "Pitch";
406
- readonly ROLL: "Roll";
407
- readonly BLUR_LEVEL: "BlurLevel";
408
- readonly NOISE_LEVEL: "NoiseLevel";
409
- readonly EYE_RIGHT_CLOSED: "EyeRightClosed";
410
- readonly EYE_LEFT_CLOSED: "EyeLeftClosed";
411
- readonly EYE_RIGHT_OCCLUDED: "EyeRightOccluded";
412
- readonly EYE_LEFT_OCCLUDED: "EyeLeftOccluded";
413
- readonly EYES_RED: "EyesRed";
414
- readonly EYE_RIGHT_COVERED_WITH_HAIR: "EyeRightCoveredWithHair";
415
- readonly EYE_LEFT_COVERED_WITH_HAIR: "EyeLeftCoveredWithHair";
416
- readonly OFF_GAZE: "OffGaze";
417
- readonly FACE_DYNAMIC_RANGE: "FaceDynamicRange";
418
- readonly UNNATURAL_SKIN_TONE: "UnnaturalSkinTone";
419
- readonly TOO_DARK: "TooDark";
420
- readonly TOO_LIGHT: "TooLight";
421
- readonly FACE_GLARE: "FaceGlare";
422
- readonly SHADOWS_ON_FACE: "ShadowsOnFace";
423
- readonly DARK_GLASSES: "DarkGlasses";
424
- readonly REFLECTION_ON_GLASSES: "ReflectionOnGlasses";
425
- readonly FRAMES_TOO_HEAVY: "FramesTooHeavy";
426
- readonly FACE_OCCLUDED: "FaceOccluded";
427
- readonly HEAD_COVERING: "HeadCovering";
428
- readonly BACKGROUND_UNIFORMITY: "BackgroundUniformity";
429
- readonly SHADOWS_ON_BACKGROUND: "ShadowsOnBackground";
430
- readonly OTHER_FACES: "OtherFaces";
431
- readonly SHOULDERS_POSE: "ShouldersPose";
432
- readonly EXPRESSION_LEVEL: "ExpressionLevel";
433
- readonly MOUTH_OPEN: "MouthOpen";
434
- readonly FOREHEAD_COVERING: "ForeheadCovering";
435
- readonly SMILE: "Smile";
436
- readonly STRONG_MAKEUP: "StrongMakeup";
437
- readonly HEADPHONES: "Headphones";
438
- readonly MEDICAL_MASK: "MedicalMask";
439
- readonly BACKGROUND_COLOR_MATCH: "BackgroundColorMatch";
440
- readonly ART_FACE: "ArtFace";
441
- readonly CONTACT_LENSES: "ContactLenses";
442
- };
443
- export type FaceQualityConfigName = (typeof FaceQualityConfigName)[keyof typeof FaceQualityConfigName];
444
- /**
445
- * Regula FaceSDK Web API
446
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
608
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
447
609
  *
448
- * The version of the OpenAPI document: 5.2.0
610
+ * The version of the OpenAPI document: 6.1.0
449
611
  *
450
612
  *
451
613
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -470,9 +632,9 @@ export const FaceImageQualityGroups: {
470
632
  export type FaceImageQualityGroups = (typeof FaceImageQualityGroups)[keyof typeof FaceImageQualityGroups];
471
633
  /**
472
634
  * Regula FaceSDK Web API
473
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
635
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
474
636
  *
475
- * The version of the OpenAPI document: 5.2.0
637
+ * The version of the OpenAPI document: 6.1.0
476
638
  *
477
639
  *
478
640
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -529,9 +691,9 @@ export interface QualityDetail {
529
691
  }
530
692
  /**
531
693
  * Regula FaceSDK Web API
532
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
694
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
533
695
  *
534
- * The version of the OpenAPI document: 5.2.0
696
+ * The version of the OpenAPI document: 6.1.0
535
697
  *
536
698
  *
537
699
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -717,9 +879,9 @@ export interface DetectResponseAllOf {
717
879
  }
718
880
  /**
719
881
  * Regula FaceSDK Web API
720
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
882
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
721
883
  *
722
- * The version of the OpenAPI document: 5.2.0
884
+ * The version of the OpenAPI document: 6.1.0
723
885
  *
724
886
  *
725
887
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -793,9 +955,9 @@ export interface FaceSDKResult {
793
955
  export type DetectResponse = DetectResponseAllOf & FaceSDKResult;
794
956
  /**
795
957
  * Regula FaceSDK Web API
796
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
958
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
797
959
  *
798
- * The version of the OpenAPI document: 5.2.0
960
+ * The version of the OpenAPI document: 6.1.0
799
961
  *
800
962
  *
801
963
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -838,12 +1000,18 @@ export interface DetectionFace {
838
1000
  * @memberof DetectionFace
839
1001
  */
840
1002
  'thumbnail'?: string;
1003
+ /**
1004
+ * Base64 of the cropped portrait.
1005
+ * @type {string}
1006
+ * @memberof DetectionFace
1007
+ */
1008
+ 'crop'?: string;
841
1009
  }
842
1010
  /**
843
1011
  * Regula FaceSDK Web API
844
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1012
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
845
1013
  *
846
- * The version of the OpenAPI document: 5.2.0
1014
+ * The version of the OpenAPI document: 6.1.0
847
1015
  *
848
1016
  *
849
1017
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -883,9 +1051,9 @@ export interface PersonAllOf {
883
1051
  }
884
1052
  /**
885
1053
  * Regula FaceSDK Web API
886
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1054
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
887
1055
  *
888
- * The version of the OpenAPI document: 5.2.0
1056
+ * The version of the OpenAPI document: 6.1.0
889
1057
  *
890
1058
  *
891
1059
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -898,18 +1066,12 @@ export interface PersonAllOf {
898
1066
  * @interface PersonFields
899
1067
  */
900
1068
  export interface PersonFields {
901
- /**
902
- * Session identificator.
903
- * @type {string}
904
- * @memberof PersonFields
905
- */
906
- 'tag'?: string;
907
1069
  /**
908
1070
  * Person name.
909
1071
  * @type {string}
910
1072
  * @memberof PersonFields
911
1073
  */
912
- 'name'?: string;
1074
+ 'name': string;
913
1075
  /**
914
1076
  * A free-form object containing person\'s extended attributes.
915
1077
  * @type {{ [key: string]: object; }}
@@ -933,9 +1095,9 @@ export interface PersonFields {
933
1095
  export type Person = PersonAllOf & PersonFields;
934
1096
  /**
935
1097
  * Regula FaceSDK Web API
936
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1098
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
937
1099
  *
938
- * The version of the OpenAPI document: 5.2.0
1100
+ * The version of the OpenAPI document: 6.1.0
939
1101
  *
940
1102
  *
941
1103
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -995,9 +1157,9 @@ export interface Image {
995
1157
  }
996
1158
  /**
997
1159
  * Regula FaceSDK Web API
998
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1160
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
999
1161
  *
1000
- * The version of the OpenAPI document: 5.2.0
1162
+ * The version of the OpenAPI document: 6.1.0
1001
1163
  *
1002
1164
  *
1003
1165
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1072,9 +1234,9 @@ export interface FacesResponseAllOf {
1072
1234
  export type FacesResponse = DetectionFace & FacesResponseAllOf;
1073
1235
  /**
1074
1236
  * Regula FaceSDK Web API
1075
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1237
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1076
1238
  *
1077
- * The version of the OpenAPI document: 5.2.0
1239
+ * The version of the OpenAPI document: 6.1.0
1078
1240
  *
1079
1241
  *
1080
1242
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1102,9 +1264,9 @@ export interface GroupAllOf {
1102
1264
  }
1103
1265
  /**
1104
1266
  * Regula FaceSDK Web API
1105
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1267
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1106
1268
  *
1107
- * The version of the OpenAPI document: 5.2.0
1269
+ * The version of the OpenAPI document: 6.1.0
1108
1270
  *
1109
1271
  *
1110
1272
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1112,27 +1274,21 @@ export interface GroupAllOf {
1112
1274
  * Do not edit the class manually.
1113
1275
  */
1114
1276
  /**
1115
- * Request body of the group to create data, includes name and metadata.
1277
+ * Response group create data, includes name and metadata.
1116
1278
  * @export
1117
- * @interface GroupToCreate
1279
+ * @interface GroupResponse
1118
1280
  */
1119
- export interface GroupToCreate {
1120
- /**
1121
- * Session identificator.
1122
- * @type {string}
1123
- * @memberof GroupToCreate
1124
- */
1125
- 'tag'?: string;
1281
+ export interface GroupResponse {
1126
1282
  /**
1127
1283
  * Group to create name.
1128
1284
  * @type {string}
1129
- * @memberof GroupToCreate
1285
+ * @memberof GroupResponse
1130
1286
  */
1131
1287
  'name'?: string;
1132
1288
  /**
1133
1289
  * A free-form object containing group\'s extended attributes.
1134
1290
  * @type {{ [key: string]: object; }}
1135
- * @memberof GroupToCreate
1291
+ * @memberof GroupResponse
1136
1292
  */
1137
1293
  'metadata'?: {
1138
1294
  [key: string]: object;
@@ -1142,7 +1298,7 @@ export interface GroupToCreate {
1142
1298
  * @type Group
1143
1299
  * @export
1144
1300
  */
1145
- export type Group = GroupAllOf & GroupToCreate;
1301
+ export type Group = GroupAllOf & GroupResponse;
1146
1302
  /**
1147
1303
  *
1148
1304
  * @export
@@ -1158,9 +1314,9 @@ export interface GroupPageAllOf {
1158
1314
  }
1159
1315
  /**
1160
1316
  * Regula FaceSDK Web API
1161
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1317
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1162
1318
  *
1163
- * The version of the OpenAPI document: 5.2.0
1319
+ * The version of the OpenAPI document: 6.1.0
1164
1320
  *
1165
1321
  *
1166
1322
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1193,9 +1349,9 @@ export interface Page {
1193
1349
  export type GroupPage = GroupPageAllOf & Page;
1194
1350
  /**
1195
1351
  * Regula FaceSDK Web API
1196
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1352
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1197
1353
  *
1198
- * The version of the OpenAPI document: 5.2.0
1354
+ * The version of the OpenAPI document: 6.1.0
1199
1355
  *
1200
1356
  *
1201
1357
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1203,60 +1359,31 @@ export type GroupPage = GroupPageAllOf & Page;
1203
1359
  * Do not edit the class manually.
1204
1360
  */
1205
1361
  /**
1206
- * Set to resize the original image.
1207
- * @export
1208
- * @interface ResizeOptions
1209
- */
1210
- export interface ResizeOptions {
1211
- /**
1212
- * Resized image width, px.
1213
- * @type {number}
1214
- * @memberof ResizeOptions
1215
- */
1216
- 'width'?: number;
1217
- /**
1218
- * Resized image height, px.
1219
- * @type {number}
1220
- * @memberof ResizeOptions
1221
- */
1222
- 'height'?: number;
1223
- /**
1224
- * Resized image quality, percent.
1225
- * @type {number}
1226
- * @memberof ResizeOptions
1227
- */
1228
- 'quality'?: number;
1229
- }
1230
- /**
1231
- * Uploaded image.
1362
+ * Request body of the group to create data, includes name and metadata.
1232
1363
  * @export
1233
- * @interface ImageFieldsImage
1364
+ * @interface GroupToCreate
1234
1365
  */
1235
- export interface ImageFieldsImage {
1366
+ export interface GroupToCreate {
1236
1367
  /**
1237
- * Original media type of the uploaded image.
1368
+ * Session identificator.
1238
1369
  * @type {string}
1239
- * @memberof ImageFieldsImage
1240
- */
1241
- 'contentType'?: string;
1242
- /**
1243
- *
1244
- * @type {ImageData}
1245
- * @memberof ImageFieldsImage
1370
+ * @memberof GroupToCreate
1246
1371
  */
1247
- 'content'?: ImageData;
1372
+ 'tag'?: string;
1248
1373
  /**
1249
- * Image URL.
1374
+ * Group to create name.
1250
1375
  * @type {string}
1251
- * @memberof ImageFieldsImage
1376
+ * @memberof GroupToCreate
1252
1377
  */
1253
- 'imageUrl'?: string;
1378
+ 'name': string;
1254
1379
  /**
1255
- *
1256
- * @type {ResizeOptions}
1257
- * @memberof ImageFieldsImage
1380
+ * A free-form object containing group\'s extended attributes.
1381
+ * @type {{ [key: string]: object; }}
1382
+ * @memberof GroupToCreate
1258
1383
  */
1259
- 'resizeOptions'?: ResizeOptions;
1384
+ 'metadata': {
1385
+ [key: string]: object;
1386
+ };
1260
1387
  }
1261
1388
  /**
1262
1389
  * Image in the request data, includes image and contentType.
@@ -1272,10 +1399,10 @@ export interface ImageFields {
1272
1399
  'tag'?: string;
1273
1400
  /**
1274
1401
  *
1275
- * @type {ImageFieldsImage}
1402
+ * @type {AddImageToPersonRequestImage}
1276
1403
  * @memberof ImageFields
1277
1404
  */
1278
- 'image'?: ImageFieldsImage;
1405
+ 'image'?: AddImageToPersonRequestImage;
1279
1406
  /**
1280
1407
  *
1281
1408
  * @type {OutputImageParams}
@@ -1321,9 +1448,9 @@ export interface ImagePageAllOf {
1321
1448
  export type ImagePage = ImagePageAllOf & Page;
1322
1449
  /**
1323
1450
  * Regula FaceSDK Web API
1324
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1451
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1325
1452
  *
1326
- * The version of the OpenAPI document: 5.2.0
1453
+ * The version of the OpenAPI document: 6.1.0
1327
1454
  *
1328
1455
  *
1329
1456
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1381,63 +1508,18 @@ export interface MatchAndSearchRequestAllOf {
1381
1508
  * @memberof MatchAndSearchRequestAllOf
1382
1509
  */
1383
1510
  'images'?: Array<MatchAndSearchRequestAllOfImages>;
1384
- }
1385
- /**
1386
- * Regula FaceSDK Web API
1387
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1388
- *
1389
- * The version of the OpenAPI document: 5.2.0
1390
- *
1391
- *
1392
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1393
- * https://openapi-generator.tech
1394
- * Do not edit the class manually.
1395
- */
1396
- /**
1397
- * If a person is not found, a new person entry is created using the descriptor calculated while searching.
1398
- * @export
1399
- * @interface SearchParametersCreatePerson
1400
- */
1401
- export interface SearchParametersCreatePerson {
1402
- /**
1403
- * Person\'s name.
1404
- * @type {string}
1405
- * @memberof SearchParametersCreatePerson
1406
- */
1407
- 'name'?: string;
1408
- /**
1409
- * A free-form object containing person\'s extended attributes.
1410
- * @type {{ [key: string]: object; }}
1411
- * @memberof SearchParametersCreatePerson
1412
- */
1413
- 'metadata'?: {
1414
- [key: string]: object;
1415
- };
1416
- }
1417
- /**
1418
- * Request search data.
1419
- * @export
1420
- * @interface SearchParameters
1421
- */
1422
- export interface SearchParameters {
1423
- /**
1424
- *
1425
- * @type {SearchParametersCreatePerson}
1426
- * @memberof SearchParameters
1427
- */
1428
- 'createPerson'?: SearchParametersCreatePerson;
1429
1511
  /**
1430
1512
  * IDs of the groups in which the search is performed.
1431
- * @type {Array<number>}
1432
- * @memberof SearchParameters
1513
+ * @type {Array<string>}
1514
+ * @memberof MatchAndSearchRequestAllOf
1433
1515
  */
1434
- 'groupIds'?: Array<number>;
1516
+ 'groupIds'?: Array<string>;
1435
1517
  }
1436
1518
  /**
1437
1519
  * @type MatchAndSearchRequest
1438
1520
  * @export
1439
1521
  */
1440
- export type MatchAndSearchRequest = MatchAndSearchRequestAllOf & SearchParameters;
1522
+ export type MatchAndSearchRequest = MatchAndSearchRequestAllOf;
1441
1523
  /**
1442
1524
  *
1443
1525
  * @export
@@ -1610,7 +1692,76 @@ export interface MatchImageDetection {
1610
1692
  * @type {FaceSDKResultCode}
1611
1693
  * @memberof MatchImageDetection
1612
1694
  */
1613
- 'status': FaceSDKResultCode;
1695
+ 'status': FaceSDKResultCode;
1696
+ }
1697
+ /**
1698
+ * Regula FaceSDK Web API
1699
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1700
+ *
1701
+ * The version of the OpenAPI document: 6.1.0
1702
+ *
1703
+ *
1704
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1705
+ * https://openapi-generator.tech
1706
+ * Do not edit the class manually.
1707
+ */
1708
+ /**
1709
+ * Whether to return the Base64 of an aligned and cropped portrait in the `crop` field.
1710
+ * @export
1711
+ * @interface MatchRequestOutputImageParamsCrop
1712
+ */
1713
+ export interface MatchRequestOutputImageParamsCrop {
1714
+ /**
1715
+ * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
1716
+ * @type {Array<number>}
1717
+ * @memberof MatchRequestOutputImageParamsCrop
1718
+ */
1719
+ 'padColor'?: Array<number>;
1720
+ /**
1721
+ * Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.
1722
+ * @type {boolean}
1723
+ * @memberof MatchRequestOutputImageParamsCrop
1724
+ */
1725
+ 'returnOriginalRect'?: boolean;
1726
+ /**
1727
+ * The resize value in case `type` matches this value. If it doesn\'t, no resize is performed.
1728
+ * @type {Array<number>}
1729
+ * @memberof MatchRequestOutputImageParamsCrop
1730
+ */
1731
+ 'size'?: Array<number>;
1732
+ /**
1733
+ * The aspect ratio according to which face alignment is performed during face detection.
1734
+ * @type {number}
1735
+ * @memberof MatchRequestOutputImageParamsCrop
1736
+ */
1737
+ 'type'?: MatchRequestOutputImageParamsCropTypeEnum;
1738
+ }
1739
+ export const MatchRequestOutputImageParamsCropTypeEnum: {
1740
+ readonly NUMBER_0: 0;
1741
+ readonly NUMBER_1: 1;
1742
+ readonly NUMBER_2: 2;
1743
+ readonly NUMBER_3: 3;
1744
+ readonly NUMBER_4: 4;
1745
+ };
1746
+ export type MatchRequestOutputImageParamsCropTypeEnum = (typeof MatchRequestOutputImageParamsCropTypeEnum)[keyof typeof MatchRequestOutputImageParamsCropTypeEnum];
1747
+ /**
1748
+ * Whether to process the uploaded image according to the indicated settings.
1749
+ * @export
1750
+ * @interface MatchRequestOutputImageParams
1751
+ */
1752
+ export interface MatchRequestOutputImageParams {
1753
+ /**
1754
+ * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
1755
+ * @type {Array<number>}
1756
+ * @memberof MatchRequestOutputImageParams
1757
+ */
1758
+ 'backgroundColor'?: Array<number>;
1759
+ /**
1760
+ *
1761
+ * @type {MatchRequestOutputImageParamsCrop}
1762
+ * @memberof MatchRequestOutputImageParams
1763
+ */
1764
+ 'crop'?: MatchRequestOutputImageParamsCrop;
1614
1765
  }
1615
1766
  /**
1616
1767
  *
@@ -1625,9 +1776,10 @@ export interface MatchRequest {
1625
1776
  */
1626
1777
  'tag'?: string;
1627
1778
  /**
1628
- * Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces.
1779
+ * Deprecated, use the `crop` field in `outputImageParams` instead.
1629
1780
  * @type {boolean}
1630
1781
  * @memberof MatchRequest
1782
+ * @deprecated
1631
1783
  */
1632
1784
  'thumbnails'?: boolean;
1633
1785
  /**
@@ -1636,6 +1788,12 @@ export interface MatchRequest {
1636
1788
  * @memberof MatchRequest
1637
1789
  */
1638
1790
  'images': Array<MatchImage>;
1791
+ /**
1792
+ *
1793
+ * @type {MatchRequestOutputImageParams}
1794
+ * @memberof MatchRequest
1795
+ */
1796
+ 'outputImageParams'?: MatchRequestOutputImageParams;
1639
1797
  }
1640
1798
  /**
1641
1799
  *
@@ -1655,6 +1813,14 @@ export interface MatchResponseAllOf {
1655
1813
  * @memberof MatchResponseAllOf
1656
1814
  */
1657
1815
  'results'?: Array<MatchImageResult>;
1816
+ /**
1817
+ * A free-form object containing person\'s extended attributes.
1818
+ * @type {{ [key: string]: object; }}
1819
+ * @memberof MatchResponseAllOf
1820
+ */
1821
+ 'metadata'?: {
1822
+ [key: string]: object;
1823
+ };
1658
1824
  }
1659
1825
  /**
1660
1826
  * @type MatchResponse
@@ -1663,9 +1829,9 @@ export interface MatchResponseAllOf {
1663
1829
  export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
1664
1830
  /**
1665
1831
  * Regula FaceSDK Web API
1666
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1832
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1667
1833
  *
1668
- * The version of the OpenAPI document: 5.2.0
1834
+ * The version of the OpenAPI document: 6.1.0
1669
1835
  *
1670
1836
  *
1671
1837
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1696,12 +1862,112 @@ export interface OperationLog {
1696
1862
  * @memberof OperationLog
1697
1863
  */
1698
1864
  'msg'?: string;
1865
+ /**
1866
+ * A free-form object containing group\'s extended attributes.
1867
+ * @type {{ [key: string]: object; }}
1868
+ * @memberof OperationLog
1869
+ */
1870
+ 'metadata'?: {
1871
+ [key: string]: object;
1872
+ };
1873
+ }
1874
+ /**
1875
+ * Regula FaceSDK Web API
1876
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1877
+ *
1878
+ * The version of the OpenAPI document: 6.1.0
1879
+ *
1880
+ *
1881
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1882
+ * https://openapi-generator.tech
1883
+ * Do not edit the class manually.
1884
+ */
1885
+ /**
1886
+ * Person Request body: name and metadata.
1887
+ * @export
1888
+ * @interface PersonToUpdateFields
1889
+ */
1890
+ export interface PersonToUpdateFields {
1891
+ /**
1892
+ * Person name.
1893
+ * @type {string}
1894
+ * @memberof PersonToUpdateFields
1895
+ */
1896
+ 'name'?: string;
1897
+ /**
1898
+ * A free-form object containing person\'s extended attributes.
1899
+ * @type {{ [key: string]: object; }}
1900
+ * @memberof PersonToUpdateFields
1901
+ */
1902
+ 'metadata'?: {
1903
+ [key: string]: object;
1904
+ };
1905
+ /**
1906
+ * Groups a person should be placed to. If no group is specified in request, a Default group is created and the person is placed to it.
1907
+ * @type {Array<string>}
1908
+ * @memberof PersonToUpdateFields
1909
+ */
1910
+ 'groups'?: Array<string>;
1911
+ }
1912
+ /**
1913
+ *
1914
+ * @export
1915
+ * @interface PersonsPageAllOf
1916
+ */
1917
+ export interface PersonsPageAllOf {
1918
+ /**
1919
+ *
1920
+ * @type {Array<Person>}
1921
+ * @memberof PersonsPageAllOf
1922
+ */
1923
+ 'items'?: Array<Person>;
1924
+ }
1925
+ /**
1926
+ * @type PersonsPage
1927
+ * @export
1928
+ */
1929
+ export type PersonsPage = Page & PersonsPageAllOf;
1930
+ /**
1931
+ * Regula FaceSDK Web API
1932
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1933
+ *
1934
+ * The version of the OpenAPI document: 6.1.0
1935
+ *
1936
+ *
1937
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1938
+ * https://openapi-generator.tech
1939
+ * Do not edit the class manually.
1940
+ */
1941
+ /**
1942
+ *
1943
+ * @export
1944
+ * @interface SearchBadParams
1945
+ */
1946
+ export interface SearchBadParams {
1947
+ /**
1948
+ *
1949
+ * @type {string}
1950
+ * @memberof SearchBadParams
1951
+ */
1952
+ 'msg'?: string;
1953
+ /**
1954
+ *
1955
+ * @type {number}
1956
+ * @memberof SearchBadParams
1957
+ */
1958
+ 'statusCode'?: number;
1959
+ /**
1960
+ *
1961
+ * @type {string}
1962
+ * @memberof SearchBadParams
1963
+ */
1964
+ 'type'?: string;
1699
1965
  }
1700
1966
  /**
1701
1967
  * Regula FaceSDK Web API
1702
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1968
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1703
1969
  *
1704
- * The version of the OpenAPI document: 5.2.0
1970
+ * The version of the OpenAPI document: 6.1.0
1705
1971
  *
1706
1972
  *
1707
1973
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1782,110 +2048,80 @@ export interface SearchDetection {
1782
2048
  'versionSDK'?: string;
1783
2049
  }
1784
2050
  /**
1785
- * Person data.
1786
- * @export
1787
- * @interface SearchPersonAllOf
1788
- */
1789
- export interface SearchPersonAllOf {
1790
- /**
1791
- *
1792
- * @type {SearchDetection}
1793
- * @memberof SearchPersonAllOf
1794
- */
1795
- 'detection'?: SearchDetection;
1796
- /**
1797
- * Array of Person images.
1798
- * @type {Array<RecognizeImage>}
1799
- * @memberof SearchPersonAllOf
1800
- */
1801
- 'images'?: Array<RecognizeImage>;
1802
- }
1803
- /**
1804
- * @type SearchPerson
1805
- * @export
2051
+ * Regula FaceSDK Web API
2052
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2053
+ *
2054
+ * The version of the OpenAPI document: 6.1.0
2055
+ *
2056
+ *
2057
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
2058
+ * https://openapi-generator.tech
2059
+ * Do not edit the class manually.
1806
2060
  */
1807
- export type SearchPerson = Person & SearchPersonAllOf;
1808
2061
  /**
1809
- *
2062
+ * If a person is not found, a new person entry is created using the descriptor calculated while searching.
1810
2063
  * @export
1811
- * @interface PersonCreatedResponse
2064
+ * @interface SearchParametersCreatePerson
1812
2065
  */
1813
- export interface PersonCreatedResponse {
1814
- /**
1815
- * Result code.
1816
- * @type {number}
1817
- * @memberof PersonCreatedResponse
1818
- */
1819
- 'code'?: number;
2066
+ export interface SearchParametersCreatePerson {
1820
2067
  /**
1821
- * Array of Person images.
1822
- * @type {Array<SearchPerson>}
1823
- * @memberof PersonCreatedResponse
2068
+ * Person\'s name.
2069
+ * @type {string}
2070
+ * @memberof SearchParametersCreatePerson
1824
2071
  */
1825
- 'persons'?: Array<SearchPerson>;
2072
+ 'name'?: string;
1826
2073
  /**
1827
2074
  * A free-form object containing person\'s extended attributes.
1828
2075
  * @type {{ [key: string]: object; }}
1829
- * @memberof PersonCreatedResponse
2076
+ * @memberof SearchParametersCreatePerson
1830
2077
  */
1831
2078
  'metadata'?: {
1832
2079
  [key: string]: object;
1833
2080
  };
1834
2081
  }
1835
2082
  /**
1836
- *
2083
+ * Request search data.
1837
2084
  * @export
1838
- * @interface PersonsPageAllOf
2085
+ * @interface SearchParameters
1839
2086
  */
1840
- export interface PersonsPageAllOf {
2087
+ export interface SearchParameters {
1841
2088
  /**
1842
2089
  *
1843
- * @type {Array<Person>}
1844
- * @memberof PersonsPageAllOf
2090
+ * @type {SearchParametersCreatePerson}
2091
+ * @memberof SearchParameters
1845
2092
  */
1846
- 'items'?: Array<Person>;
2093
+ 'createPerson'?: SearchParametersCreatePerson;
2094
+ /**
2095
+ * IDs of the groups in which the search is performed.
2096
+ * @type {Array<string>}
2097
+ * @memberof SearchParameters
2098
+ */
2099
+ 'groupIds'?: Array<string>;
1847
2100
  }
1848
2101
  /**
1849
- * @type PersonsPage
1850
- * @export
1851
- */
1852
- export type PersonsPage = Page & PersonsPageAllOf;
1853
- /**
1854
- * Regula FaceSDK Web API
1855
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1856
- *
1857
- * The version of the OpenAPI document: 5.2.0
1858
- *
1859
- *
1860
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1861
- * https://openapi-generator.tech
1862
- * Do not edit the class manually.
1863
- */
1864
- /**
1865
- *
2102
+ * Person data.
1866
2103
  * @export
1867
- * @interface SearchBadParams
2104
+ * @interface SearchPersonAllOf
1868
2105
  */
1869
- export interface SearchBadParams {
1870
- /**
1871
- *
1872
- * @type {string}
1873
- * @memberof SearchBadParams
1874
- */
1875
- 'msg'?: string;
2106
+ export interface SearchPersonAllOf {
1876
2107
  /**
1877
2108
  *
1878
- * @type {number}
1879
- * @memberof SearchBadParams
2109
+ * @type {SearchDetection}
2110
+ * @memberof SearchPersonAllOf
1880
2111
  */
1881
- 'statusCode'?: number;
2112
+ 'detection'?: SearchDetection;
1882
2113
  /**
1883
- *
1884
- * @type {string}
1885
- * @memberof SearchBadParams
2114
+ * Array of Person images.
2115
+ * @type {Array<RecognizeImage>}
2116
+ * @memberof SearchPersonAllOf
1886
2117
  */
1887
- 'type'?: string;
2118
+ 'images'?: Array<RecognizeImage>;
1888
2119
  }
2120
+ /**
2121
+ * @type SearchPerson
2122
+ * @export
2123
+ */
2124
+ export type SearchPerson = Person & SearchPersonAllOf;
1889
2125
  /**
1890
2126
  * @type SearchRequest
1891
2127
  * @export
@@ -1898,23 +2134,61 @@ export type SearchRequest = ImageFields & SearchParameters;
1898
2134
  */
1899
2135
  export interface SearchResult {
1900
2136
  /**
1901
- * Search result code.
2137
+ * Result code. It is returned only with response 200.
1902
2138
  * @type {number}
1903
2139
  * @memberof SearchResult
1904
2140
  */
1905
2141
  'code'?: number;
1906
2142
  /**
1907
- * Person data.
2143
+ * Array of Person images. It is returned only with response 200.
1908
2144
  * @type {Array<SearchPerson>}
1909
2145
  * @memberof SearchResult
1910
2146
  */
1911
2147
  'persons'?: Array<SearchPerson>;
2148
+ /**
2149
+ * Person ID. The list of persons is sorted by decreasing ID value.
2150
+ * @type {string}
2151
+ * @memberof SearchResult
2152
+ */
2153
+ 'id'?: string | null;
2154
+ /**
2155
+ * Person creation date.
2156
+ * @type {string}
2157
+ * @memberof SearchResult
2158
+ */
2159
+ 'createdAt'?: string | null;
2160
+ /**
2161
+ * Person update date.
2162
+ * @type {string}
2163
+ * @memberof SearchResult
2164
+ */
2165
+ 'updatedAt'?: string | null;
2166
+ /**
2167
+ * List of groups this person belongs to.
2168
+ * @type {Array<string>}
2169
+ * @memberof SearchResult
2170
+ */
2171
+ 'groups'?: Array<string> | null;
2172
+ /**
2173
+ * Person name.
2174
+ * @type {string}
2175
+ * @memberof SearchResult
2176
+ */
2177
+ 'name'?: string | null;
2178
+ /**
2179
+ * A free-form object containing person\'s extended attributes. Available when a person is being created
2180
+ * @type {{ [key: string]: object; }}
2181
+ * @memberof SearchResult
2182
+ */
2183
+ 'metadata'?: {
2184
+ [key: string]: object;
2185
+ } | null;
1912
2186
  }
1913
2187
  /**
1914
2188
  * Regula FaceSDK Web API
1915
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2189
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1916
2190
  *
1917
- * The version of the OpenAPI document: 5.2.0
2191
+ * The version of the OpenAPI document: 6.1.0
1918
2192
  *
1919
2193
  *
1920
2194
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1952,25 +2226,21 @@ export interface TransactionInfo {
1952
2226
  */
1953
2227
  'transactionId'?: string;
1954
2228
  /**
1955
- * Link to the session video.
2229
+ * Link to the session video, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
1956
2230
  * @type {string}
1957
2231
  * @memberof TransactionInfo
1958
2232
  */
1959
2233
  'video'?: string;
1960
- /**
1961
- * List of base64 images
1962
- * @type {Array<string>}
1963
- * @memberof TransactionInfo
1964
- */
1965
- 'images'?: Array<string>;
1966
2234
  /**
1967
2235
  * Approximate age with an accuracy of +/-3 years.
1968
- * @type {number}
2236
+ * @type {Array<{ [key: string]: object; }>}
1969
2237
  * @memberof TransactionInfo
1970
2238
  */
1971
- 'estimatedAge'?: number;
2239
+ 'age'?: Array<{
2240
+ [key: string]: object;
2241
+ }>;
1972
2242
  /**
1973
- * Link to the portrait.
2243
+ * Link to the portrait, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
1974
2244
  * @type {string}
1975
2245
  * @memberof TransactionInfo
1976
2246
  */
@@ -1986,9 +2256,9 @@ export interface TransactionInfo {
1986
2256
  }
1987
2257
  /**
1988
2258
  * Regula FaceSDK Web API
1989
- * Regula FaceSDK Web API # Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
2259
+ * [Download OpenAPI specification](https://github.com/regulaforensics/FaceSDK-web-openapi) ### Clients * [JavaScript](https://github.com/regulaforensics/FaceSDK-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/FaceSDK-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/FaceSDK-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/FaceSDK-web-csharp-client) client for .NET & .NET Core
1990
2260
  *
1991
- * The version of the OpenAPI document: 5.2.0
2261
+ * The version of the OpenAPI document: 6.1.0
1992
2262
  *
1993
2263
  *
1994
2264
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2020,17 +2290,17 @@ type TDetection = {
2020
2290
  * @type {ImageData}
2021
2291
  * @memberof Detection
2022
2292
  */
2023
- 'crop'?: ImageData;
2293
+ crop?: ImageData;
2024
2294
  /**
2025
2295
  *
2026
2296
  * @memberof Detection
2027
2297
  */
2028
- 'attributes'?: {
2298
+ attributes?: {
2029
2299
  /**
2030
2300
  *
2031
2301
  * @type {Array<{ name?: string; confidence?: number; value?: any; }>}
2032
2302
  */
2033
- 'details'?: {
2303
+ details?: {
2034
2304
  name?: string;
2035
2305
  confidence?: number;
2036
2306
  value?: any;
@@ -2039,32 +2309,32 @@ type TDetection = {
2039
2309
  * The elapsed time for attribute detection.
2040
2310
  * @type {number}
2041
2311
  */
2042
- 'elapsedTime'?: number;
2312
+ elapsedTime?: number;
2043
2313
  };
2044
2314
  /**
2045
2315
  * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
2046
2316
  * @type {Array<Array<number>>}
2047
2317
  * @memberof Detection
2048
2318
  */
2049
- 'landmarks': Array<Array<number>>;
2319
+ landmarks: Array<Array<number>>;
2050
2320
  /**
2051
2321
  *
2052
2322
  * @type {DetectionQuality}
2053
2323
  * @memberof Detection
2054
2324
  */
2055
- 'quality'?: DetectionQuality;
2325
+ quality?: DetectionQuality;
2056
2326
  /**
2057
2327
  * The rectangular area of a detected face that is represented by a set of four elements: the X and Y coordinates of the top-left point, and the width and height dimensions of the rectangle.
2058
2328
  * @type {Array<number>}
2059
2329
  * @memberof Detection
2060
2330
  */
2061
- 'roi': Array<number>;
2331
+ roi: Array<number>;
2062
2332
  /**
2063
2333
  * Base64 of the cropped portrait.
2064
2334
  * @type {string}
2065
2335
  * @memberof Detection
2066
2336
  */
2067
- 'thumbnail'?: string;
2337
+ thumbnail?: string;
2068
2338
  };
2069
2339
  type TDetectResponse = {
2070
2340
  results?: {
@@ -2073,31 +2343,31 @@ type TDetectResponse = {
2073
2343
  * @type {Array<Detection>}
2074
2344
  * @memberof DetectResult
2075
2345
  */
2076
- 'detections': Array<TDetection>;
2346
+ detections: Array<TDetection>;
2077
2347
  /**
2078
2348
  * Internal.
2079
2349
  * @type {number}
2080
2350
  * @memberof DetectResult
2081
2351
  */
2082
- 'detectorType'?: number;
2352
+ detectorType?: number;
2083
2353
  /**
2084
2354
  * Internal.
2085
2355
  * @type {number}
2086
2356
  * @memberof DetectResult
2087
2357
  */
2088
- 'landmarksType'?: number;
2358
+ landmarksType?: number;
2089
2359
  /**
2090
2360
  *
2091
2361
  * @type {FaceQualityScenarios}
2092
2362
  * @memberof DetectResult
2093
2363
  */
2094
- 'scenario'?: FaceQualityScenarios;
2364
+ scenario?: FaceQualityScenarios;
2095
2365
  /**
2096
2366
  * The total time taken for the detection.
2097
2367
  * @type {number}
2098
2368
  * @memberof DetectResult
2099
2369
  */
2100
- 'timer'?: number;
2370
+ timer?: number;
2101
2371
  };
2102
2372
  } & FaceSDKResult;
2103
2373
  declare class MatchingApi {