@regulaforensics/facesdk-webclient 8.3.689-nightly → 8.3.690-nightly

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.
package/dist/index.d.ts DELETED
@@ -1,1569 +0,0 @@
1
- import { AxiosInstance } from 'axios';
2
- import { AxiosRequestConfig } from 'axios';
3
-
4
- /**
5
- * @type AddImageToPersonRequest
6
- * Image in the request data, includes image and contentType.
7
- */
8
- export declare type AddImageToPersonRequest = AddImageToPersonRequestData & TransactionLabels;
9
-
10
- export declare interface AddImageToPersonRequestData {
11
- /**
12
- * Session identificator.
13
- */
14
- 'tag'?: string;
15
- 'image': AddImageToPersonRequestImage;
16
- /**
17
- * The similarity threshold.
18
- */
19
- 'threshold'?: number;
20
- /**
21
- * The maximum number of results to be returned.
22
- */
23
- 'limit'?: number;
24
- }
25
-
26
- /**
27
- * Uploaded image.
28
- */
29
- export declare interface AddImageToPersonRequestImage {
30
- /**
31
- * Original media type of the uploaded image.
32
- */
33
- 'contentType'?: string;
34
- /**
35
- * Base64-encoded image.
36
- */
37
- 'content'?: string;
38
- /**
39
- * Image URL.
40
- */
41
- 'imageUrl'?: string;
42
- 'resizeOptions'?: ResizeOptions;
43
- }
44
-
45
- /**
46
- * NOTE: This file is auto generated by OpenAPI Generator.
47
- * Do not edit the file manually.
48
- */
49
- /**
50
- * Image in the response.
51
- */
52
- export declare interface AddImageToPersonResponse {
53
- /**
54
- * Response image ID. The list is sorted by decreasing ID value.
55
- */
56
- 'id'?: string;
57
- /**
58
- * Original media type of the returned image.
59
- */
60
- 'contentType'?: string;
61
- /**
62
- * Returned image creation date.
63
- */
64
- 'createdAt'?: string;
65
- /**
66
- * Returned image path.
67
- */
68
- 'path'?: string;
69
- /**
70
- * Returned image URL.
71
- */
72
- 'url'?: string;
73
- /**
74
- * A free-form object containing person\'s extended attributes.
75
- */
76
- 'metadata'?: {
77
- [key: string]: any;
78
- };
79
- }
80
-
81
- /**
82
- * The configuration that defines the list of returned attribute check characteristics.
83
- */
84
- export declare interface AttributeConfig {
85
- 'name'?: FaceAttribute;
86
- }
87
-
88
- /**
89
- * NOTE: This file is auto generated by OpenAPI Generator.
90
- * Do not edit the file manually.
91
- */
92
- export declare interface AttributesData {
93
- /**
94
- * The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
95
- */
96
- 'value'?: Array<number>;
97
- }
98
-
99
- export declare class Configuration {
100
- /**
101
- * parameter for apiKey security
102
- * @param name security name
103
- */
104
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
105
- /**
106
- * parameter for basic security
107
- */
108
- username?: string;
109
- /**
110
- * parameter for basic security
111
- */
112
- password?: string;
113
- /**
114
- * parameter for oauth2 security
115
- * @param name security name
116
- * @param scopes oauth2 scope
117
- */
118
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
119
- /**
120
- * override base path
121
- */
122
- basePath?: string;
123
- /**
124
- * override server index
125
- */
126
- serverIndex?: number;
127
- /**
128
- * base options for axios calls
129
- */
130
- baseOptions?: any;
131
- /**
132
- * The FormData constructor that will be used to create multipart form data
133
- * requests. You can inject this here so that execution environments that
134
- * do not support the FormData class can still run the generated client.
135
- *
136
- * @type {new () => FormData}
137
- */
138
- formDataCtor?: new () => any;
139
- constructor(param?: ConfigurationParameters);
140
- /**
141
- * Check if the given MIME is a JSON MIME.
142
- * JSON MIME examples:
143
- * application/json
144
- * application/json; charset=UTF8
145
- * APPLICATION/JSON
146
- * application/vnd.company+json
147
- * @param mime - MIME (Multipurpose Internet Mail Extensions)
148
- * @return True if the given MIME is JSON, false otherwise.
149
- */
150
- isJsonMime(mime: string): boolean;
151
- }
152
-
153
- /**
154
- * NOTE: This file is auto generated by OpenAPI Generator.
155
- * Do not edit the file manually.
156
- */
157
- export declare interface ConfigurationParameters {
158
- apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
159
- username?: string;
160
- password?: string;
161
- accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
162
- basePath?: string;
163
- serverIndex?: number;
164
- baseOptions?: any;
165
- formDataCtor?: new () => any;
166
- }
167
-
168
- /**
169
- * Whether to return a Base64-encoded image of each aligned and cropped portrait in the `crop` field. Faces are aligned to a straight vertical line based on the value in the `crop.type` field, correcting any tilt present in the original image. If the image contains multiple faces, the system will detect and process each face separately, returning individual portraits. For example, if there are five people in the photo, five processed portraits will be returned. Each portrait is available for download.
170
- */
171
- export declare interface Crop {
172
- 'type'?: FaceImageQualityAlignType;
173
- /**
174
- * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
175
- */
176
- 'padColor'?: Array<number>;
177
- /**
178
- * The resize value in case `type` matches this value. If it doesn\'t, no resize is performed.
179
- */
180
- 'size'?: Array<number>;
181
- }
182
-
183
- /**
184
- * NOTE: This file is auto generated by OpenAPI Generator.
185
- * Do not edit the file manually.
186
- */
187
- export declare interface DetailItem {
188
- /**
189
- * The name of the attribute.
190
- */
191
- 'name'?: string;
192
- }
193
-
194
- /**
195
- * @type DetectAttributesDetails
196
- */
197
- export declare type DetectAttributesDetails = AttributesData & DetailItem;
198
-
199
- /**
200
- * @type DetectDetailsMeta
201
- */
202
- export declare type DetectDetailsMeta = DetailItem & DetectMetaData;
203
-
204
- export declare interface Detection {
205
- /**
206
- * Base64-encoded image.
207
- */
208
- 'crop'?: string;
209
- 'attributes'?: DetectionAttributes;
210
- /**
211
- * Absolute coordinates (X,Y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
212
- */
213
- 'landmarks': Array<Array<number>>;
214
- 'quality'?: DetectionQuality;
215
- /**
216
- * 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.
217
- */
218
- 'roi': Array<number>;
219
- }
220
-
221
- /**
222
- * The evaluated attributes, see the [Attributes List](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/) for details.
223
- */
224
- export declare interface DetectionAttributes {
225
- /**
226
- * Attributes assessment details. Returns `DetectDetailsMeta` or `DetectAttributesDetails`.
227
- */
228
- 'details'?: Array<DetectionAttributesDetailsInner>;
229
- /**
230
- * Server processing time for attribute detection, ms.
231
- */
232
- 'elapsedTime'?: number;
233
- }
234
-
235
- /**
236
- * @type DetectionAttributesDetailsInner
237
- */
238
- export declare type DetectionAttributesDetailsInner = DetectAttributesDetails | DetectDetailsMeta;
239
-
240
- /**
241
- * NOTE: This file is auto generated by OpenAPI Generator.
242
- * Do not edit the file manually.
243
- */
244
- export declare interface DetectionFace {
245
- /**
246
- * The detected face index number.
247
- */
248
- 'faceIndex'?: number;
249
- /**
250
- * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
251
- */
252
- 'landmarks'?: Array<Array<number>>;
253
- /**
254
- * Angle of rotation of the face from the vertical axis, degrees.
255
- */
256
- 'rotationAngle'?: number;
257
- /**
258
- * 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.
259
- */
260
- 'roi'?: Array<number>;
261
- /**
262
- * Base64-encoded aligned and cropped portrait.
263
- */
264
- 'crop'?: string;
265
- }
266
-
267
- /**
268
- * The portrait quality assessment results, see [Face Image Quality Characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/). If not set in request, no quality check is performed.
269
- */
270
- export declare interface DetectionQuality {
271
- /**
272
- * Non-compliant assessment characteristics.
273
- */
274
- 'nonCompliant'?: Array<FaceQualityConfigName>;
275
- /**
276
- * Assessment results for each [group of characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).
277
- */
278
- 'detailsGroups'?: Array<QualityDetailsGroups>;
279
- /**
280
- * Assessment characteristics that were set in the request.
281
- */
282
- 'details'?: Array<QualityDetail>;
283
- /**
284
- * Returns the estimated portrait quality assessment result, a number from `0` to `1`, where `1` is for absolute compliance.
285
- */
286
- 'score'?: number;
287
- /**
288
- * Server processing time for quality assessment, ms.
289
- */
290
- 'elapsedTime'?: number;
291
- }
292
-
293
- /**
294
- * NOTE: This file is auto generated by OpenAPI Generator.
295
- * Do not edit the file manually.
296
- */
297
- export declare interface DetectMetaData {
298
- /**
299
- * The confidence in the estimated value, `1.0` is for 100% confidence.
300
- */
301
- 'confidence'?: number;
302
- /**
303
- * The estimated value for the attribute, see the [Returned values column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/attributes-detection/).
304
- */
305
- 'value'?: string;
306
- }
307
-
308
- /**
309
- * @type DetectRequest
310
- */
311
- export declare type DetectRequest = DetectRequestData & TransactionLabels;
312
-
313
- export declare interface DetectRequestData {
314
- /**
315
- * Session identificator, should be unique for each session.
316
- */
317
- 'tag'?: string;
318
- 'processParam'?: ProcessParam;
319
- /**
320
- * Base64-encoded image.
321
- */
322
- 'image'?: string;
323
- }
324
-
325
- /**
326
- * @type DetectResponse
327
- */
328
- export declare type DetectResponse = DetectResponseResults & FaceSDKResult;
329
-
330
- export declare interface DetectResponseResults {
331
- 'results'?: DetectResult;
332
- }
333
-
334
- /**
335
- * The detection results.
336
- */
337
- export declare interface DetectResult {
338
- /**
339
- * The array of performed checks.
340
- */
341
- 'detections': Array<Detection>;
342
- /**
343
- * Internal.
344
- */
345
- 'detectorType'?: number;
346
- /**
347
- * Internal.
348
- */
349
- 'landmarksType'?: number;
350
- /**
351
- * The face detection scenario that was set in the `processParam.scenario` field of the request.
352
- */
353
- 'scenario'?: string;
354
- /**
355
- * Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
356
- */
357
- 'elapsedTime'?: number;
358
- }
359
-
360
- /**
361
- * NOTE: This file is auto generated by OpenAPI Generator.
362
- * Do not edit the file manually.
363
- */
364
- export declare interface DeviceInfo {
365
- /**
366
- * Application name.
367
- */
368
- 'app': string;
369
- /**
370
- * Unique license identifier.
371
- */
372
- 'licenseId': string | null;
373
- /**
374
- * License serial number.
375
- */
376
- 'licenseSerial': string | null;
377
- /**
378
- * License validity date.
379
- */
380
- 'licenseValidUntil': string | null;
381
- /**
382
- * Product version.
383
- */
384
- 'version': string | null;
385
- }
386
-
387
- /**
388
- * NOTE: This file is auto generated by OpenAPI Generator.
389
- * Do not edit the file manually.
390
- */
391
- /**
392
- * The name of the attribute. For definitions, see the [FaceAttribute enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-attribute/).
393
- */
394
- export declare enum FaceAttribute {
395
- AGE = "Age",
396
- EMOTION = "Emotion",
397
- EYE_LEFT = "EyeLeft",
398
- EYE_RIGHT = "EyeRight",
399
- SMILE = "Smile",
400
- GLASSES = "Glasses",
401
- HEAD_COVERING = "HeadCovering",
402
- FOREHEAD_COVERING = "ForeheadCovering",
403
- MOUTH = "Mouth",
404
- MEDICAL_MASK = "MedicalMask",
405
- OCCLUSION = "Occlusion",
406
- STRONG_MAKEUP = "StrongMakeup",
407
- HEADPHONES = "Headphones"
408
- }
409
-
410
- /**
411
- * NOTE: This file is auto generated by OpenAPI Generator.
412
- * Do not edit the file manually.
413
- */
414
- /**
415
- * The aspect ratio according to which face alignment is performed. See the [FaceImageQualityAlignType enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-align-type/). To get a thumbnail with aspect ratio 3:4, set `0`.
416
- */
417
- export declare enum FaceImageQualityAlignType {
418
- ALIGN_3x4 = 0,
419
- ALIGN_4x5 = 1,
420
- ALIGN_2x3 = 2,
421
- ALIGN_1x1 = 3,
422
- ALIGN_7x9 = 4
423
- }
424
-
425
- /**
426
- * NOTE: This file is auto generated by OpenAPI Generator.
427
- * Do not edit the file manually.
428
- */
429
- /**
430
- * The group ID of the characteristic, see the [FaceImageQualityGroups enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/) for details.
431
- */
432
- export declare enum FaceImageQualityGroups {
433
- IMAGE_CHARACTERISTICS = 1,
434
- HEAD_SIZE_AND_POSITIONS = 2,
435
- FACE_QUALITY = 3,
436
- EYES_CHARACTERISTICS = 4,
437
- SHADOWS_AND_LIGHTNING = 5,
438
- POSE_AND_EXPRESSION = 6,
439
- HEAD_OCCLUSION = 7,
440
- BACKGROUND = 8
441
- }
442
-
443
- /**
444
- * NOTE: This file is auto generated by OpenAPI Generator.
445
- * Do not edit the file manually.
446
- */
447
- /**
448
- * Face image quality assessment group name, see [FaceImageQualityGroups](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-groups/).
449
- */
450
- export declare enum FaceImageQualityGroupsStrings {
451
- IMAGE_CHARACTERISTICS = "ImageCharacteristics",
452
- HEAD_SIZE_AND_POSITIONS = "HeadSizeAndPosition",
453
- FACE_QUALITY = "FaceQuality",
454
- EYES_CHARACTERISTICS = "EyesCharacteristics",
455
- SHADOWS_AND_LIGHTNING = "ShadowsAndLightning",
456
- POSE_AND_EXPRESSION = "PoseAndExpression",
457
- HEAD_OCCLUSION = "HeadOcclusion",
458
- BACKGROUND = "Background"
459
- }
460
-
461
- /**
462
- * NOTE: This file is auto generated by OpenAPI Generator.
463
- * Do not edit the file manually.
464
- */
465
- /**
466
- * The processing status returned for each quality characteristic, see the [FaceImageQualityStatus enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-image-quality-status/).
467
- */
468
- export declare enum FaceImageQualityStatus {
469
- QUALITY_STATUS_FALSE = 0,
470
- QUALITY_STATUS_TRUE = 1,
471
- QUALITY_STATUS_UNDETERMINED = 2
472
- }
473
-
474
- /**
475
- * NOTE: This file is auto generated by OpenAPI Generator.
476
- * Do not edit the file manually.
477
- */
478
- /**
479
- * The name of the characteristic. For definitions, see the [FaceQualityConfigName enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-quality-config-name/).
480
- */
481
- export declare enum FaceQualityConfigName {
482
- IMAGE_WIDTH = "ImageWidth",
483
- IMAGE_HEIGHT = "ImageHeight",
484
- IMAGE_WIDTH_TO_HEIGHT = "ImageWidthToHeight",
485
- IMAGE_CHANNELS_NUMBER = "ImageChannelsNumber",
486
- PADDING_RATIO = "PaddingRatio",
487
- FACE_MID_POINT_HORIZONTAL_POSITION = "FaceMidPointHorizontalPosition",
488
- FACE_MID_POINT_VERTICAL_POSITION = "FaceMidPointVerticalPosition",
489
- HEAD_WIDTH_RATIO = "HeadWidthRatio",
490
- HEAD_HEIGHT_RATIO = "HeadHeightRatio",
491
- EYES_DISTANCE = "EyesDistance",
492
- YAW = "Yaw",
493
- PITCH = "Pitch",
494
- ROLL = "Roll",
495
- BLUR_LEVEL = "BlurLevel",
496
- NOISE_LEVEL = "NoiseLevel",
497
- EYE_RIGHT_CLOSED = "EyeRightClosed",
498
- EYE_LEFT_CLOSED = "EyeLeftClosed",
499
- EYE_RIGHT_OCCLUDED = "EyeRightOccluded",
500
- EYE_LEFT_OCCLUDED = "EyeLeftOccluded",
501
- EYES_RED = "EyesRed",
502
- EYE_RIGHT_COVERED_WITH_HAIR = "EyeRightCoveredWithHair",
503
- EYE_LEFT_COVERED_WITH_HAIR = "EyeLeftCoveredWithHair",
504
- OFF_GAZE = "OffGaze",
505
- FACE_DYNAMIC_RANGE = "FaceDynamicRange",
506
- UNNATURAL_SKIN_TONE = "UnnaturalSkinTone",
507
- TOO_DARK = "TooDark",
508
- TOO_LIGHT = "TooLight",
509
- FACE_GLARE = "FaceGlare",
510
- SHADOWS_ON_FACE = "ShadowsOnFace",
511
- DARK_GLASSES = "DarkGlasses",
512
- REFLECTION_ON_GLASSES = "ReflectionOnGlasses",
513
- FRAMES_TOO_HEAVY = "FramesTooHeavy",
514
- FACE_OCCLUDED = "FaceOccluded",
515
- HEAD_COVERING = "HeadCovering",
516
- BACKGROUND_UNIFORMITY = "BackgroundUniformity",
517
- SHADOWS_ON_BACKGROUND = "ShadowsOnBackground",
518
- OTHER_FACES = "OtherFaces",
519
- SHOULDERS_POSE = "ShouldersPose",
520
- EXPRESSION_LEVEL = "ExpressionLevel",
521
- MOUTH_OPEN = "MouthOpen",
522
- FOREHEAD_COVERING = "ForeheadCovering",
523
- SMILE = "Smile",
524
- STRONG_MAKEUP = "StrongMakeup",
525
- HEADPHONES = "Headphones",
526
- MEDICAL_MASK = "MedicalMask",
527
- BACKGROUND_COLOR_MATCH = "BackgroundColorMatch",
528
- ART_FACE = "ArtFace",
529
- CONTACT_LENSES = "ContactLenses"
530
- }
531
-
532
- /**
533
- * NOTE: This file is auto generated by OpenAPI Generator.
534
- * Do not edit the file manually.
535
- */
536
- /**
537
- * Face detection scenario. If set and the scenario is found, it automatically applies the relevant parameters, overriding any other parameters specified in the request. If the scenario is not set, is empty, or the name is not recognized, processing will follow the parameters directly set in the request. For detailed descriptions of available scenarios, refer to the [Scenarios page](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/scenarios/).
538
- */
539
- export declare enum FaceQualityScenarios {
540
- OLD_MODE = "OldMode",
541
- QUALITY_FULL = "QualityFull",
542
- QUALITY_ICAO = "QualityICAO",
543
- QUALITY_VISA_SCHENGEN = "QualityVisaSchengen",
544
- QUALITY_VISA_USA = "QualityVisaUSA",
545
- CROP_CENTRAL_FACE = "CropCentralFace",
546
- CROP_ALL_FACES = "CropAllFaces",
547
- THUMBNAIL = "Thumbnail",
548
- ATTRIBUTES_ALL = "AttributesAll",
549
- EMPTY = ""
550
- }
551
-
552
- export declare class FaceSdk {
553
- protected basePath: string;
554
- protected axios: AxiosInstance;
555
- matchApi: MatchApi;
556
- groupApi: GroupApi;
557
- personApi: PersonApi;
558
- searchApi: SearchApi;
559
- livenessApi: Liveness20Api;
560
- healthcheckApi: HealthcheckApi;
561
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
562
- }
563
-
564
- export declare interface FaceSDKResult {
565
- 'code': FaceSDKResultCode;
566
- }
567
-
568
- /**
569
- * NOTE: This file is auto generated by OpenAPI Generator.
570
- * Do not edit the file manually.
571
- */
572
- /**
573
- * The result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
574
- */
575
- export declare enum FaceSDKResultCode {
576
- FACER_OK = 0,
577
- FR_IMAGE_EMPTY = 1,
578
- FR_FACE_NOT_DETECTED = 2,
579
- FR_LANDMARKS_NOT_DETECTED = 3,
580
- FR_FACE_ALIGHNER_FAILED = 4,
581
- FR_DESCRIPTOR_EXTRACTOR_ERROR = 5,
582
- FR_IMAGE_DECODE_ERROR = 6,
583
- FR_INTERNAL_ERROR = 7,
584
- FACER_CONFIG_ERROR = 199,
585
- FACER_NO_LICENSE = 200,
586
- FACER_IS_NOT_INITIALIZED = 201,
587
- FACER_COMMAND_IS_NOT_SUPPORTED = 202,
588
- FACER_COMMAND_PARAMS_READ_ERROR = 203,
589
- FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST = 224,
590
- FACER_VIDEO_DECODE_ERROR = 227,
591
- FACER_NOT_ENOUGH_FRAMES = 228,
592
- FACER_OUTPUT_IS_NOT_DEFINED = 229,
593
- FACER_CLOSED_EYES_DETECTED = 230,
594
- FACER_LOW_QUALITY = 231,
595
- FACER_HIGH_ASYMMETRY = 232,
596
- FACER_FACE_OVER_EMOTIONAL = 233,
597
- FACER_SUNGLASSES_DETECTED = 234,
598
- FACER_SMALL_AGE = 235,
599
- FACER_HEADDRESS_DETECTED = 236,
600
- FACER_FACES_NOT_MATCHED = 237,
601
- FACER_IMAGES_COUNT_LIMIT_EXCEEDED = 238,
602
- FACER_MEDICINE_MASK_DETECTED = 239,
603
- FACER_OCCLUSION_DETECTED = 240,
604
- FACER_FOREHEAD_GLASSES_DETECTED = 242,
605
- FACER_MOUTH_OPENED = 243,
606
- FACER_ART_MASK_DETECTED = 244,
607
- FACER_ELECTRONIC_DEVICE_DETECTED = 245,
608
- FACER_TRACK_BREAK = 246,
609
- FACER_WRONG_GEO = 247,
610
- FACER_WRONG_OF = 248,
611
- FACER_WRONG_VIEW = 249,
612
- FACER_TIMEOUT_LIVENESS_TRANSACTION = 250,
613
- FACER_FAILED_LIVENESS_TRANSACTION = 251,
614
- FACER_ABORTED_LIVENESS_TRANSACTION = 252,
615
- FACER_GENERAL_ERROR = 253,
616
- FACER_PASSIVE_LIVENESS_FAIL = 254
617
- }
618
-
619
- /**
620
- * @type FacesResponse
621
- */
622
- export declare type FacesResponse = DetectionFace & FacesResponseData;
623
-
624
- export declare interface FacesResponseData {
625
- /**
626
- * Detected Persons.
627
- */
628
- 'persons'?: Array<PersonWithImages>;
629
- }
630
-
631
- /**
632
- * NOTE: This file is auto generated by OpenAPI Generator.
633
- * Do not edit the file manually.
634
- */
635
- /**
636
- * The filter condition, determines the type of comparison to be performed on the `name` values of the Person entity. <br><br>When set to `in`, the `name` values of the Person should match any of the values specified in the `value` list. <br><br>When set to `nin`, the `name` values of the Person should not match any of the values specified in the `value` list.
637
- */
638
- export declare enum FilterOp {
639
- IN = "in",
640
- NOT_IN = "nin"
641
- }
642
-
643
- /**
644
- * Allows to filter the search results based on the Person\'s `name`. If enabled, only the search results that meet the filter condition will be returned.
645
- */
646
- export declare interface FilterSearchRequest {
647
- 'op'?: FilterOp;
648
- /**
649
- * `name` of the Person.
650
- */
651
- 'field'?: string;
652
- /**
653
- * The list of `name` values against which the `field` is compared.
654
- */
655
- 'value'?: Array<string>;
656
- }
657
-
658
- /**
659
- * @type Group
660
- */
661
- export declare type Group = GroupData & GroupResponse;
662
-
663
- export declare class GroupApi {
664
- private superClass;
665
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
666
- createGroup(groupToCreate: GroupToCreate, xRequestID?: string, options?: AxiosRequestConfig): Promise<Group>;
667
- deleteGroup(groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
668
- getAllGroups(page: number, size: number, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
669
- getAllPersonsByGroupId(page: number, size: number, groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<PersonsPage>;
670
- getGroup(groupId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<Group>;
671
- updateGroup(groupId: string, groupToCreate: GroupToCreate, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
672
- updatePersonsInGroup(groupId: string, updateGroup: UpdateGroup, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
673
- }
674
-
675
- /**
676
- * NOTE: This file is auto generated by OpenAPI Generator.
677
- * Do not edit the file manually.
678
- */
679
- /**
680
- * Additional group data in the response, includes id and createdAt.
681
- */
682
- export declare interface GroupData {
683
- /**
684
- * Group ID.
685
- */
686
- 'id'?: string;
687
- /**
688
- * Group creation date.
689
- */
690
- 'createdAt'?: string;
691
- }
692
-
693
- /**
694
- * @type GroupPage
695
- */
696
- export declare type GroupPage = GroupPageItems & Page;
697
-
698
- export declare interface GroupPageItems {
699
- /**
700
- * Array of Groups that are found during the search.
701
- */
702
- 'items'?: Array<Group>;
703
- }
704
-
705
- /**
706
- * NOTE: This file is auto generated by OpenAPI Generator.
707
- * Do not edit the file manually.
708
- */
709
- /**
710
- * Response group create data, includes name and metadata.
711
- */
712
- export declare interface GroupResponse {
713
- /**
714
- * Group to create name.
715
- */
716
- 'name'?: string;
717
- /**
718
- * A free-form object containing group\'s extended attributes.
719
- */
720
- 'metadata'?: {
721
- [key: string]: any;
722
- };
723
- }
724
-
725
- /**
726
- * NOTE: This file is auto generated by OpenAPI Generator.
727
- * Do not edit the file manually.
728
- */
729
- /**
730
- * Request body of the group to create data, includes name and metadata.
731
- */
732
- export declare interface GroupToCreate {
733
- /**
734
- * Session identificator.
735
- */
736
- 'tag'?: string;
737
- /**
738
- * Group to create name.
739
- */
740
- 'name': string;
741
- /**
742
- * A free-form object containing group\'s extended attributes.
743
- */
744
- 'metadata': {
745
- [key: string]: any;
746
- };
747
- }
748
-
749
- export declare class HealthcheckApi {
750
- private superClass;
751
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
752
- healthz(xRequestID?: string, options?: AxiosRequestConfig): Promise<DeviceInfo>;
753
- readyz(xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
754
- }
755
-
756
- /**
757
- * NOTE: This file is auto generated by OpenAPI Generator.
758
- * Do not edit the file manually.
759
- */
760
- /**
761
- * Image in the response.
762
- */
763
- declare interface Image_2 {
764
- /**
765
- * Response image ID. The list is sorted by decreasing ID value.
766
- */
767
- 'id'?: string;
768
- /**
769
- * Base64-encoded image. Returned only if `withImages` is set to true in the request.
770
- */
771
- 'content'?: string;
772
- /**
773
- * Original media type of the returned image.
774
- */
775
- 'contentType'?: string;
776
- /**
777
- * Returned image creation date.
778
- */
779
- 'createdAt'?: string;
780
- /**
781
- * Returned image update date.
782
- */
783
- 'updatedAt'?: string;
784
- /**
785
- * Returned image path.
786
- */
787
- 'path'?: string;
788
- /**
789
- * Returned image URL.
790
- */
791
- 'url'?: string;
792
- /**
793
- * A free-form object containing person\'s extended attributes.
794
- */
795
- 'metadata'?: {
796
- [key: string]: any;
797
- };
798
- }
799
- export { Image_2 as Image }
800
-
801
- /**
802
- * Image in the request data, includes image and contentType.
803
- */
804
- export declare interface ImageFields {
805
- /**
806
- * Session identificator, should be unique for each session.
807
- */
808
- 'tag'?: string;
809
- 'image'?: ImageFieldsImage;
810
- 'outputImageParams'?: OutputImageParams;
811
- /**
812
- * Whether to detect all faces in the image. If set to `false`, only the most central face is detected.
813
- */
814
- 'detectAll'?: boolean;
815
- /**
816
- * The similarity threshold.
817
- */
818
- 'threshold'?: number;
819
- /**
820
- * The maximum number of results to be returned.
821
- */
822
- 'limit'?: number;
823
- }
824
-
825
- /**
826
- * Uploaded image.
827
- */
828
- export declare interface ImageFieldsImage {
829
- /**
830
- * Original media type of the uploaded image.
831
- */
832
- 'contentType'?: string;
833
- /**
834
- * Base64-encoded image.
835
- */
836
- 'content'?: string;
837
- /**
838
- * Image URL.
839
- */
840
- 'imageUrl'?: string;
841
- 'resizeOptions'?: ResizeOptions;
842
- }
843
-
844
- /**
845
- * @type ImagePage
846
- */
847
- export declare type ImagePage = ImagePageItems & Page;
848
-
849
- export declare interface ImagePageItems {
850
- 'items'?: Array<Image_2>;
851
- }
852
-
853
- /**
854
- * NOTE: This file is auto generated by OpenAPI Generator.
855
- * Do not edit the file manually.
856
- */
857
- /**
858
- * Face photo image source types: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/
859
- */
860
- export declare enum ImageSource {
861
- DOCUMENT_PRINTED = 1,
862
- DOCUMENT_RFID = 2,
863
- LIVE = 3,
864
- DOCUMENT_WITH_LIVE = 4,
865
- EXTERNAL = 5,
866
- GHOST = 6,
867
- BARCODE = 7
868
- }
869
-
870
- export declare class Liveness20Api {
871
- private superClass;
872
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
873
- getLivenessTransactionInfo(transactionId: string, options?: AxiosRequestConfig): Promise<TransactionInfo>;
874
- }
875
-
876
- /**
877
- * NOTE: This file is auto generated by OpenAPI Generator.
878
- * Do not edit the file manually.
879
- */
880
- /**
881
- * Liveness detection can be performed in two modes: active `0` and passive `1`. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/liveness/#active-and-passive-modes)
882
- */
883
- export declare enum LivenessType {
884
- ACTIVE = 0,
885
- PASSIVE = 1
886
- }
887
-
888
- export declare interface MatchAndSearchRequest {
889
- /**
890
- * Session identificator, should be unique for each session.
891
- */
892
- 'tag'?: string;
893
- /**
894
- * An array of images to be processed. At least two images must be provided.
895
- */
896
- 'images'?: Array<MatchAndSearchRequestImagesItem>;
897
- /**
898
- * IDs of the groups in which the search is performed.
899
- */
900
- 'groupIds'?: Array<string>;
901
- /**
902
- * The similarity threshold.
903
- */
904
- 'threshold'?: number;
905
- /**
906
- * The maximum number of results to be returned.
907
- */
908
- 'limit'?: number;
909
- /**
910
- * A label used to group transactions by customers, applications, or other criteria.
911
- */
912
- 'tenant'?: string;
913
- /**
914
- * A label used to differentiate transactions by development stages.
915
- */
916
- 'env'?: string;
917
- }
918
-
919
- export declare interface MatchAndSearchRequestImagesItem {
920
- /**
921
- * Base64-encoded image.
922
- */
923
- 'content'?: string;
924
- /**
925
- * Image URL.
926
- */
927
- 'imageUrl'?: string;
928
- 'type'?: ImageSource;
929
- }
930
-
931
- /**
932
- * @type MatchAndSearchResponse
933
- */
934
- export declare type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseData;
935
-
936
- export declare interface MatchAndSearchResponseData {
937
- /**
938
- * The match and search results.
939
- */
940
- 'results'?: Array<MatchImageResult>;
941
- /**
942
- * Server processing time, ms. Does not include the time taken to receive the request or deliver the response.
943
- */
944
- 'elapsedTime'?: number;
945
- /**
946
- * A free-form object containing person\'s extended attributes.
947
- */
948
- 'metadata'?: {
949
- [key: string]: any;
950
- };
951
- /**
952
- * The detection results.
953
- */
954
- 'detections'?: Array<MatchAndSearchResponseDataDetectionsItem>;
955
- }
956
-
957
- export declare interface MatchAndSearchResponseDataDetectionsItem {
958
- /**
959
- * Detected faces.
960
- */
961
- 'faces'?: Array<FacesResponse>;
962
- /**
963
- * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
964
- */
965
- 'imageIndex'?: number;
966
- 'status'?: FaceSDKResultCode;
967
- }
968
-
969
- export declare class MatchApi {
970
- private superClass;
971
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
972
- match(compareRequest: MatchRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<MatchResponse>;
973
- detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<DetectResponse>;
974
- }
975
-
976
- export declare interface MatchImage {
977
- /**
978
- * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
979
- */
980
- 'index'?: number;
981
- 'type'?: ImageSource;
982
- /**
983
- * Base64-encoded image.
984
- */
985
- 'data': string;
986
- /**
987
- * Whether to detect all faces in the image. If set to `false`, only the most central face is detected.
988
- */
989
- 'detectAll'?: boolean;
990
- }
991
-
992
- export declare interface MatchImageDetection {
993
- /**
994
- * Detected faces.
995
- */
996
- 'faces'?: Array<DetectionFace>;
997
- /**
998
- * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
999
- */
1000
- 'imageIndex': number;
1001
- 'status': FaceSDKResultCode;
1002
- }
1003
-
1004
- export declare interface MatchImageResult {
1005
- /**
1006
- * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
1007
- */
1008
- 'firstIndex': number;
1009
- /**
1010
- * The detected face index number.
1011
- */
1012
- 'firstFaceIndex'?: number;
1013
- 'first'?: ImageSource;
1014
- /**
1015
- * The image index number. Can be given; if not given, the index numbers are set automatically starting from `0`. All index numbers must be whole and unique—not repeated.
1016
- */
1017
- 'secondIndex': number;
1018
- /**
1019
- * The detected face index number.
1020
- */
1021
- 'secondFaceIndex'?: number;
1022
- 'second'?: ImageSource;
1023
- /**
1024
- * A dimensionless number that shows how similar the compared faces are. 0—absolutely identical faces.
1025
- */
1026
- 'score'?: number;
1027
- /**
1028
- * The detected faces similarity, %. 100%—absolutely identical faces, 0%—absolutely not identical.
1029
- */
1030
- 'similarity'?: number;
1031
- }
1032
-
1033
- /**
1034
- * @type MatchRequest
1035
- */
1036
- export declare type MatchRequest = MatchRequestData & TransactionLabels;
1037
-
1038
- export declare interface MatchRequestData {
1039
- /**
1040
- * Session identificator, should be unique for each session.
1041
- */
1042
- 'tag'?: string;
1043
- /**
1044
- * An array of images to be processed. At least two images must be provided.
1045
- */
1046
- 'images': Array<MatchImage>;
1047
- 'outputImageParams'?: OutputImageParams;
1048
- }
1049
-
1050
- /**
1051
- * @type MatchResponse
1052
- */
1053
- export declare type MatchResponse = FaceSDKResult & MatchResponseData;
1054
-
1055
- export declare interface MatchResponseData {
1056
- /**
1057
- * The detection results.
1058
- */
1059
- 'detections'?: Array<MatchImageDetection>;
1060
- /**
1061
- * The comparison results.
1062
- */
1063
- 'results'?: Array<MatchImageResult>;
1064
- /**
1065
- * A free-form object containing person\'s extended attributes.
1066
- */
1067
- 'metadata'?: {
1068
- [key: string]: any;
1069
- };
1070
- }
1071
-
1072
- /**
1073
- * NOTE: This file is auto generated by OpenAPI Generator.
1074
- * Do not edit the file manually.
1075
- */
1076
- export declare interface OperationLog {
1077
- /**
1078
- * Status code.
1079
- */
1080
- 'statusCode'?: number;
1081
- /**
1082
- * Error type.
1083
- */
1084
- 'type'?: string;
1085
- /**
1086
- * Error message.
1087
- */
1088
- 'msg'?: string;
1089
- /**
1090
- * A free-form object containing group\'s extended attributes.
1091
- */
1092
- 'metadata'?: {
1093
- [key: string]: any;
1094
- };
1095
- }
1096
-
1097
- /**
1098
- * Allows to process the uploaded image according to the indicated settings.
1099
- */
1100
- export declare interface OutputImageParams {
1101
- /**
1102
- * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
1103
- */
1104
- 'backgroundColor'?: Array<number>;
1105
- 'crop'?: Crop;
1106
- }
1107
-
1108
- /**
1109
- * NOTE: This file is auto generated by OpenAPI Generator.
1110
- * Do not edit the file manually.
1111
- */
1112
- /**
1113
- * Information about current page number and total pages count
1114
- */
1115
- export declare interface Page {
1116
- /**
1117
- * Current page number.
1118
- */
1119
- 'page'?: number;
1120
- /**
1121
- * Total number of pages.
1122
- */
1123
- 'totalPages'?: number;
1124
- }
1125
-
1126
- /**
1127
- * @type Person
1128
- * Person response body: person ID, creation date, update date if any.
1129
- */
1130
- export declare type Person = PersonData & PersonFields;
1131
-
1132
- export declare class PersonApi {
1133
- private superClass;
1134
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
1135
- createPerson(personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
1136
- addImageToPerson(personId: string, imageFields: AddImageToPersonRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<Image_2>;
1137
- deleteImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1138
- deletePerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1139
- getAllGroupsByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
1140
- getAllImagesByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<ImagePage>;
1141
- getImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<unknown>;
1142
- getPerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
1143
- updatePerson(personId: string, personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
1144
- }
1145
-
1146
- /**
1147
- * NOTE: This file is auto generated by OpenAPI Generator.
1148
- * Do not edit the file manually.
1149
- */
1150
- export declare interface PersonData {
1151
- /**
1152
- * Person ID. The list of persons is sorted by decreasing ID value.
1153
- */
1154
- 'id'?: string;
1155
- /**
1156
- * Person creation date.
1157
- */
1158
- 'createdAt'?: string;
1159
- /**
1160
- * Person update date.
1161
- */
1162
- 'updatedAt'?: string;
1163
- }
1164
-
1165
- /**
1166
- * NOTE: This file is auto generated by OpenAPI Generator.
1167
- * Do not edit the file manually.
1168
- */
1169
- /**
1170
- * Person Request body: name and metadata.
1171
- */
1172
- export declare interface PersonFields {
1173
- /**
1174
- * Person\'s name.
1175
- */
1176
- 'name': string;
1177
- /**
1178
- * Person\'s ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.
1179
- */
1180
- 'externalId'?: string;
1181
- /**
1182
- * A free-form object containing person\'s extended attributes.
1183
- */
1184
- 'metadata'?: {
1185
- [key: string]: any;
1186
- };
1187
- /**
1188
- * 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.
1189
- */
1190
- 'groups'?: Array<string>;
1191
- /**
1192
- * Person expiration date.
1193
- */
1194
- 'expireAt'?: string;
1195
- }
1196
-
1197
- export declare interface PersonItems {
1198
- 'items'?: Array<Person>;
1199
- }
1200
-
1201
- /**
1202
- * @type PersonsPage
1203
- */
1204
- export declare type PersonsPage = Page & PersonItems;
1205
-
1206
- /**
1207
- * NOTE: This file is auto generated by OpenAPI Generator.
1208
- * Do not edit the file manually.
1209
- */
1210
- /**
1211
- * Person Request body: name and metadata.
1212
- */
1213
- export declare interface PersonToUpdateFields {
1214
- /**
1215
- * Person\'s ID, used for linking search results to an ID in an external system. Can be set when creating a Person, stored in the database, and included in the search to return only Persons with the specified ID. Optional.
1216
- */
1217
- 'externalId'?: string;
1218
- /**
1219
- * Person\'s name.
1220
- */
1221
- 'name'?: string;
1222
- /**
1223
- * A free-form object containing person\'s extended attributes.
1224
- */
1225
- 'metadata'?: {
1226
- [key: string]: any;
1227
- };
1228
- /**
1229
- * 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.
1230
- */
1231
- 'groups'?: Array<string>;
1232
- }
1233
-
1234
- /**
1235
- * @type PersonWithImages
1236
- */
1237
- export declare type PersonWithImages = Person & PersonWithImagesData;
1238
-
1239
- export declare interface PersonWithImagesData {
1240
- /**
1241
- * Detected Persons.
1242
- */
1243
- 'images'?: Array<RecognizeImage>;
1244
- }
1245
-
1246
- /**
1247
- * The processing parameters.
1248
- */
1249
- export declare interface ProcessParam {
1250
- 'scenario'?: FaceQualityScenarios;
1251
- /**
1252
- * Whether to process only the central face in the image. If set to `false`, all the faces are processed.
1253
- */
1254
- 'onlyCentralFace'?: boolean;
1255
- 'outputImageParams'?: OutputImageParams;
1256
- 'quality'?: QualityRequest;
1257
- 'attributes'?: ProcessParamAttributes;
1258
- }
1259
-
1260
- /**
1261
- * If set, the selected attributes, such as age or emotions, are evaluated. To check all the available attributes, you can set the `AttributesAll` scenario in `processParam.scenario`.
1262
- */
1263
- export declare interface ProcessParamAttributes {
1264
- /**
1265
- * The list of attributes for evaluation.
1266
- */
1267
- 'config'?: Array<AttributeConfig>;
1268
- }
1269
-
1270
- /**
1271
- * The configuration that defines the list of returned quality check characteristics.
1272
- */
1273
- export declare interface QualityConfig {
1274
- 'name'?: FaceQualityConfigName;
1275
- /**
1276
- * The range of applicable values for this characteristic. If the returned in the response value fits this range, the characteristic is identified as compliant with the requirements. For recommended ranges, see [Face Image Quality Assessment](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/).
1277
- */
1278
- 'range'?: Array<number>;
1279
- }
1280
-
1281
- export declare interface QualityDetail {
1282
- 'groupId'?: FaceImageQualityGroups;
1283
- 'name'?: FaceQualityConfigName;
1284
- /**
1285
- * The range of set values for this characteristic, see the [Recommended range column](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/).
1286
- */
1287
- 'range'?: Array<number>;
1288
- 'status'?: FaceImageQualityStatus;
1289
- /**
1290
- * The result value for the characteristic, returned in set units.
1291
- */
1292
- 'value'?: number;
1293
- }
1294
-
1295
- export declare interface QualityDetailsGroups {
1296
- 'groupId'?: FaceImageQualityGroups;
1297
- 'name'?: FaceImageQualityGroupsStrings;
1298
- /**
1299
- * The total number of characteristics in the group.
1300
- */
1301
- 'totalCount'?: number;
1302
- /**
1303
- * The number of compliant characteristics in the group.
1304
- */
1305
- 'compliantCount'?: number;
1306
- }
1307
-
1308
- /**
1309
- * If set, the face image quality check is performed according to the given list of [characteristics](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/usage/face-detection/face-image-quality-check/) in `quality.config`.
1310
- */
1311
- export declare interface QualityRequest {
1312
- /**
1313
- * The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
1314
- */
1315
- 'backgroundMatchColor'?: Array<number>;
1316
- /**
1317
- * The list of quality check characteristics.
1318
- */
1319
- 'config'?: Array<QualityConfig>;
1320
- }
1321
-
1322
- /**
1323
- * @type RecognizeImage
1324
- */
1325
- export declare type RecognizeImage = Image_2 & RecognizeImageData;
1326
-
1327
- /**
1328
- * NOTE: This file is auto generated by OpenAPI Generator.
1329
- * Do not edit the file manually.
1330
- */
1331
- export declare interface RecognizeImageData {
1332
- /**
1333
- * Similarity score.
1334
- */
1335
- 'similarity'?: number;
1336
- /**
1337
- * Similarity distance score: the lower the distance, the higher the face\'s similarity.
1338
- */
1339
- 'distance'?: number;
1340
- }
1341
-
1342
- /**
1343
- * NOTE: This file is auto generated by OpenAPI Generator.
1344
- * Do not edit the file manually.
1345
- */
1346
- /**
1347
- * Set to resize the original image.
1348
- */
1349
- export declare interface ResizeOptions {
1350
- /**
1351
- * Resized image width, px.
1352
- */
1353
- 'width'?: number;
1354
- /**
1355
- * Resized image height, px.
1356
- */
1357
- 'height'?: number;
1358
- /**
1359
- * Resized image quality, percent.
1360
- */
1361
- 'quality'?: number;
1362
- }
1363
-
1364
- export declare class SearchApi {
1365
- private superClass;
1366
- constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
1367
- search(searchRequest: SearchRequest, xRequestID?: string, withImages?: boolean, options?: AxiosRequestConfig): Promise<SearchResult>;
1368
- }
1369
-
1370
- /**
1371
- * NOTE: This file is auto generated by OpenAPI Generator.
1372
- * Do not edit the file manually.
1373
- */
1374
- export declare interface SearchBadParams {
1375
- 'msg'?: string;
1376
- 'statusCode'?: number;
1377
- 'type'?: string;
1378
- }
1379
-
1380
- /**
1381
- * NOTE: This file is auto generated by OpenAPI Generator.
1382
- * Do not edit the file manually.
1383
- */
1384
- /**
1385
- * The array of identified persons.
1386
- */
1387
- export declare interface SearchDetection {
1388
- /**
1389
- * Internal.
1390
- */
1391
- 'code'?: number;
1392
- /**
1393
- * Base64 of the aligned and cropped portrait.
1394
- */
1395
- 'crop'?: string;
1396
- /**
1397
- * Internal.
1398
- */
1399
- 'detectorType'?: number;
1400
- /**
1401
- * Internal.
1402
- */
1403
- 'hash'?: string;
1404
- /**
1405
- * Internal.
1406
- */
1407
- 'idx'?: number;
1408
- /**
1409
- * Internal.
1410
- */
1411
- 'image'?: string;
1412
- /**
1413
- * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
1414
- */
1415
- 'landmarks'?: Array<Array<number>>;
1416
- /**
1417
- * Internal.
1418
- */
1419
- 'landmarksType'?: number;
1420
- /**
1421
- * Internal.
1422
- */
1423
- 'msg'?: string;
1424
- /**
1425
- * 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.
1426
- */
1427
- 'roi'?: Array<number>;
1428
- 'versionSDK'?: string;
1429
- }
1430
-
1431
- /**
1432
- * Request search data.
1433
- */
1434
- export declare interface SearchParameters {
1435
- 'createPerson'?: SearchParametersCreatePerson;
1436
- /**
1437
- * IDs of the groups in which the search is performed.
1438
- */
1439
- 'groupIds'?: Array<string>;
1440
- 'filter'?: FilterSearchRequest;
1441
- }
1442
-
1443
- /**
1444
- * NOTE: This file is auto generated by OpenAPI Generator.
1445
- * Do not edit the file manually.
1446
- */
1447
- /**
1448
- * If a person is not found, a new person entry is created using the descriptor calculated while searching.
1449
- */
1450
- export declare interface SearchParametersCreatePerson {
1451
- /**
1452
- * Person\'s name.
1453
- */
1454
- 'name'?: string;
1455
- /**
1456
- * A free-form object containing person\'s extended attributes.
1457
- */
1458
- 'metadata'?: {
1459
- [key: string]: any;
1460
- };
1461
- /**
1462
- * The lifespan of the Person\'s records, seconds. Optional.
1463
- */
1464
- 'ttl'?: number;
1465
- }
1466
-
1467
- /**
1468
- * @type SearchPerson
1469
- */
1470
- export declare type SearchPerson = Person & SearchPersonData;
1471
-
1472
- export declare interface SearchPersonData {
1473
- 'detection'?: SearchDetection;
1474
- /**
1475
- * Array of Person images.
1476
- */
1477
- 'images'?: Array<RecognizeImage>;
1478
- }
1479
-
1480
- /**
1481
- * @type SearchRequest
1482
- */
1483
- export declare type SearchRequest = ImageFields & SearchParameters & TransactionLabels;
1484
-
1485
- export declare interface SearchResult {
1486
- /**
1487
- * Result code. It is returned only with response 200.
1488
- */
1489
- 'code'?: number;
1490
- /**
1491
- * Array of Person images. It is returned only with response 200.
1492
- */
1493
- 'persons'?: Array<SearchPerson>;
1494
- }
1495
-
1496
- export declare interface TransactionInfo {
1497
- /**
1498
- * Result code, see the [FaceSDKResultCode enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/).
1499
- */
1500
- 'code'?: number;
1501
- /**
1502
- * Whether the liveness detection is confirmed `0` or not `1`.
1503
- */
1504
- 'status'?: number;
1505
- /**
1506
- * Session identificator, should be unique for each session.
1507
- */
1508
- 'tag'?: string;
1509
- /**
1510
- * Transaction ID, there can be several transactions within one session.
1511
- */
1512
- 'transactionId'?: string;
1513
- /**
1514
- * Link to the session video, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
1515
- */
1516
- 'video'?: string;
1517
- /**
1518
- * Approximate age with an accuracy of +/-3 years.
1519
- */
1520
- 'age'?: Array<{
1521
- [key: string]: any;
1522
- }>;
1523
- /**
1524
- * Link to the portrait, depends on the selected storage type. [Learn more](https://docs.regulaforensics.com/develop/face-sdk/web-service/administration/storage/)
1525
- */
1526
- 'portrait'?: string;
1527
- /**
1528
- * A free-form object containing person\'s extended attributes.
1529
- */
1530
- 'metadata'?: {
1531
- [key: string]: any;
1532
- };
1533
- 'type'?: LivenessType;
1534
- }
1535
-
1536
- /**
1537
- * NOTE: This file is auto generated by OpenAPI Generator.
1538
- * Do not edit the file manually.
1539
- */
1540
- export declare interface TransactionLabels {
1541
- /**
1542
- * A label used to group transactions by customers, applications, or other criteria.
1543
- */
1544
- 'tenant'?: string;
1545
- /**
1546
- * A label used to differentiate transactions by development stages.
1547
- */
1548
- 'env'?: string;
1549
- }
1550
-
1551
- /**
1552
- * NOTE: This file is auto generated by OpenAPI Generator.
1553
- * Do not edit the file manually.
1554
- */
1555
- /**
1556
- * Update group.
1557
- */
1558
- export declare interface UpdateGroup {
1559
- /**
1560
- * Add items.
1561
- */
1562
- 'addItems'?: Array<string>;
1563
- /**
1564
- * Remove items.
1565
- */
1566
- 'removeItems'?: Array<string>;
1567
- }
1568
-
1569
- export { }