@regulaforensics/facesdk-webclient 6.2.0 → 6.3.3-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/README.md +1 -1
- package/dist/main/index.cjs +1 -1
- package/dist/module/index.js +1 -1
- package/lib/index.d.ts +468 -939
- package/package.json +14 -15
package/lib/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import { AxiosRequestConfig, AxiosInstance } from "axios";
|
|
2
2
|
/**
|
|
3
|
-
* Regula
|
|
4
|
-
*
|
|
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
|
|
5
5
|
*
|
|
6
|
-
* The version of the OpenAPI document:
|
|
6
|
+
* The version of the OpenAPI document: 5.2.0
|
|
7
7
|
*
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -83,10 +83,10 @@ export class Configuration {
|
|
|
83
83
|
isJsonMime(mime: string): boolean;
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Regula
|
|
87
|
-
*
|
|
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
|
|
88
88
|
*
|
|
89
|
-
* The version of the OpenAPI document:
|
|
89
|
+
* The version of the OpenAPI document: 5.2.0
|
|
90
90
|
*
|
|
91
91
|
*
|
|
92
92
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -94,155 +94,54 @@ export class Configuration {
|
|
|
94
94
|
* Do not edit the class manually.
|
|
95
95
|
*/
|
|
96
96
|
/**
|
|
97
|
-
*
|
|
98
|
-
* @export
|
|
99
|
-
* @interface ResizeOptions
|
|
100
|
-
*/
|
|
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;
|
|
123
|
-
/**
|
|
124
|
-
* Uploaded image.
|
|
97
|
+
* The aspect ratio according to which face alignment is performed during face detection.
|
|
125
98
|
* @export
|
|
126
|
-
* @
|
|
99
|
+
* @enum {string}
|
|
127
100
|
*/
|
|
128
|
-
export
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
*
|
|
137
|
-
* @type {ImageData}
|
|
138
|
-
* @memberof AddImageToPersonRequestImage
|
|
139
|
-
*/
|
|
140
|
-
'content'?: ImageData;
|
|
141
|
-
/**
|
|
142
|
-
* Image URL.
|
|
143
|
-
* @type {string}
|
|
144
|
-
* @memberof AddImageToPersonRequestImage
|
|
145
|
-
*/
|
|
146
|
-
'imageUrl'?: string;
|
|
147
|
-
/**
|
|
148
|
-
*
|
|
149
|
-
* @type {ResizeOptions}
|
|
150
|
-
* @memberof AddImageToPersonRequestImage
|
|
151
|
-
*/
|
|
152
|
-
'resizeOptions'?: ResizeOptions;
|
|
153
|
-
}
|
|
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];
|
|
154
109
|
/**
|
|
155
|
-
*
|
|
110
|
+
* Whether to return the Base64 of an aligned and cropped portrait in the crop field.
|
|
156
111
|
* @export
|
|
157
|
-
* @interface
|
|
112
|
+
* @interface Crop
|
|
158
113
|
*/
|
|
159
|
-
export interface
|
|
160
|
-
/**
|
|
161
|
-
* Session identificator.
|
|
162
|
-
* @type {string}
|
|
163
|
-
* @memberof AddImageToPersonRequest
|
|
164
|
-
*/
|
|
165
|
-
'tag'?: string;
|
|
114
|
+
export interface Crop {
|
|
166
115
|
/**
|
|
167
116
|
*
|
|
168
|
-
* @type {
|
|
169
|
-
* @memberof
|
|
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;
|
|
184
|
-
}
|
|
185
|
-
/**
|
|
186
|
-
* Regula Face SDK Web API
|
|
187
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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
|
|
188
|
-
*
|
|
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
|
|
117
|
+
* @type {FaceImageQualityAlignType}
|
|
118
|
+
* @memberof Crop
|
|
218
119
|
*/
|
|
219
|
-
'
|
|
120
|
+
'type'?: FaceImageQualityAlignType;
|
|
220
121
|
/**
|
|
221
|
-
*
|
|
222
|
-
* @type {
|
|
223
|
-
* @memberof
|
|
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
|
|
224
125
|
*/
|
|
225
|
-
'
|
|
126
|
+
'padColor'?: Array<number>;
|
|
226
127
|
/**
|
|
227
|
-
*
|
|
228
|
-
* @type {
|
|
229
|
-
* @memberof
|
|
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
|
|
230
131
|
*/
|
|
231
|
-
'
|
|
132
|
+
'size'?: Array<number>;
|
|
232
133
|
/**
|
|
233
|
-
*
|
|
234
|
-
* @type {
|
|
235
|
-
* @memberof
|
|
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
|
|
236
137
|
*/
|
|
237
|
-
'
|
|
238
|
-
[key: string]: object;
|
|
239
|
-
};
|
|
138
|
+
'returnOriginalRect'?: boolean;
|
|
240
139
|
}
|
|
241
140
|
/**
|
|
242
|
-
* Regula
|
|
243
|
-
*
|
|
141
|
+
* 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
|
|
244
143
|
*
|
|
245
|
-
* The version of the OpenAPI document:
|
|
144
|
+
* The version of the OpenAPI document: 5.2.0
|
|
246
145
|
*
|
|
247
146
|
*
|
|
248
147
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -271,78 +170,42 @@ export const FaceAttribute: {
|
|
|
271
170
|
};
|
|
272
171
|
export type FaceAttribute = (typeof FaceAttribute)[keyof typeof FaceAttribute];
|
|
273
172
|
/**
|
|
274
|
-
* The configuration that defines the list of returned
|
|
173
|
+
* The configuration that defines the list of returned quality check characteristics.
|
|
275
174
|
* @export
|
|
276
|
-
* @interface
|
|
175
|
+
* @interface QualityConfig
|
|
277
176
|
*/
|
|
278
|
-
export interface
|
|
177
|
+
export interface QualityConfig {
|
|
279
178
|
/**
|
|
280
179
|
*
|
|
281
180
|
* @type {FaceAttribute}
|
|
282
|
-
* @memberof
|
|
181
|
+
* @memberof QualityConfig
|
|
283
182
|
*/
|
|
284
183
|
'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>;
|
|
285
190
|
}
|
|
286
191
|
/**
|
|
287
|
-
*
|
|
288
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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.
|
|
192
|
+
* Whether to evaluate attributes, such as age and emotions.
|
|
299
193
|
* @export
|
|
300
|
-
* @
|
|
194
|
+
* @interface DetectRequestAttributes
|
|
301
195
|
*/
|
|
302
|
-
export
|
|
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 {
|
|
196
|
+
export interface DetectRequestAttributes {
|
|
316
197
|
/**
|
|
317
198
|
*
|
|
318
|
-
* @type {
|
|
319
|
-
* @memberof
|
|
320
|
-
*/
|
|
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
|
|
199
|
+
* @type {Array<QualityConfig>}
|
|
200
|
+
* @memberof DetectRequestAttributes
|
|
338
201
|
*/
|
|
339
|
-
'
|
|
202
|
+
'config'?: Array<QualityConfig>;
|
|
340
203
|
}
|
|
341
204
|
/**
|
|
342
|
-
* Regula
|
|
343
|
-
*
|
|
205
|
+
* 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
|
|
344
207
|
*
|
|
345
|
-
* The version of the OpenAPI document:
|
|
208
|
+
* The version of the OpenAPI document: 5.2.0
|
|
346
209
|
*
|
|
347
210
|
*
|
|
348
211
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -363,7 +226,6 @@ export const FaceQualityScenarios: {
|
|
|
363
226
|
readonly CROP_CENTRAL_FACE: "CropCentralFace";
|
|
364
227
|
readonly CROP_ALL_FACES: "CropAllFaces";
|
|
365
228
|
readonly THUMBNAIL: "Thumbnail";
|
|
366
|
-
readonly EMPTY: "";
|
|
367
229
|
};
|
|
368
230
|
export type FaceQualityScenarios = (typeof FaceQualityScenarios)[keyof typeof FaceQualityScenarios];
|
|
369
231
|
/**
|
|
@@ -385,105 +247,6 @@ export interface OutputImageParams {
|
|
|
385
247
|
*/
|
|
386
248
|
'crop'?: Crop;
|
|
387
249
|
}
|
|
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 Face SDK Web API
|
|
403
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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 {
|
|
474
|
-
/**
|
|
475
|
-
*
|
|
476
|
-
* @type {FaceQualityConfigName}
|
|
477
|
-
* @memberof QualityConfig
|
|
478
|
-
*/
|
|
479
|
-
'name'?: FaceQualityConfigName;
|
|
480
|
-
/**
|
|
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
|
|
484
|
-
*/
|
|
485
|
-
'range'?: Array<number>;
|
|
486
|
-
}
|
|
487
250
|
/**
|
|
488
251
|
* Whether to perform the portrait quality check.
|
|
489
252
|
* @export
|
|
@@ -534,12 +297,14 @@ export interface ProcessParam {
|
|
|
534
297
|
*/
|
|
535
298
|
'quality'?: QualityRequest;
|
|
536
299
|
/**
|
|
537
|
-
*
|
|
538
|
-
* @type {
|
|
300
|
+
* Whether to evaluate attributes, such as age and emotions.
|
|
301
|
+
* @type {boolean}
|
|
539
302
|
* @memberof ProcessParam
|
|
540
303
|
*/
|
|
541
|
-
'attributes'?:
|
|
304
|
+
'attributes'?: boolean;
|
|
542
305
|
}
|
|
306
|
+
type Base64String = string;
|
|
307
|
+
type ImageData = Base64String | ArrayBuffer;
|
|
543
308
|
/**
|
|
544
309
|
*
|
|
545
310
|
* @export
|
|
@@ -547,7 +312,7 @@ export interface ProcessParam {
|
|
|
547
312
|
*/
|
|
548
313
|
export interface DetectRequest {
|
|
549
314
|
/**
|
|
550
|
-
* Session identificator
|
|
315
|
+
* Session identificator.
|
|
551
316
|
* @type {string}
|
|
552
317
|
* @memberof DetectRequest
|
|
553
318
|
*/
|
|
@@ -565,17 +330,23 @@ export interface DetectRequest {
|
|
|
565
330
|
*/
|
|
566
331
|
'image'?: ImageData;
|
|
567
332
|
/**
|
|
568
|
-
*
|
|
333
|
+
* Whether to return the cropped portrains with the detected faces.
|
|
569
334
|
* @type {boolean}
|
|
570
335
|
* @memberof DetectRequest
|
|
571
336
|
*/
|
|
572
337
|
'thumbnails'?: boolean;
|
|
338
|
+
/**
|
|
339
|
+
*
|
|
340
|
+
* @type {DetectRequestAttributes}
|
|
341
|
+
* @memberof DetectRequest
|
|
342
|
+
*/
|
|
343
|
+
'attributes'?: DetectRequestAttributes;
|
|
573
344
|
}
|
|
574
345
|
/**
|
|
575
|
-
* Regula
|
|
576
|
-
*
|
|
346
|
+
* 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
|
|
577
348
|
*
|
|
578
|
-
* The version of the OpenAPI document:
|
|
349
|
+
* The version of the OpenAPI document: 5.2.0
|
|
579
350
|
*
|
|
580
351
|
*
|
|
581
352
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -583,31 +354,66 @@ export interface DetectRequest {
|
|
|
583
354
|
* Do not edit the class manually.
|
|
584
355
|
*/
|
|
585
356
|
/**
|
|
586
|
-
*
|
|
357
|
+
* All image characteristics that can be assessed during face image quality assessment.
|
|
587
358
|
* @export
|
|
588
|
-
* @
|
|
359
|
+
* @enum {string}
|
|
589
360
|
*/
|
|
590
|
-
export
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
361
|
+
export const FaceQualityConfigName: {
|
|
362
|
+
readonly IMAGE_WIDTH: "ImageWidth";
|
|
363
|
+
readonly IMAGE_HEIGHT: "ImageHeight";
|
|
364
|
+
readonly IMAGE_WIDTH_TO_HEIGHT: "ImageWidthToHeight";
|
|
365
|
+
readonly IMAGE_CHANNELS_NUMBER: "ImageChannelsNumber";
|
|
366
|
+
readonly PADDING_RATIO: "PaddingRatio";
|
|
367
|
+
readonly FACE_MID_POINT_HORIZONTAL_POSITION: "FaceMidPointHorizontalPosition";
|
|
368
|
+
readonly FACE_MID_POINT_VERTICAL_POSITION: "FaceMidPointVerticalPosition";
|
|
369
|
+
readonly HEAD_WIDTH_RATIO: "HeadWidthRatio";
|
|
370
|
+
readonly HEAD_HEIGHT_RATIO: "HeadHeightRatio";
|
|
371
|
+
readonly EYES_DISTANCE: "EyesDistance";
|
|
372
|
+
readonly YAW: "Yaw";
|
|
373
|
+
readonly PITCH: "Pitch";
|
|
374
|
+
readonly ROLL: "Roll";
|
|
375
|
+
readonly BLUR_LEVEL: "BlurLevel";
|
|
376
|
+
readonly NOISE_LEVEL: "NoiseLevel";
|
|
377
|
+
readonly EYE_RIGHT_CLOSED: "EyeRightClosed";
|
|
378
|
+
readonly EYE_LEFT_CLOSED: "EyeLeftClosed";
|
|
379
|
+
readonly EYE_RIGHT_OCCLUDED: "EyeRightOccluded";
|
|
380
|
+
readonly EYE_LEFT_OCCLUDED: "EyeLeftOccluded";
|
|
381
|
+
readonly EYES_RED: "EyesRed";
|
|
382
|
+
readonly EYE_RIGHT_COVERED_WITH_HAIR: "EyeRightCoveredWithHair";
|
|
383
|
+
readonly EYE_LEFT_COVERED_WITH_HAIR: "EyeLeftCoveredWithHair";
|
|
384
|
+
readonly OFF_GAZE: "OffGaze";
|
|
385
|
+
readonly FACE_DYNAMIC_RANGE: "FaceDynamicRange";
|
|
386
|
+
readonly UNNATURAL_SKIN_TONE: "UnnaturalSkinTone";
|
|
387
|
+
readonly TOO_DARK: "TooDark";
|
|
388
|
+
readonly TOO_LIGHT: "TooLight";
|
|
389
|
+
readonly FACE_GLARE: "FaceGlare";
|
|
390
|
+
readonly SHADOWS_ON_FACE: "ShadowsOnFace";
|
|
391
|
+
readonly DARK_GLASSES: "DarkGlasses";
|
|
392
|
+
readonly REFLECTION_ON_GLASSES: "ReflectionOnGlasses";
|
|
393
|
+
readonly FRAMES_TOO_HEAVY: "FramesTooHeavy";
|
|
394
|
+
readonly FACE_OCCLUDED: "FaceOccluded";
|
|
395
|
+
readonly HEAD_COVERING: "HeadCovering";
|
|
396
|
+
readonly BACKGROUND_UNIFORMITY: "BackgroundUniformity";
|
|
397
|
+
readonly SHADOWS_ON_BACKGROUND: "ShadowsOnBackground";
|
|
398
|
+
readonly OTHER_FACES: "OtherFaces";
|
|
399
|
+
readonly SHOULDERS_POSE: "ShouldersPose";
|
|
400
|
+
readonly EXPRESSION_LEVEL: "ExpressionLevel";
|
|
401
|
+
readonly MOUTH_OPEN: "MouthOpen";
|
|
402
|
+
readonly FOREHEAD_COVERING: "ForeheadCovering";
|
|
403
|
+
readonly SMILE: "Smile";
|
|
404
|
+
readonly STRONG_MAKEUP: "StrongMakeup";
|
|
405
|
+
readonly HEADPHONES: "Headphones";
|
|
406
|
+
readonly MEDICAL_MASK: "MedicalMask";
|
|
407
|
+
readonly BACKGROUND_COLOR_MATCH: "BackgroundColorMatch";
|
|
408
|
+
readonly ART_FACE: "ArtFace";
|
|
409
|
+
readonly CONTACT_LENSES: "ContactLenses";
|
|
410
|
+
};
|
|
411
|
+
export type FaceQualityConfigName = (typeof FaceQualityConfigName)[keyof typeof FaceQualityConfigName];
|
|
606
412
|
/**
|
|
607
|
-
* Regula
|
|
608
|
-
*
|
|
413
|
+
* Regula FaceSDK Web API
|
|
414
|
+
* 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
|
|
609
415
|
*
|
|
610
|
-
* The version of the OpenAPI document:
|
|
416
|
+
* The version of the OpenAPI document: 5.2.0
|
|
611
417
|
*
|
|
612
418
|
*
|
|
613
419
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -631,10 +437,10 @@ export const FaceImageQualityGroups: {
|
|
|
631
437
|
};
|
|
632
438
|
export type FaceImageQualityGroups = (typeof FaceImageQualityGroups)[keyof typeof FaceImageQualityGroups];
|
|
633
439
|
/**
|
|
634
|
-
* Regula
|
|
635
|
-
*
|
|
440
|
+
* Regula FaceSDK Web API
|
|
441
|
+
* 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
|
|
636
442
|
*
|
|
637
|
-
* The version of the OpenAPI document:
|
|
443
|
+
* The version of the OpenAPI document: 5.2.0
|
|
638
444
|
*
|
|
639
445
|
*
|
|
640
446
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -690,10 +496,10 @@ export interface QualityDetail {
|
|
|
690
496
|
'value'?: number;
|
|
691
497
|
}
|
|
692
498
|
/**
|
|
693
|
-
* Regula
|
|
694
|
-
*
|
|
499
|
+
* Regula FaceSDK Web API
|
|
500
|
+
* 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
|
|
695
501
|
*
|
|
696
|
-
* The version of the OpenAPI document:
|
|
502
|
+
* The version of the OpenAPI document: 5.2.0
|
|
697
503
|
*
|
|
698
504
|
*
|
|
699
505
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -798,10 +604,12 @@ export interface Detection {
|
|
|
798
604
|
'crop'?: ImageData;
|
|
799
605
|
/**
|
|
800
606
|
*
|
|
801
|
-
* @type {
|
|
607
|
+
* @type {{ [key: string]: object; }}
|
|
802
608
|
* @memberof Detection
|
|
803
609
|
*/
|
|
804
|
-
'attributes'?:
|
|
610
|
+
'attributes'?: {
|
|
611
|
+
[key: string]: object;
|
|
612
|
+
};
|
|
805
613
|
/**
|
|
806
614
|
* Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
|
|
807
615
|
* @type {Array<Array<number>>}
|
|
@@ -821,10 +629,9 @@ export interface Detection {
|
|
|
821
629
|
*/
|
|
822
630
|
'roi': Array<number>;
|
|
823
631
|
/**
|
|
824
|
-
*
|
|
632
|
+
* Base64 of the cropped portrait.
|
|
825
633
|
* @type {string}
|
|
826
634
|
* @memberof Detection
|
|
827
|
-
* @deprecated
|
|
828
635
|
*/
|
|
829
636
|
'thumbnail'?: string;
|
|
830
637
|
}
|
|
@@ -879,10 +686,10 @@ export interface DetectResponseAllOf {
|
|
|
879
686
|
'results'?: DetectResult;
|
|
880
687
|
}
|
|
881
688
|
/**
|
|
882
|
-
* Regula
|
|
883
|
-
*
|
|
689
|
+
* Regula FaceSDK Web API
|
|
690
|
+
* 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
|
|
884
691
|
*
|
|
885
|
-
* The version of the OpenAPI document:
|
|
692
|
+
* The version of the OpenAPI document: 5.2.0
|
|
886
693
|
*
|
|
887
694
|
*
|
|
888
695
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -890,7 +697,7 @@ export interface DetectResponseAllOf {
|
|
|
890
697
|
* Do not edit the class manually.
|
|
891
698
|
*/
|
|
892
699
|
/**
|
|
893
|
-
* The result code, see
|
|
700
|
+
* The result code, see enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/
|
|
894
701
|
* @export
|
|
895
702
|
* @enum {string}
|
|
896
703
|
*/
|
|
@@ -934,8 +741,6 @@ export const FaceSDKResultCode: {
|
|
|
934
741
|
readonly FACER_TIMEOUT_LIVENESS_TRANSACTION: 250;
|
|
935
742
|
readonly FACER_FAILED_LIVENESS_TRANSACTION: 251;
|
|
936
743
|
readonly FACER_ABORTED_LIVENESS_TRANSACTION: 252;
|
|
937
|
-
readonly FACER_GENERAL_ERROR: 253;
|
|
938
|
-
readonly FACER_PASSIVE_LIVENESS_FAIL: 254;
|
|
939
744
|
};
|
|
940
745
|
export type FaceSDKResultCode = (typeof FaceSDKResultCode)[keyof typeof FaceSDKResultCode];
|
|
941
746
|
/**
|
|
@@ -957,10 +762,10 @@ export interface FaceSDKResult {
|
|
|
957
762
|
*/
|
|
958
763
|
export type DetectResponse = DetectResponseAllOf & FaceSDKResult;
|
|
959
764
|
/**
|
|
960
|
-
* Regula
|
|
961
|
-
*
|
|
765
|
+
* Regula FaceSDK Web API
|
|
766
|
+
* 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
|
|
962
767
|
*
|
|
963
|
-
* The version of the OpenAPI document:
|
|
768
|
+
* The version of the OpenAPI document: 5.2.0
|
|
964
769
|
*
|
|
965
770
|
*
|
|
966
771
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -998,24 +803,17 @@ export interface DetectionFace {
|
|
|
998
803
|
*/
|
|
999
804
|
'roi'?: Array<number>;
|
|
1000
805
|
/**
|
|
1001
|
-
*
|
|
806
|
+
* Base64 of the cropped portrait.
|
|
1002
807
|
* @type {string}
|
|
1003
808
|
* @memberof DetectionFace
|
|
1004
|
-
* @deprecated
|
|
1005
809
|
*/
|
|
1006
810
|
'thumbnail'?: string;
|
|
1007
|
-
/**
|
|
1008
|
-
* Base64-encoded aligned and cropped portrait.
|
|
1009
|
-
* @type {string}
|
|
1010
|
-
* @memberof DetectionFace
|
|
1011
|
-
*/
|
|
1012
|
-
'crop'?: string;
|
|
1013
811
|
}
|
|
1014
812
|
/**
|
|
1015
|
-
* Regula
|
|
1016
|
-
*
|
|
813
|
+
* Regula FaceSDK Web API
|
|
814
|
+
* 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
|
|
1017
815
|
*
|
|
1018
|
-
* The version of the OpenAPI document:
|
|
816
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1019
817
|
*
|
|
1020
818
|
*
|
|
1021
819
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1054,10 +852,10 @@ export interface PersonAllOf {
|
|
|
1054
852
|
'groups'?: Array<string>;
|
|
1055
853
|
}
|
|
1056
854
|
/**
|
|
1057
|
-
* Regula
|
|
1058
|
-
*
|
|
855
|
+
* Regula FaceSDK Web API
|
|
856
|
+
* 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
|
|
1059
857
|
*
|
|
1060
|
-
* The version of the OpenAPI document:
|
|
858
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1061
859
|
*
|
|
1062
860
|
*
|
|
1063
861
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1071,17 +869,17 @@ export interface PersonAllOf {
|
|
|
1071
869
|
*/
|
|
1072
870
|
export interface PersonFields {
|
|
1073
871
|
/**
|
|
1074
|
-
*
|
|
872
|
+
* Session identificator.
|
|
1075
873
|
* @type {string}
|
|
1076
874
|
* @memberof PersonFields
|
|
1077
875
|
*/
|
|
1078
|
-
'
|
|
876
|
+
'tag'?: string;
|
|
1079
877
|
/**
|
|
1080
|
-
* Person
|
|
878
|
+
* Person name.
|
|
1081
879
|
* @type {string}
|
|
1082
880
|
* @memberof PersonFields
|
|
1083
881
|
*/
|
|
1084
|
-
'
|
|
882
|
+
'name'?: string;
|
|
1085
883
|
/**
|
|
1086
884
|
* A free-form object containing person\'s extended attributes.
|
|
1087
885
|
* @type {{ [key: string]: object; }}
|
|
@@ -1104,10 +902,10 @@ export interface PersonFields {
|
|
|
1104
902
|
*/
|
|
1105
903
|
export type Person = PersonAllOf & PersonFields;
|
|
1106
904
|
/**
|
|
1107
|
-
* Regula
|
|
1108
|
-
*
|
|
905
|
+
* Regula FaceSDK Web API
|
|
906
|
+
* 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
|
|
1109
907
|
*
|
|
1110
|
-
* The version of the OpenAPI document:
|
|
908
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1111
909
|
*
|
|
1112
910
|
*
|
|
1113
911
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1166,10 +964,10 @@ export interface Image {
|
|
|
1166
964
|
};
|
|
1167
965
|
}
|
|
1168
966
|
/**
|
|
1169
|
-
* Regula
|
|
1170
|
-
*
|
|
967
|
+
* Regula FaceSDK Web API
|
|
968
|
+
* 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
|
|
1171
969
|
*
|
|
1172
|
-
* The version of the OpenAPI document:
|
|
970
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1173
971
|
*
|
|
1174
972
|
*
|
|
1175
973
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1207,7 +1005,7 @@ export type RecognizeImage = Image & RecognizeImageAllOf;
|
|
|
1207
1005
|
*/
|
|
1208
1006
|
export interface PersonWithImagesAllOf {
|
|
1209
1007
|
/**
|
|
1210
|
-
*
|
|
1008
|
+
*
|
|
1211
1009
|
* @type {Array<RecognizeImage>}
|
|
1212
1010
|
* @memberof PersonWithImagesAllOf
|
|
1213
1011
|
*/
|
|
@@ -1225,7 +1023,7 @@ export type PersonWithImages = Person & PersonWithImagesAllOf;
|
|
|
1225
1023
|
*/
|
|
1226
1024
|
export interface FacesResponseAllOf {
|
|
1227
1025
|
/**
|
|
1228
|
-
*
|
|
1026
|
+
*
|
|
1229
1027
|
* @type {Array<PersonWithImages>}
|
|
1230
1028
|
* @memberof FacesResponseAllOf
|
|
1231
1029
|
*/
|
|
@@ -1243,56 +1041,10 @@ export interface FacesResponseAllOf {
|
|
|
1243
1041
|
*/
|
|
1244
1042
|
export type FacesResponse = DetectionFace & FacesResponseAllOf;
|
|
1245
1043
|
/**
|
|
1246
|
-
* Regula
|
|
1247
|
-
*
|
|
1044
|
+
* Regula FaceSDK Web API
|
|
1045
|
+
* 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
|
|
1248
1046
|
*
|
|
1249
|
-
* The version of the OpenAPI document:
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1252
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1253
|
-
* https://openapi-generator.tech
|
|
1254
|
-
* Do not edit the class manually.
|
|
1255
|
-
*/
|
|
1256
|
-
/**
|
|
1257
|
-
* 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.
|
|
1258
|
-
* @export
|
|
1259
|
-
* @enum {string}
|
|
1260
|
-
*/
|
|
1261
|
-
export const FilterOp: {
|
|
1262
|
-
readonly IN: "in";
|
|
1263
|
-
readonly NOT_IN: "nin";
|
|
1264
|
-
};
|
|
1265
|
-
export type FilterOp = (typeof FilterOp)[keyof typeof FilterOp];
|
|
1266
|
-
/**
|
|
1267
|
-
* 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.
|
|
1268
|
-
* @export
|
|
1269
|
-
* @interface FilterSearchRequest
|
|
1270
|
-
*/
|
|
1271
|
-
export interface FilterSearchRequest {
|
|
1272
|
-
/**
|
|
1273
|
-
*
|
|
1274
|
-
* @type {FilterOp}
|
|
1275
|
-
* @memberof FilterSearchRequest
|
|
1276
|
-
*/
|
|
1277
|
-
'op'?: FilterOp;
|
|
1278
|
-
/**
|
|
1279
|
-
* `name` of the Person.
|
|
1280
|
-
* @type {string}
|
|
1281
|
-
* @memberof FilterSearchRequest
|
|
1282
|
-
*/
|
|
1283
|
-
'field'?: string;
|
|
1284
|
-
/**
|
|
1285
|
-
* The list of `name` values against which the `field` is compared.
|
|
1286
|
-
* @type {Array<string>}
|
|
1287
|
-
* @memberof FilterSearchRequest
|
|
1288
|
-
*/
|
|
1289
|
-
'value'?: Array<string>;
|
|
1290
|
-
}
|
|
1291
|
-
/**
|
|
1292
|
-
* Regula Face SDK Web API
|
|
1293
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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
|
|
1294
|
-
*
|
|
1295
|
-
* The version of the OpenAPI document: 6.1.0
|
|
1047
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1296
1048
|
*
|
|
1297
1049
|
*
|
|
1298
1050
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1319,10 +1071,10 @@ export interface GroupAllOf {
|
|
|
1319
1071
|
'createdAt'?: string;
|
|
1320
1072
|
}
|
|
1321
1073
|
/**
|
|
1322
|
-
* Regula
|
|
1323
|
-
*
|
|
1074
|
+
* 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
|
|
1324
1076
|
*
|
|
1325
|
-
* The version of the OpenAPI document:
|
|
1077
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1326
1078
|
*
|
|
1327
1079
|
*
|
|
1328
1080
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1330,21 +1082,27 @@ export interface GroupAllOf {
|
|
|
1330
1082
|
* Do not edit the class manually.
|
|
1331
1083
|
*/
|
|
1332
1084
|
/**
|
|
1333
|
-
*
|
|
1085
|
+
* Request body of the group to create data, includes name and metadata.
|
|
1334
1086
|
* @export
|
|
1335
|
-
* @interface
|
|
1087
|
+
* @interface GroupToCreate
|
|
1336
1088
|
*/
|
|
1337
|
-
export interface
|
|
1089
|
+
export interface GroupToCreate {
|
|
1090
|
+
/**
|
|
1091
|
+
* Session identificator.
|
|
1092
|
+
* @type {string}
|
|
1093
|
+
* @memberof GroupToCreate
|
|
1094
|
+
*/
|
|
1095
|
+
'tag'?: string;
|
|
1338
1096
|
/**
|
|
1339
1097
|
* Group to create name.
|
|
1340
1098
|
* @type {string}
|
|
1341
|
-
* @memberof
|
|
1099
|
+
* @memberof GroupToCreate
|
|
1342
1100
|
*/
|
|
1343
1101
|
'name'?: string;
|
|
1344
1102
|
/**
|
|
1345
1103
|
* A free-form object containing group\'s extended attributes.
|
|
1346
1104
|
* @type {{ [key: string]: object; }}
|
|
1347
|
-
* @memberof
|
|
1105
|
+
* @memberof GroupToCreate
|
|
1348
1106
|
*/
|
|
1349
1107
|
'metadata'?: {
|
|
1350
1108
|
[key: string]: object;
|
|
@@ -1354,7 +1112,7 @@ export interface GroupResponse {
|
|
|
1354
1112
|
* @type Group
|
|
1355
1113
|
* @export
|
|
1356
1114
|
*/
|
|
1357
|
-
export type Group = GroupAllOf &
|
|
1115
|
+
export type Group = GroupAllOf & GroupToCreate;
|
|
1358
1116
|
/**
|
|
1359
1117
|
*
|
|
1360
1118
|
* @export
|
|
@@ -1369,10 +1127,10 @@ export interface GroupPageAllOf {
|
|
|
1369
1127
|
'items'?: Array<Group>;
|
|
1370
1128
|
}
|
|
1371
1129
|
/**
|
|
1372
|
-
* Regula
|
|
1373
|
-
*
|
|
1130
|
+
* Regula FaceSDK Web API
|
|
1131
|
+
* 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
|
|
1374
1132
|
*
|
|
1375
|
-
* The version of the OpenAPI document:
|
|
1133
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1376
1134
|
*
|
|
1377
1135
|
*
|
|
1378
1136
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1396,50 +1154,79 @@ export interface Page {
|
|
|
1396
1154
|
* @type {number}
|
|
1397
1155
|
* @memberof Page
|
|
1398
1156
|
*/
|
|
1399
|
-
'totalPages'?: number;
|
|
1157
|
+
'totalPages'?: number;
|
|
1158
|
+
}
|
|
1159
|
+
/**
|
|
1160
|
+
* @type GroupPage
|
|
1161
|
+
* @export
|
|
1162
|
+
*/
|
|
1163
|
+
export type GroupPage = GroupPageAllOf & Page;
|
|
1164
|
+
/**
|
|
1165
|
+
* Regula FaceSDK Web API
|
|
1166
|
+
* 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
|
|
1167
|
+
*
|
|
1168
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1169
|
+
*
|
|
1170
|
+
*
|
|
1171
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1172
|
+
* https://openapi-generator.tech
|
|
1173
|
+
* Do not edit the class manually.
|
|
1174
|
+
*/
|
|
1175
|
+
/**
|
|
1176
|
+
* Set to resize the original image.
|
|
1177
|
+
* @export
|
|
1178
|
+
* @interface ResizeOptions
|
|
1179
|
+
*/
|
|
1180
|
+
export interface ResizeOptions {
|
|
1181
|
+
/**
|
|
1182
|
+
* Resized image width, px.
|
|
1183
|
+
* @type {number}
|
|
1184
|
+
* @memberof ResizeOptions
|
|
1185
|
+
*/
|
|
1186
|
+
'width'?: number;
|
|
1187
|
+
/**
|
|
1188
|
+
* Resized image height, px.
|
|
1189
|
+
* @type {number}
|
|
1190
|
+
* @memberof ResizeOptions
|
|
1191
|
+
*/
|
|
1192
|
+
'height'?: number;
|
|
1193
|
+
/**
|
|
1194
|
+
* Resized image quality, percent.
|
|
1195
|
+
* @type {number}
|
|
1196
|
+
* @memberof ResizeOptions
|
|
1197
|
+
*/
|
|
1198
|
+
'quality'?: number;
|
|
1400
1199
|
}
|
|
1401
1200
|
/**
|
|
1402
|
-
*
|
|
1403
|
-
* @export
|
|
1404
|
-
*/
|
|
1405
|
-
export type GroupPage = GroupPageAllOf & Page;
|
|
1406
|
-
/**
|
|
1407
|
-
* Regula Face SDK Web API
|
|
1408
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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
|
|
1409
|
-
*
|
|
1410
|
-
* The version of the OpenAPI document: 6.1.0
|
|
1411
|
-
*
|
|
1412
|
-
*
|
|
1413
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1414
|
-
* https://openapi-generator.tech
|
|
1415
|
-
* Do not edit the class manually.
|
|
1416
|
-
*/
|
|
1417
|
-
/**
|
|
1418
|
-
* Request body of the group to create data, includes name and metadata.
|
|
1201
|
+
* Uploaded image.
|
|
1419
1202
|
* @export
|
|
1420
|
-
* @interface
|
|
1203
|
+
* @interface ImageFieldsImage
|
|
1421
1204
|
*/
|
|
1422
|
-
export interface
|
|
1205
|
+
export interface ImageFieldsImage {
|
|
1423
1206
|
/**
|
|
1424
|
-
*
|
|
1207
|
+
* Original media type of the uploaded image.
|
|
1425
1208
|
* @type {string}
|
|
1426
|
-
* @memberof
|
|
1209
|
+
* @memberof ImageFieldsImage
|
|
1427
1210
|
*/
|
|
1428
|
-
'
|
|
1211
|
+
'contentType'?: string;
|
|
1429
1212
|
/**
|
|
1430
|
-
*
|
|
1213
|
+
*
|
|
1214
|
+
* @type {ImageData}
|
|
1215
|
+
* @memberof ImageFieldsImage
|
|
1216
|
+
*/
|
|
1217
|
+
'content'?: ImageData;
|
|
1218
|
+
/**
|
|
1219
|
+
* Image URL.
|
|
1431
1220
|
* @type {string}
|
|
1432
|
-
* @memberof
|
|
1221
|
+
* @memberof ImageFieldsImage
|
|
1433
1222
|
*/
|
|
1434
|
-
'
|
|
1223
|
+
'imageUrl'?: string;
|
|
1435
1224
|
/**
|
|
1436
|
-
*
|
|
1437
|
-
* @type {
|
|
1438
|
-
* @memberof
|
|
1225
|
+
*
|
|
1226
|
+
* @type {ResizeOptions}
|
|
1227
|
+
* @memberof ImageFieldsImage
|
|
1439
1228
|
*/
|
|
1440
|
-
'
|
|
1441
|
-
[key: string]: object;
|
|
1442
|
-
};
|
|
1229
|
+
'resizeOptions'?: ResizeOptions;
|
|
1443
1230
|
}
|
|
1444
1231
|
/**
|
|
1445
1232
|
* Image in the request data, includes image and contentType.
|
|
@@ -1448,17 +1235,17 @@ export interface GroupToCreate {
|
|
|
1448
1235
|
*/
|
|
1449
1236
|
export interface ImageFields {
|
|
1450
1237
|
/**
|
|
1451
|
-
* Session identificator
|
|
1238
|
+
* Session identificator.
|
|
1452
1239
|
* @type {string}
|
|
1453
1240
|
* @memberof ImageFields
|
|
1454
1241
|
*/
|
|
1455
1242
|
'tag'?: string;
|
|
1456
1243
|
/**
|
|
1457
1244
|
*
|
|
1458
|
-
* @type {
|
|
1245
|
+
* @type {ImageFieldsImage}
|
|
1459
1246
|
* @memberof ImageFields
|
|
1460
1247
|
*/
|
|
1461
|
-
'image'?:
|
|
1248
|
+
'image'?: ImageFieldsImage;
|
|
1462
1249
|
/**
|
|
1463
1250
|
*
|
|
1464
1251
|
* @type {OutputImageParams}
|
|
@@ -1466,7 +1253,7 @@ export interface ImageFields {
|
|
|
1466
1253
|
*/
|
|
1467
1254
|
'outputImageParams'?: OutputImageParams;
|
|
1468
1255
|
/**
|
|
1469
|
-
* Whether to detect all faces in the image. If set to
|
|
1256
|
+
* Whether to detect all faces in the image. If set to false, only the most central face is detected.
|
|
1470
1257
|
* @type {boolean}
|
|
1471
1258
|
* @memberof ImageFields
|
|
1472
1259
|
*/
|
|
@@ -1503,10 +1290,10 @@ export interface ImagePageAllOf {
|
|
|
1503
1290
|
*/
|
|
1504
1291
|
export type ImagePage = ImagePageAllOf & Page;
|
|
1505
1292
|
/**
|
|
1506
|
-
* Regula
|
|
1507
|
-
*
|
|
1293
|
+
* Regula FaceSDK Web API
|
|
1294
|
+
* 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
|
|
1508
1295
|
*
|
|
1509
|
-
* The version of the OpenAPI document:
|
|
1296
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1510
1297
|
*
|
|
1511
1298
|
*
|
|
1512
1299
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1514,7 +1301,7 @@ export type ImagePage = ImagePageAllOf & Page;
|
|
|
1514
1301
|
* Do not edit the class manually.
|
|
1515
1302
|
*/
|
|
1516
1303
|
/**
|
|
1517
|
-
* The type of the image, defines the way the comparison is performed
|
|
1304
|
+
* The type of the image, defines the way the comparison is performed. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/image-source/
|
|
1518
1305
|
* @export
|
|
1519
1306
|
* @enum {string}
|
|
1520
1307
|
*/
|
|
@@ -1525,30 +1312,8 @@ export const ImageSource: {
|
|
|
1525
1312
|
readonly DOCUMENT_WITH_LIVE: 4;
|
|
1526
1313
|
readonly EXTERNAL: 5;
|
|
1527
1314
|
readonly GHOST: 6;
|
|
1528
|
-
readonly BARCODE: 7;
|
|
1529
1315
|
};
|
|
1530
1316
|
export type ImageSource = (typeof ImageSource)[keyof typeof ImageSource];
|
|
1531
|
-
/**
|
|
1532
|
-
* Regula Face SDK Web API
|
|
1533
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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
|
|
1534
|
-
*
|
|
1535
|
-
* The version of the OpenAPI document: 6.1.0
|
|
1536
|
-
*
|
|
1537
|
-
*
|
|
1538
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1539
|
-
* https://openapi-generator.tech
|
|
1540
|
-
* Do not edit the class manually.
|
|
1541
|
-
*/
|
|
1542
|
-
/**
|
|
1543
|
-
* 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)
|
|
1544
|
-
* @export
|
|
1545
|
-
* @enum {string}
|
|
1546
|
-
*/
|
|
1547
|
-
export const LivenessType: {
|
|
1548
|
-
readonly ACTIVE: 0;
|
|
1549
|
-
readonly PASSIVE: 1;
|
|
1550
|
-
};
|
|
1551
|
-
export type LivenessType = (typeof LivenessType)[keyof typeof LivenessType];
|
|
1552
1317
|
/**
|
|
1553
1318
|
*
|
|
1554
1319
|
* @export
|
|
@@ -1575,29 +1340,74 @@ export interface MatchAndSearchRequestAllOfImages {
|
|
|
1575
1340
|
*/
|
|
1576
1341
|
export interface MatchAndSearchRequestAllOf {
|
|
1577
1342
|
/**
|
|
1578
|
-
* Session identificator
|
|
1343
|
+
* Session identificator.
|
|
1579
1344
|
* @type {string}
|
|
1580
1345
|
* @memberof MatchAndSearchRequestAllOf
|
|
1581
1346
|
*/
|
|
1582
1347
|
'tag'?: string;
|
|
1583
1348
|
/**
|
|
1584
|
-
* Person
|
|
1349
|
+
* Array of Person images.
|
|
1585
1350
|
* @type {Array<MatchAndSearchRequestAllOfImages>}
|
|
1586
1351
|
* @memberof MatchAndSearchRequestAllOf
|
|
1587
1352
|
*/
|
|
1588
1353
|
'images'?: Array<MatchAndSearchRequestAllOfImages>;
|
|
1354
|
+
}
|
|
1355
|
+
/**
|
|
1356
|
+
* Regula FaceSDK Web API
|
|
1357
|
+
* 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
|
|
1358
|
+
*
|
|
1359
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1360
|
+
*
|
|
1361
|
+
*
|
|
1362
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1363
|
+
* https://openapi-generator.tech
|
|
1364
|
+
* Do not edit the class manually.
|
|
1365
|
+
*/
|
|
1366
|
+
/**
|
|
1367
|
+
* If a person is not found, a new person entry is created using the descriptor calculated while searching.
|
|
1368
|
+
* @export
|
|
1369
|
+
* @interface SearchParametersCreatePerson
|
|
1370
|
+
*/
|
|
1371
|
+
export interface SearchParametersCreatePerson {
|
|
1372
|
+
/**
|
|
1373
|
+
* Person\'s name.
|
|
1374
|
+
* @type {string}
|
|
1375
|
+
* @memberof SearchParametersCreatePerson
|
|
1376
|
+
*/
|
|
1377
|
+
'name'?: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* A free-form object containing person\'s extended attributes.
|
|
1380
|
+
* @type {{ [key: string]: object; }}
|
|
1381
|
+
* @memberof SearchParametersCreatePerson
|
|
1382
|
+
*/
|
|
1383
|
+
'metadata'?: {
|
|
1384
|
+
[key: string]: object;
|
|
1385
|
+
};
|
|
1386
|
+
}
|
|
1387
|
+
/**
|
|
1388
|
+
* Request search data.
|
|
1389
|
+
* @export
|
|
1390
|
+
* @interface SearchParameters
|
|
1391
|
+
*/
|
|
1392
|
+
export interface SearchParameters {
|
|
1393
|
+
/**
|
|
1394
|
+
*
|
|
1395
|
+
* @type {SearchParametersCreatePerson}
|
|
1396
|
+
* @memberof SearchParameters
|
|
1397
|
+
*/
|
|
1398
|
+
'createPerson'?: SearchParametersCreatePerson;
|
|
1589
1399
|
/**
|
|
1590
1400
|
* IDs of the groups in which the search is performed.
|
|
1591
|
-
* @type {Array<
|
|
1592
|
-
* @memberof
|
|
1401
|
+
* @type {Array<number>}
|
|
1402
|
+
* @memberof SearchParameters
|
|
1593
1403
|
*/
|
|
1594
|
-
'groupIds'?: Array<
|
|
1404
|
+
'groupIds'?: Array<number>;
|
|
1595
1405
|
}
|
|
1596
1406
|
/**
|
|
1597
1407
|
* @type MatchAndSearchRequest
|
|
1598
1408
|
* @export
|
|
1599
1409
|
*/
|
|
1600
|
-
export type MatchAndSearchRequest = MatchAndSearchRequestAllOf;
|
|
1410
|
+
export type MatchAndSearchRequest = MatchAndSearchRequestAllOf & SearchParameters;
|
|
1601
1411
|
/**
|
|
1602
1412
|
*
|
|
1603
1413
|
* @export
|
|
@@ -1605,13 +1415,13 @@ export type MatchAndSearchRequest = MatchAndSearchRequestAllOf;
|
|
|
1605
1415
|
*/
|
|
1606
1416
|
export interface MatchAndSearchResponseAllOfDetections {
|
|
1607
1417
|
/**
|
|
1608
|
-
*
|
|
1418
|
+
*
|
|
1609
1419
|
* @type {Array<FacesResponse>}
|
|
1610
1420
|
* @memberof MatchAndSearchResponseAllOfDetections
|
|
1611
1421
|
*/
|
|
1612
1422
|
'faces'?: Array<FacesResponse>;
|
|
1613
1423
|
/**
|
|
1614
|
-
* The image index number. Can be given; if not given, the index numbers are set automatically starting from
|
|
1424
|
+
* 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.
|
|
1615
1425
|
* @type {number}
|
|
1616
1426
|
* @memberof MatchAndSearchResponseAllOfDetections
|
|
1617
1427
|
*/
|
|
@@ -1630,7 +1440,7 @@ export interface MatchAndSearchResponseAllOfDetections {
|
|
|
1630
1440
|
*/
|
|
1631
1441
|
export interface MatchImageResult {
|
|
1632
1442
|
/**
|
|
1633
|
-
* The image index number. Can be given; if not given, the index numbers are set automatically starting from
|
|
1443
|
+
* 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.
|
|
1634
1444
|
* @type {number}
|
|
1635
1445
|
* @memberof MatchImageResult
|
|
1636
1446
|
*/
|
|
@@ -1648,7 +1458,7 @@ export interface MatchImageResult {
|
|
|
1648
1458
|
*/
|
|
1649
1459
|
'first'?: ImageSource;
|
|
1650
1460
|
/**
|
|
1651
|
-
* The image index number. Can be given; if not given, the index numbers are set automatically starting from
|
|
1461
|
+
* 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.
|
|
1652
1462
|
* @type {number}
|
|
1653
1463
|
* @memberof MatchImageResult
|
|
1654
1464
|
*/
|
|
@@ -1685,13 +1495,13 @@ export interface MatchImageResult {
|
|
|
1685
1495
|
*/
|
|
1686
1496
|
export interface MatchAndSearchResponseAllOf {
|
|
1687
1497
|
/**
|
|
1688
|
-
*
|
|
1498
|
+
*
|
|
1689
1499
|
* @type {Array<MatchImageResult>}
|
|
1690
1500
|
* @memberof MatchAndSearchResponseAllOf
|
|
1691
1501
|
*/
|
|
1692
1502
|
'results'?: Array<MatchImageResult>;
|
|
1693
1503
|
/**
|
|
1694
|
-
*
|
|
1504
|
+
*
|
|
1695
1505
|
* @type {number}
|
|
1696
1506
|
* @memberof MatchAndSearchResponseAllOf
|
|
1697
1507
|
*/
|
|
@@ -1705,7 +1515,7 @@ export interface MatchAndSearchResponseAllOf {
|
|
|
1705
1515
|
[key: string]: object;
|
|
1706
1516
|
};
|
|
1707
1517
|
/**
|
|
1708
|
-
*
|
|
1518
|
+
*
|
|
1709
1519
|
* @type {Array<MatchAndSearchResponseAllOfDetections>}
|
|
1710
1520
|
* @memberof MatchAndSearchResponseAllOf
|
|
1711
1521
|
*/
|
|
@@ -1723,7 +1533,7 @@ export type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseAllOf
|
|
|
1723
1533
|
*/
|
|
1724
1534
|
export interface MatchImage {
|
|
1725
1535
|
/**
|
|
1726
|
-
* The image index number. Can be given; if not given, the index numbers are set automatically starting from
|
|
1536
|
+
* 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.
|
|
1727
1537
|
* @type {number}
|
|
1728
1538
|
* @memberof MatchImage
|
|
1729
1539
|
*/
|
|
@@ -1741,7 +1551,7 @@ export interface MatchImage {
|
|
|
1741
1551
|
*/
|
|
1742
1552
|
'data': ImageData;
|
|
1743
1553
|
/**
|
|
1744
|
-
* Whether to detect all faces in the image. If set to
|
|
1554
|
+
* Whether to detect all faces in the image. If set to false, only the most central face is detected.
|
|
1745
1555
|
* @type {boolean}
|
|
1746
1556
|
* @memberof MatchImage
|
|
1747
1557
|
*/
|
|
@@ -1754,13 +1564,13 @@ export interface MatchImage {
|
|
|
1754
1564
|
*/
|
|
1755
1565
|
export interface MatchImageDetection {
|
|
1756
1566
|
/**
|
|
1757
|
-
*
|
|
1567
|
+
* The array of detected faces.
|
|
1758
1568
|
* @type {Array<DetectionFace>}
|
|
1759
1569
|
* @memberof MatchImageDetection
|
|
1760
1570
|
*/
|
|
1761
1571
|
'faces'?: Array<DetectionFace>;
|
|
1762
1572
|
/**
|
|
1763
|
-
* The image index number. Can be given; if not given, the index numbers are set automatically starting from
|
|
1573
|
+
* 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.
|
|
1764
1574
|
* @type {number}
|
|
1765
1575
|
* @memberof MatchImageDetection
|
|
1766
1576
|
*/
|
|
@@ -1772,250 +1582,60 @@ export interface MatchImageDetection {
|
|
|
1772
1582
|
*/
|
|
1773
1583
|
'status': FaceSDKResultCode;
|
|
1774
1584
|
}
|
|
1775
|
-
/**
|
|
1776
|
-
* Regula Face SDK Web API
|
|
1777
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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
|
|
1778
|
-
*
|
|
1779
|
-
* The version of the OpenAPI document: 6.1.0
|
|
1780
|
-
*
|
|
1781
|
-
*
|
|
1782
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1783
|
-
* https://openapi-generator.tech
|
|
1784
|
-
* Do not edit the class manually.
|
|
1785
|
-
*/
|
|
1786
|
-
/**
|
|
1787
|
-
* If set, a Base64-encoded aligned and cropped by the indicated settings portrait is returned in the `crop` field.
|
|
1788
|
-
* @export
|
|
1789
|
-
* @interface MatchRequestOutputImageParamsCrop
|
|
1790
|
-
*/
|
|
1791
|
-
export interface MatchRequestOutputImageParamsCrop {
|
|
1792
|
-
/**
|
|
1793
|
-
* The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
|
|
1794
|
-
* @type {Array<number>}
|
|
1795
|
-
* @memberof MatchRequestOutputImageParamsCrop
|
|
1796
|
-
*/
|
|
1797
|
-
'padColor'?: Array<number>;
|
|
1798
|
-
/**
|
|
1799
|
-
* Whether to return the coordinates of the rectangle with the face in the original image prepared for the face crop.
|
|
1800
|
-
* @type {boolean}
|
|
1801
|
-
* @memberof MatchRequestOutputImageParamsCrop
|
|
1802
|
-
*/
|
|
1803
|
-
'returnOriginalRect'?: boolean;
|
|
1804
|
-
/**
|
|
1805
|
-
* The resize value in case `type` matches this value. If it doesn\'t, no resize is performed.
|
|
1806
|
-
* @type {Array<number>}
|
|
1807
|
-
* @memberof MatchRequestOutputImageParamsCrop
|
|
1808
|
-
*/
|
|
1809
|
-
'size'?: Array<number>;
|
|
1810
|
-
/**
|
|
1811
|
-
* 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`.
|
|
1812
|
-
* @type {number}
|
|
1813
|
-
* @memberof MatchRequestOutputImageParamsCrop
|
|
1814
|
-
*/
|
|
1815
|
-
'type'?: MatchRequestOutputImageParamsCropTypeEnum;
|
|
1816
|
-
}
|
|
1817
|
-
export const MatchRequestOutputImageParamsCropTypeEnum: {
|
|
1818
|
-
readonly NUMBER_0: 0;
|
|
1819
|
-
readonly NUMBER_1: 1;
|
|
1820
|
-
readonly NUMBER_2: 2;
|
|
1821
|
-
readonly NUMBER_3: 3;
|
|
1822
|
-
readonly NUMBER_4: 4;
|
|
1823
|
-
};
|
|
1824
|
-
export type MatchRequestOutputImageParamsCropTypeEnum = (typeof MatchRequestOutputImageParamsCropTypeEnum)[keyof typeof MatchRequestOutputImageParamsCropTypeEnum];
|
|
1825
|
-
/**
|
|
1826
|
-
* Whether to process the uploaded image according to the indicated settings.
|
|
1827
|
-
* @export
|
|
1828
|
-
* @interface MatchRequestOutputImageParams
|
|
1829
|
-
*/
|
|
1830
|
-
export interface MatchRequestOutputImageParams {
|
|
1831
|
-
/**
|
|
1832
|
-
* The RGB value of a color for filling background behind a person\'s silhouette and for aligning the image.
|
|
1833
|
-
* @type {Array<number>}
|
|
1834
|
-
* @memberof MatchRequestOutputImageParams
|
|
1835
|
-
*/
|
|
1836
|
-
'backgroundColor'?: Array<number>;
|
|
1837
|
-
/**
|
|
1838
|
-
*
|
|
1839
|
-
* @type {MatchRequestOutputImageParamsCrop}
|
|
1840
|
-
* @memberof MatchRequestOutputImageParams
|
|
1841
|
-
*/
|
|
1842
|
-
'crop'?: MatchRequestOutputImageParamsCrop;
|
|
1843
|
-
}
|
|
1844
1585
|
/**
|
|
1845
1586
|
*
|
|
1846
1587
|
* @export
|
|
1847
1588
|
* @interface MatchRequest
|
|
1848
1589
|
*/
|
|
1849
|
-
export interface MatchRequest {
|
|
1850
|
-
/**
|
|
1851
|
-
* Session identificator, should be unique for each session.
|
|
1852
|
-
* @type {string}
|
|
1853
|
-
* @memberof MatchRequest
|
|
1854
|
-
*/
|
|
1855
|
-
'tag'?: string;
|
|
1856
|
-
/**
|
|
1857
|
-
* Use `outputImageParams.crop` instead.
|
|
1858
|
-
* @type {any}
|
|
1859
|
-
* @memberof MatchRequest
|
|
1860
|
-
* @deprecated
|
|
1861
|
-
*/
|
|
1862
|
-
'thumbnails'?: any;
|
|
1863
|
-
/**
|
|
1864
|
-
* All images included in the comparison.
|
|
1865
|
-
* @type {Array<MatchImage>}
|
|
1866
|
-
* @memberof MatchRequest
|
|
1867
|
-
*/
|
|
1868
|
-
'images': Array<MatchImage>;
|
|
1869
|
-
/**
|
|
1870
|
-
*
|
|
1871
|
-
* @type {MatchRequestOutputImageParams}
|
|
1872
|
-
* @memberof MatchRequest
|
|
1873
|
-
*/
|
|
1874
|
-
'outputImageParams'?: MatchRequestOutputImageParams;
|
|
1875
|
-
}
|
|
1876
|
-
/**
|
|
1877
|
-
*
|
|
1878
|
-
* @export
|
|
1879
|
-
* @interface MatchResponseAllOf
|
|
1880
|
-
*/
|
|
1881
|
-
export interface MatchResponseAllOf {
|
|
1882
|
-
/**
|
|
1883
|
-
* The detection results.
|
|
1884
|
-
* @type {Array<MatchImageDetection>}
|
|
1885
|
-
* @memberof MatchResponseAllOf
|
|
1886
|
-
*/
|
|
1887
|
-
'detections'?: Array<MatchImageDetection>;
|
|
1888
|
-
/**
|
|
1889
|
-
* The comparison results.
|
|
1890
|
-
* @type {Array<MatchImageResult>}
|
|
1891
|
-
* @memberof MatchResponseAllOf
|
|
1892
|
-
*/
|
|
1893
|
-
'results'?: Array<MatchImageResult>;
|
|
1894
|
-
/**
|
|
1895
|
-
* A free-form object containing person\'s extended attributes.
|
|
1896
|
-
* @type {{ [key: string]: object; }}
|
|
1897
|
-
* @memberof MatchResponseAllOf
|
|
1898
|
-
*/
|
|
1899
|
-
'metadata'?: {
|
|
1900
|
-
[key: string]: object;
|
|
1901
|
-
};
|
|
1902
|
-
}
|
|
1903
|
-
/**
|
|
1904
|
-
* @type MatchResponse
|
|
1905
|
-
* @export
|
|
1906
|
-
*/
|
|
1907
|
-
export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
|
|
1908
|
-
/**
|
|
1909
|
-
* Regula Face SDK Web API
|
|
1910
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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
|
|
1911
|
-
*
|
|
1912
|
-
* The version of the OpenAPI document: 6.1.0
|
|
1913
|
-
*
|
|
1914
|
-
*
|
|
1915
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1916
|
-
* https://openapi-generator.tech
|
|
1917
|
-
* Do not edit the class manually.
|
|
1918
|
-
*/
|
|
1919
|
-
/**
|
|
1920
|
-
*
|
|
1921
|
-
* @export
|
|
1922
|
-
* @interface OperationLog
|
|
1923
|
-
*/
|
|
1924
|
-
export interface OperationLog {
|
|
1925
|
-
/**
|
|
1926
|
-
* Status code.
|
|
1927
|
-
* @type {number}
|
|
1928
|
-
* @memberof OperationLog
|
|
1929
|
-
*/
|
|
1930
|
-
'statusCode'?: number;
|
|
1931
|
-
/**
|
|
1932
|
-
* Error type.
|
|
1933
|
-
* @type {string}
|
|
1934
|
-
* @memberof OperationLog
|
|
1935
|
-
*/
|
|
1936
|
-
'type'?: string;
|
|
1937
|
-
/**
|
|
1938
|
-
* Error message.
|
|
1939
|
-
* @type {string}
|
|
1940
|
-
* @memberof OperationLog
|
|
1941
|
-
*/
|
|
1942
|
-
'msg'?: string;
|
|
1943
|
-
/**
|
|
1944
|
-
* A free-form object containing group\'s extended attributes.
|
|
1945
|
-
* @type {{ [key: string]: object; }}
|
|
1946
|
-
* @memberof OperationLog
|
|
1947
|
-
*/
|
|
1948
|
-
'metadata'?: {
|
|
1949
|
-
[key: string]: object;
|
|
1950
|
-
};
|
|
1951
|
-
}
|
|
1952
|
-
/**
|
|
1953
|
-
* Regula Face SDK Web API
|
|
1954
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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
|
|
1955
|
-
*
|
|
1956
|
-
* The version of the OpenAPI document: 6.1.0
|
|
1957
|
-
*
|
|
1958
|
-
*
|
|
1959
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1960
|
-
* https://openapi-generator.tech
|
|
1961
|
-
* Do not edit the class manually.
|
|
1962
|
-
*/
|
|
1963
|
-
/**
|
|
1964
|
-
* Person Request body: name and metadata.
|
|
1965
|
-
* @export
|
|
1966
|
-
* @interface PersonToUpdateFields
|
|
1967
|
-
*/
|
|
1968
|
-
export interface PersonToUpdateFields {
|
|
1969
|
-
/**
|
|
1970
|
-
* 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.
|
|
1971
|
-
* @type {string}
|
|
1972
|
-
* @memberof PersonToUpdateFields
|
|
1973
|
-
*/
|
|
1974
|
-
'externalId'?: string;
|
|
1590
|
+
export interface MatchRequest {
|
|
1975
1591
|
/**
|
|
1976
|
-
*
|
|
1592
|
+
* Session identificator.
|
|
1977
1593
|
* @type {string}
|
|
1978
|
-
* @memberof
|
|
1594
|
+
* @memberof MatchRequest
|
|
1979
1595
|
*/
|
|
1980
|
-
'
|
|
1596
|
+
'tag'?: string;
|
|
1981
1597
|
/**
|
|
1982
|
-
*
|
|
1983
|
-
* @type {
|
|
1984
|
-
* @memberof
|
|
1598
|
+
* Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces.
|
|
1599
|
+
* @type {boolean}
|
|
1600
|
+
* @memberof MatchRequest
|
|
1985
1601
|
*/
|
|
1986
|
-
'
|
|
1987
|
-
[key: string]: object;
|
|
1988
|
-
};
|
|
1602
|
+
'thumbnails'?: boolean;
|
|
1989
1603
|
/**
|
|
1990
|
-
*
|
|
1991
|
-
* @type {Array<
|
|
1992
|
-
* @memberof
|
|
1604
|
+
* The array of all images included in the comparison.
|
|
1605
|
+
* @type {Array<MatchImage>}
|
|
1606
|
+
* @memberof MatchRequest
|
|
1993
1607
|
*/
|
|
1994
|
-
'
|
|
1608
|
+
'images': Array<MatchImage>;
|
|
1995
1609
|
}
|
|
1996
1610
|
/**
|
|
1997
1611
|
*
|
|
1998
1612
|
* @export
|
|
1999
|
-
* @interface
|
|
1613
|
+
* @interface MatchResponseAllOf
|
|
2000
1614
|
*/
|
|
2001
|
-
export interface
|
|
1615
|
+
export interface MatchResponseAllOf {
|
|
2002
1616
|
/**
|
|
2003
|
-
*
|
|
2004
|
-
* @type {Array<
|
|
2005
|
-
* @memberof
|
|
1617
|
+
* The array of detected faces.
|
|
1618
|
+
* @type {Array<MatchImageDetection>}
|
|
1619
|
+
* @memberof MatchResponseAllOf
|
|
2006
1620
|
*/
|
|
2007
|
-
'
|
|
1621
|
+
'detections'?: Array<MatchImageDetection>;
|
|
1622
|
+
/**
|
|
1623
|
+
* The array of matching results.
|
|
1624
|
+
* @type {Array<MatchImageResult>}
|
|
1625
|
+
* @memberof MatchResponseAllOf
|
|
1626
|
+
*/
|
|
1627
|
+
'results'?: Array<MatchImageResult>;
|
|
2008
1628
|
}
|
|
2009
1629
|
/**
|
|
2010
|
-
* @type
|
|
1630
|
+
* @type MatchResponse
|
|
2011
1631
|
* @export
|
|
2012
1632
|
*/
|
|
2013
|
-
export type
|
|
1633
|
+
export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
|
|
2014
1634
|
/**
|
|
2015
|
-
* Regula
|
|
2016
|
-
*
|
|
1635
|
+
* Regula FaceSDK Web API
|
|
1636
|
+
* 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
|
|
2017
1637
|
*
|
|
2018
|
-
* The version of the OpenAPI document:
|
|
1638
|
+
* The version of the OpenAPI document: 5.2.0
|
|
2019
1639
|
*
|
|
2020
1640
|
*
|
|
2021
1641
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2025,33 +1645,33 @@ export type PersonsPage = Page & PersonsPageAllOf;
|
|
|
2025
1645
|
/**
|
|
2026
1646
|
*
|
|
2027
1647
|
* @export
|
|
2028
|
-
* @interface
|
|
1648
|
+
* @interface OperationLog
|
|
2029
1649
|
*/
|
|
2030
|
-
export interface
|
|
2031
|
-
/**
|
|
2032
|
-
*
|
|
2033
|
-
* @type {string}
|
|
2034
|
-
* @memberof SearchBadParams
|
|
2035
|
-
*/
|
|
2036
|
-
'msg'?: string;
|
|
1650
|
+
export interface OperationLog {
|
|
2037
1651
|
/**
|
|
2038
|
-
*
|
|
1652
|
+
* Status code.
|
|
2039
1653
|
* @type {number}
|
|
2040
|
-
* @memberof
|
|
1654
|
+
* @memberof OperationLog
|
|
2041
1655
|
*/
|
|
2042
1656
|
'statusCode'?: number;
|
|
2043
1657
|
/**
|
|
2044
|
-
*
|
|
1658
|
+
* Error type.
|
|
2045
1659
|
* @type {string}
|
|
2046
|
-
* @memberof
|
|
1660
|
+
* @memberof OperationLog
|
|
2047
1661
|
*/
|
|
2048
1662
|
'type'?: string;
|
|
1663
|
+
/**
|
|
1664
|
+
* Error message.
|
|
1665
|
+
* @type {string}
|
|
1666
|
+
* @memberof OperationLog
|
|
1667
|
+
*/
|
|
1668
|
+
'msg'?: string;
|
|
2049
1669
|
}
|
|
2050
1670
|
/**
|
|
2051
|
-
* Regula
|
|
2052
|
-
*
|
|
1671
|
+
* Regula FaceSDK Web API
|
|
1672
|
+
* 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
|
|
2053
1673
|
*
|
|
2054
|
-
* The version of the OpenAPI document:
|
|
1674
|
+
* The version of the OpenAPI document: 5.2.0
|
|
2055
1675
|
*
|
|
2056
1676
|
*
|
|
2057
1677
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2131,63 +1751,6 @@ export interface SearchDetection {
|
|
|
2131
1751
|
*/
|
|
2132
1752
|
'versionSDK'?: string;
|
|
2133
1753
|
}
|
|
2134
|
-
/**
|
|
2135
|
-
* Regula Face SDK Web API
|
|
2136
|
-
* <a href=\"https://regulaforensics.com/products/face-recognition-sdk/ \" target=\"_blank\">Regula Face SDK</a> is a cross-platform biometric verification solution for a digital identity verification process and image quality assurance. The SDK enables convenient and reliable face capture on the client side (mobile, web, and desktop) and further processing on the client or server side. The Face SDK includes the following features: * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-detection\" target=\"_blank\">Face detection and image quality assessment</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-comparison-11\" target=\"_blank\">Face match (1:1)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#face-identification-1n\" target=\"_blank\">Face search (1:N)</a> * <a href=\"https://docs.regulaforensics.com/develop/face-sdk/overview/introduction/#liveness-assessment\" target=\"_blank\">Liveness detection</a> Here is the <a href=\"https://github.com/regulaforensics/FaceSDK-web-openapi \" target=\"_blank\">OpenAPI specification on GitHub</a>. ### 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
|
|
2137
|
-
*
|
|
2138
|
-
* The version of the OpenAPI document: 6.1.0
|
|
2139
|
-
*
|
|
2140
|
-
*
|
|
2141
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2142
|
-
* https://openapi-generator.tech
|
|
2143
|
-
* Do not edit the class manually.
|
|
2144
|
-
*/
|
|
2145
|
-
/**
|
|
2146
|
-
* If a person is not found, a new person entry is created using the descriptor calculated while searching.
|
|
2147
|
-
* @export
|
|
2148
|
-
* @interface SearchParametersCreatePerson
|
|
2149
|
-
*/
|
|
2150
|
-
export interface SearchParametersCreatePerson {
|
|
2151
|
-
/**
|
|
2152
|
-
* Person\'s name.
|
|
2153
|
-
* @type {string}
|
|
2154
|
-
* @memberof SearchParametersCreatePerson
|
|
2155
|
-
*/
|
|
2156
|
-
'name'?: string;
|
|
2157
|
-
/**
|
|
2158
|
-
* A free-form object containing person\'s extended attributes.
|
|
2159
|
-
* @type {{ [key: string]: object; }}
|
|
2160
|
-
* @memberof SearchParametersCreatePerson
|
|
2161
|
-
*/
|
|
2162
|
-
'metadata'?: {
|
|
2163
|
-
[key: string]: object;
|
|
2164
|
-
};
|
|
2165
|
-
}
|
|
2166
|
-
/**
|
|
2167
|
-
* Request search data.
|
|
2168
|
-
* @export
|
|
2169
|
-
* @interface SearchParameters
|
|
2170
|
-
*/
|
|
2171
|
-
export interface SearchParameters {
|
|
2172
|
-
/**
|
|
2173
|
-
*
|
|
2174
|
-
* @type {SearchParametersCreatePerson}
|
|
2175
|
-
* @memberof SearchParameters
|
|
2176
|
-
*/
|
|
2177
|
-
'createPerson'?: SearchParametersCreatePerson;
|
|
2178
|
-
/**
|
|
2179
|
-
* IDs of the groups in which the search is performed.
|
|
2180
|
-
* @type {Array<string>}
|
|
2181
|
-
* @memberof SearchParameters
|
|
2182
|
-
*/
|
|
2183
|
-
'groupIds'?: Array<string>;
|
|
2184
|
-
/**
|
|
2185
|
-
*
|
|
2186
|
-
* @type {FilterSearchRequest}
|
|
2187
|
-
* @memberof SearchParameters
|
|
2188
|
-
*/
|
|
2189
|
-
'filter'?: FilterSearchRequest;
|
|
2190
|
-
}
|
|
2191
1754
|
/**
|
|
2192
1755
|
* Person data.
|
|
2193
1756
|
* @export
|
|
@@ -2212,68 +1775,122 @@ export interface SearchPersonAllOf {
|
|
|
2212
1775
|
* @export
|
|
2213
1776
|
*/
|
|
2214
1777
|
export type SearchPerson = Person & SearchPersonAllOf;
|
|
2215
|
-
/**
|
|
2216
|
-
* @type SearchRequest
|
|
2217
|
-
* @export
|
|
2218
|
-
*/
|
|
2219
|
-
export type SearchRequest = ImageFields & SearchParameters;
|
|
2220
1778
|
/**
|
|
2221
1779
|
*
|
|
2222
1780
|
* @export
|
|
2223
|
-
* @interface
|
|
1781
|
+
* @interface PersonCreatedResponse
|
|
2224
1782
|
*/
|
|
2225
|
-
export interface
|
|
1783
|
+
export interface PersonCreatedResponse {
|
|
2226
1784
|
/**
|
|
2227
|
-
* Result code.
|
|
1785
|
+
* Result code.
|
|
2228
1786
|
* @type {number}
|
|
2229
|
-
* @memberof
|
|
1787
|
+
* @memberof PersonCreatedResponse
|
|
2230
1788
|
*/
|
|
2231
1789
|
'code'?: number;
|
|
2232
1790
|
/**
|
|
2233
|
-
* Array of Person images.
|
|
1791
|
+
* Array of Person images.
|
|
2234
1792
|
* @type {Array<SearchPerson>}
|
|
2235
|
-
* @memberof
|
|
1793
|
+
* @memberof PersonCreatedResponse
|
|
2236
1794
|
*/
|
|
2237
1795
|
'persons'?: Array<SearchPerson>;
|
|
2238
1796
|
/**
|
|
2239
|
-
*
|
|
2240
|
-
* @type {string}
|
|
2241
|
-
* @memberof
|
|
1797
|
+
* A free-form object containing person\'s extended attributes.
|
|
1798
|
+
* @type {{ [key: string]: object; }}
|
|
1799
|
+
* @memberof PersonCreatedResponse
|
|
2242
1800
|
*/
|
|
2243
|
-
'
|
|
1801
|
+
'metadata'?: {
|
|
1802
|
+
[key: string]: object;
|
|
1803
|
+
};
|
|
1804
|
+
}
|
|
1805
|
+
/**
|
|
1806
|
+
*
|
|
1807
|
+
* @export
|
|
1808
|
+
* @interface PersonsPageAllOf
|
|
1809
|
+
*/
|
|
1810
|
+
export interface PersonsPageAllOf {
|
|
2244
1811
|
/**
|
|
2245
|
-
*
|
|
2246
|
-
* @type {
|
|
2247
|
-
* @memberof
|
|
1812
|
+
*
|
|
1813
|
+
* @type {Array<Person>}
|
|
1814
|
+
* @memberof PersonsPageAllOf
|
|
2248
1815
|
*/
|
|
2249
|
-
'
|
|
1816
|
+
'items'?: Array<Person>;
|
|
1817
|
+
}
|
|
1818
|
+
/**
|
|
1819
|
+
* @type PersonsPage
|
|
1820
|
+
* @export
|
|
1821
|
+
*/
|
|
1822
|
+
export type PersonsPage = Page & PersonsPageAllOf;
|
|
1823
|
+
/**
|
|
1824
|
+
* Regula FaceSDK Web API
|
|
1825
|
+
* 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
|
|
1826
|
+
*
|
|
1827
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1828
|
+
*
|
|
1829
|
+
*
|
|
1830
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1831
|
+
* https://openapi-generator.tech
|
|
1832
|
+
* Do not edit the class manually.
|
|
1833
|
+
*/
|
|
1834
|
+
/**
|
|
1835
|
+
*
|
|
1836
|
+
* @export
|
|
1837
|
+
* @interface SearchBadParams
|
|
1838
|
+
*/
|
|
1839
|
+
export interface SearchBadParams {
|
|
2250
1840
|
/**
|
|
2251
|
-
*
|
|
1841
|
+
*
|
|
2252
1842
|
* @type {string}
|
|
2253
|
-
* @memberof
|
|
1843
|
+
* @memberof SearchBadParams
|
|
2254
1844
|
*/
|
|
2255
|
-
'
|
|
1845
|
+
'msg'?: string;
|
|
2256
1846
|
/**
|
|
2257
|
-
*
|
|
2258
|
-
* @type {
|
|
2259
|
-
* @memberof
|
|
1847
|
+
*
|
|
1848
|
+
* @type {number}
|
|
1849
|
+
* @memberof SearchBadParams
|
|
2260
1850
|
*/
|
|
2261
|
-
'
|
|
1851
|
+
'statusCode'?: number;
|
|
2262
1852
|
/**
|
|
2263
|
-
*
|
|
1853
|
+
*
|
|
2264
1854
|
* @type {string}
|
|
1855
|
+
* @memberof SearchBadParams
|
|
1856
|
+
*/
|
|
1857
|
+
'type'?: string;
|
|
1858
|
+
}
|
|
1859
|
+
/**
|
|
1860
|
+
* @type SearchRequest
|
|
1861
|
+
* @export
|
|
1862
|
+
*/
|
|
1863
|
+
export type SearchRequest = ImageFields & SearchParameters;
|
|
1864
|
+
/**
|
|
1865
|
+
*
|
|
1866
|
+
* @export
|
|
1867
|
+
* @interface SearchResult
|
|
1868
|
+
*/
|
|
1869
|
+
export interface SearchResult {
|
|
1870
|
+
/**
|
|
1871
|
+
* Search result code.
|
|
1872
|
+
* @type {number}
|
|
2265
1873
|
* @memberof SearchResult
|
|
2266
1874
|
*/
|
|
2267
|
-
'
|
|
1875
|
+
'code'?: number;
|
|
2268
1876
|
/**
|
|
2269
|
-
*
|
|
2270
|
-
* @type {
|
|
1877
|
+
* Person data.
|
|
1878
|
+
* @type {Array<SearchPerson>}
|
|
2271
1879
|
* @memberof SearchResult
|
|
2272
1880
|
*/
|
|
2273
|
-
'
|
|
2274
|
-
[key: string]: object;
|
|
2275
|
-
};
|
|
1881
|
+
'persons'?: Array<SearchPerson>;
|
|
2276
1882
|
}
|
|
1883
|
+
/**
|
|
1884
|
+
* Regula FaceSDK Web API
|
|
1885
|
+
* 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
|
|
1886
|
+
*
|
|
1887
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1888
|
+
*
|
|
1889
|
+
*
|
|
1890
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1891
|
+
* https://openapi-generator.tech
|
|
1892
|
+
* Do not edit the class manually.
|
|
1893
|
+
*/
|
|
2277
1894
|
/**
|
|
2278
1895
|
*
|
|
2279
1896
|
* @export
|
|
@@ -2281,19 +1898,19 @@ export interface SearchResult {
|
|
|
2281
1898
|
*/
|
|
2282
1899
|
export interface TransactionInfo {
|
|
2283
1900
|
/**
|
|
2284
|
-
* Result code,
|
|
1901
|
+
* Result code, one of the FaceSDKResultCode enum values. See the enum: https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-sdk-result-code/
|
|
2285
1902
|
* @type {number}
|
|
2286
1903
|
* @memberof TransactionInfo
|
|
2287
1904
|
*/
|
|
2288
1905
|
'code'?: number;
|
|
2289
1906
|
/**
|
|
2290
|
-
* Whether the liveness detection is confirmed
|
|
1907
|
+
* Whether the liveness detection is confirmed (0) or not (1).
|
|
2291
1908
|
* @type {number}
|
|
2292
1909
|
* @memberof TransactionInfo
|
|
2293
1910
|
*/
|
|
2294
1911
|
'status'?: number;
|
|
2295
1912
|
/**
|
|
2296
|
-
* Session identificator
|
|
1913
|
+
* Session identificator.
|
|
2297
1914
|
* @type {string}
|
|
2298
1915
|
* @memberof TransactionInfo
|
|
2299
1916
|
*/
|
|
@@ -2305,21 +1922,25 @@ export interface TransactionInfo {
|
|
|
2305
1922
|
*/
|
|
2306
1923
|
'transactionId'?: string;
|
|
2307
1924
|
/**
|
|
2308
|
-
* Link to the session video
|
|
1925
|
+
* Link to the session video.
|
|
2309
1926
|
* @type {string}
|
|
2310
1927
|
* @memberof TransactionInfo
|
|
2311
1928
|
*/
|
|
2312
1929
|
'video'?: string;
|
|
1930
|
+
/**
|
|
1931
|
+
* List of base64 images
|
|
1932
|
+
* @type {Array<string>}
|
|
1933
|
+
* @memberof TransactionInfo
|
|
1934
|
+
*/
|
|
1935
|
+
'images'?: Array<string>;
|
|
2313
1936
|
/**
|
|
2314
1937
|
* Approximate age with an accuracy of +/-3 years.
|
|
2315
|
-
* @type {
|
|
1938
|
+
* @type {number}
|
|
2316
1939
|
* @memberof TransactionInfo
|
|
2317
1940
|
*/
|
|
2318
|
-
'
|
|
2319
|
-
[key: string]: object;
|
|
2320
|
-
}>;
|
|
1941
|
+
'estimatedAge'?: number;
|
|
2321
1942
|
/**
|
|
2322
|
-
* Link to the portrait
|
|
1943
|
+
* Link to the portrait.
|
|
2323
1944
|
* @type {string}
|
|
2324
1945
|
* @memberof TransactionInfo
|
|
2325
1946
|
*/
|
|
@@ -2332,18 +1953,12 @@ export interface TransactionInfo {
|
|
|
2332
1953
|
'metadata'?: {
|
|
2333
1954
|
[key: string]: object;
|
|
2334
1955
|
};
|
|
2335
|
-
/**
|
|
2336
|
-
*
|
|
2337
|
-
* @type {LivenessType}
|
|
2338
|
-
* @memberof TransactionInfo
|
|
2339
|
-
*/
|
|
2340
|
-
'type'?: LivenessType;
|
|
2341
1956
|
}
|
|
2342
1957
|
/**
|
|
2343
|
-
* Regula
|
|
2344
|
-
*
|
|
1958
|
+
* Regula FaceSDK Web API
|
|
1959
|
+
* 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
|
|
2345
1960
|
*
|
|
2346
|
-
* The version of the OpenAPI document:
|
|
1961
|
+
* The version of the OpenAPI document: 5.2.0
|
|
2347
1962
|
*
|
|
2348
1963
|
*
|
|
2349
1964
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2369,96 +1984,10 @@ export interface UpdateGroup {
|
|
|
2369
1984
|
*/
|
|
2370
1985
|
'removeItems'?: Array<string>;
|
|
2371
1986
|
}
|
|
2372
|
-
type TDetection = {
|
|
2373
|
-
/**
|
|
2374
|
-
*
|
|
2375
|
-
* @type {ImageData}
|
|
2376
|
-
* @memberof Detection
|
|
2377
|
-
*/
|
|
2378
|
-
crop?: ImageData;
|
|
2379
|
-
/**
|
|
2380
|
-
*
|
|
2381
|
-
* @memberof Detection
|
|
2382
|
-
*/
|
|
2383
|
-
attributes?: {
|
|
2384
|
-
/**
|
|
2385
|
-
*
|
|
2386
|
-
* @type {Array<{ name?: string; confidence?: number; value?: any; }>}
|
|
2387
|
-
*/
|
|
2388
|
-
details?: {
|
|
2389
|
-
name?: string;
|
|
2390
|
-
confidence?: number;
|
|
2391
|
-
value?: any;
|
|
2392
|
-
}[];
|
|
2393
|
-
/**
|
|
2394
|
-
* The elapsed time for attribute detection.
|
|
2395
|
-
* @type {number}
|
|
2396
|
-
*/
|
|
2397
|
-
elapsedTime?: number;
|
|
2398
|
-
};
|
|
2399
|
-
/**
|
|
2400
|
-
* Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
|
|
2401
|
-
* @type {Array<Array<number>>}
|
|
2402
|
-
* @memberof Detection
|
|
2403
|
-
*/
|
|
2404
|
-
landmarks: Array<Array<number>>;
|
|
2405
|
-
/**
|
|
2406
|
-
*
|
|
2407
|
-
* @type {DetectionQuality}
|
|
2408
|
-
* @memberof Detection
|
|
2409
|
-
*/
|
|
2410
|
-
quality?: DetectionQuality;
|
|
2411
|
-
/**
|
|
2412
|
-
* 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.
|
|
2413
|
-
* @type {Array<number>}
|
|
2414
|
-
* @memberof Detection
|
|
2415
|
-
*/
|
|
2416
|
-
roi: Array<number>;
|
|
2417
|
-
/**
|
|
2418
|
-
* Base64 of the cropped portrait.
|
|
2419
|
-
* @type {string}
|
|
2420
|
-
* @memberof Detection
|
|
2421
|
-
*/
|
|
2422
|
-
thumbnail?: string;
|
|
2423
|
-
};
|
|
2424
|
-
type TDetectResponse = {
|
|
2425
|
-
results?: {
|
|
2426
|
-
/**
|
|
2427
|
-
*
|
|
2428
|
-
* @type {Array<Detection>}
|
|
2429
|
-
* @memberof DetectResult
|
|
2430
|
-
*/
|
|
2431
|
-
detections: Array<TDetection>;
|
|
2432
|
-
/**
|
|
2433
|
-
* Internal.
|
|
2434
|
-
* @type {number}
|
|
2435
|
-
* @memberof DetectResult
|
|
2436
|
-
*/
|
|
2437
|
-
detectorType?: number;
|
|
2438
|
-
/**
|
|
2439
|
-
* Internal.
|
|
2440
|
-
* @type {number}
|
|
2441
|
-
* @memberof DetectResult
|
|
2442
|
-
*/
|
|
2443
|
-
landmarksType?: number;
|
|
2444
|
-
/**
|
|
2445
|
-
*
|
|
2446
|
-
* @type {FaceQualityScenarios}
|
|
2447
|
-
* @memberof DetectResult
|
|
2448
|
-
*/
|
|
2449
|
-
scenario?: FaceQualityScenarios;
|
|
2450
|
-
/**
|
|
2451
|
-
* The total time taken for the detection.
|
|
2452
|
-
* @type {number}
|
|
2453
|
-
* @memberof DetectResult
|
|
2454
|
-
*/
|
|
2455
|
-
timer?: number;
|
|
2456
|
-
};
|
|
2457
|
-
} & FaceSDKResult;
|
|
2458
1987
|
declare class MatchingApi {
|
|
2459
1988
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
2460
|
-
match(compareRequest: MatchRequest, xRequestID
|
|
2461
|
-
detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<
|
|
1989
|
+
match(compareRequest: MatchRequest, xRequestID: string, options?: AxiosRequestConfig): Promise<MatchResponse>;
|
|
1990
|
+
detect(detectRequest: DetectRequest, xRequestID?: string, options?: AxiosRequestConfig): Promise<DetectResponse>;
|
|
2462
1991
|
}
|
|
2463
1992
|
declare class GroupApi {
|
|
2464
1993
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
@@ -2473,7 +2002,7 @@ declare class GroupApi {
|
|
|
2473
2002
|
declare class PersonApi {
|
|
2474
2003
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
2475
2004
|
createPerson(personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
|
|
2476
|
-
addImageToPerson(personId: string, imageFields:
|
|
2005
|
+
addImageToPerson(personId: string, imageFields: ImageFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Image>;
|
|
2477
2006
|
deleteImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
|
|
2478
2007
|
deletePerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
|
|
2479
2008
|
getAllGroupsByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
|
|
@@ -2492,7 +2021,7 @@ declare class DiagnosticsApi {
|
|
|
2492
2021
|
}
|
|
2493
2022
|
declare class Liveness20Api {
|
|
2494
2023
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
2495
|
-
getLivenessTransactionInfo(transactionId:
|
|
2024
|
+
getLivenessTransactionInfo(transactionId: number, options?: AxiosRequestConfig): Promise<TransactionInfo>;
|
|
2496
2025
|
}
|
|
2497
2026
|
export class FaceSdk {
|
|
2498
2027
|
protected basePath: string;
|