@regulaforensics/facesdk-webclient 6.3.4-nightly → 7.4.2-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 +473 -888
- 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.2.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).
|
|
@@ -250,7 +149,7 @@ export interface AddImageToPersonResponse {
|
|
|
250
149
|
* Do not edit the class manually.
|
|
251
150
|
*/
|
|
252
151
|
/**
|
|
253
|
-
*
|
|
152
|
+
* Face attributes.
|
|
254
153
|
* @export
|
|
255
154
|
* @enum {string}
|
|
256
155
|
*/
|
|
@@ -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.2.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. 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`.
|
|
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 a Base64-encoded image of an aligned and cropped portrait in the `crop` field. Alignment is performed according to `type`; if a head on the original image is tilted, for the returned portrait it is aligned in a straight vertical line. If there are more than one face in the photo, all the faces are detected and processed, and separate portraits for each face are returned. So, if there are five people in the photo, you\'ll get five processed portraits. Each portrait can be downloaded.
|
|
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).
|
|
@@ -350,7 +213,7 @@ export interface Crop {
|
|
|
350
213
|
* Do not edit the class manually.
|
|
351
214
|
*/
|
|
352
215
|
/**
|
|
353
|
-
* Face detection scenario.
|
|
216
|
+
* Face detection scenario.
|
|
354
217
|
* @export
|
|
355
218
|
* @enum {string}
|
|
356
219
|
*/
|
|
@@ -363,11 +226,10 @@ 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
|
/**
|
|
370
|
-
*
|
|
232
|
+
* Whether to process the uploaded image according to the indicated settings.
|
|
371
233
|
* @export
|
|
372
234
|
* @interface OutputImageParams
|
|
373
235
|
*/
|
|
@@ -386,106 +248,7 @@ export interface OutputImageParams {
|
|
|
386
248
|
'crop'?: Crop;
|
|
387
249
|
}
|
|
388
250
|
/**
|
|
389
|
-
*
|
|
390
|
-
* @export
|
|
391
|
-
* @interface ProcessParamAttributes
|
|
392
|
-
*/
|
|
393
|
-
export interface ProcessParamAttributes {
|
|
394
|
-
/**
|
|
395
|
-
* The list of attributes for evaluation.
|
|
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.2.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
|
-
* The name of the quality check characteristic. For definitions, see the [FaceQualityConfigName enum](https://docs.regulaforensics.com/develop/face-sdk/web-service/development/enums/face-quality-config-name/).
|
|
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 characteristic is identified as compliant with the requirements.
|
|
482
|
-
* @type {Array<number>}
|
|
483
|
-
* @memberof QualityConfig
|
|
484
|
-
*/
|
|
485
|
-
'range'?: Array<number>;
|
|
486
|
-
}
|
|
487
|
-
/**
|
|
488
|
-
* If set, the face image quality check is performed according to the set scenario or characteristics.
|
|
251
|
+
* Whether to perform the portrait quality check.
|
|
489
252
|
* @export
|
|
490
253
|
* @interface QualityRequest
|
|
491
254
|
*/
|
|
@@ -497,7 +260,7 @@ export interface QualityRequest {
|
|
|
497
260
|
*/
|
|
498
261
|
'backgroundMatchColor'?: Array<number>;
|
|
499
262
|
/**
|
|
500
|
-
*
|
|
263
|
+
*
|
|
501
264
|
* @type {Array<QualityConfig>}
|
|
502
265
|
* @memberof QualityRequest
|
|
503
266
|
*/
|
|
@@ -516,7 +279,7 @@ export interface ProcessParam {
|
|
|
516
279
|
*/
|
|
517
280
|
'scenario'?: FaceQualityScenarios;
|
|
518
281
|
/**
|
|
519
|
-
* Whether to process only the central face
|
|
282
|
+
* Whether to process only the central face on the image (true) or all the faces (false).
|
|
520
283
|
* @type {boolean}
|
|
521
284
|
* @memberof ProcessParam
|
|
522
285
|
*/
|
|
@@ -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,18 +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
|
-
* @deprecated
|
|
572
336
|
*/
|
|
573
337
|
'thumbnails'?: boolean;
|
|
338
|
+
/**
|
|
339
|
+
*
|
|
340
|
+
* @type {DetectRequestAttributes}
|
|
341
|
+
* @memberof DetectRequest
|
|
342
|
+
*/
|
|
343
|
+
'attributes'?: DetectRequestAttributes;
|
|
574
344
|
}
|
|
575
345
|
/**
|
|
576
|
-
* Regula
|
|
577
|
-
*
|
|
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
|
|
578
348
|
*
|
|
579
|
-
* The version of the OpenAPI document:
|
|
349
|
+
* The version of the OpenAPI document: 5.2.0
|
|
580
350
|
*
|
|
581
351
|
*
|
|
582
352
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -584,31 +354,66 @@ export interface DetectRequest {
|
|
|
584
354
|
* Do not edit the class manually.
|
|
585
355
|
*/
|
|
586
356
|
/**
|
|
587
|
-
*
|
|
357
|
+
* All image characteristics that can be assessed during face image quality assessment.
|
|
588
358
|
* @export
|
|
589
|
-
* @
|
|
359
|
+
* @enum {string}
|
|
590
360
|
*/
|
|
591
|
-
export
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
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];
|
|
607
412
|
/**
|
|
608
|
-
* Regula
|
|
609
|
-
*
|
|
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
|
|
610
415
|
*
|
|
611
|
-
* The version of the OpenAPI document:
|
|
416
|
+
* The version of the OpenAPI document: 5.2.0
|
|
612
417
|
*
|
|
613
418
|
*
|
|
614
419
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -632,10 +437,10 @@ export const FaceImageQualityGroups: {
|
|
|
632
437
|
};
|
|
633
438
|
export type FaceImageQualityGroups = (typeof FaceImageQualityGroups)[keyof typeof FaceImageQualityGroups];
|
|
634
439
|
/**
|
|
635
|
-
* Regula
|
|
636
|
-
*
|
|
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
|
|
637
442
|
*
|
|
638
|
-
* The version of the OpenAPI document:
|
|
443
|
+
* The version of the OpenAPI document: 5.2.0
|
|
639
444
|
*
|
|
640
445
|
*
|
|
641
446
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -691,10 +496,10 @@ export interface QualityDetail {
|
|
|
691
496
|
'value'?: number;
|
|
692
497
|
}
|
|
693
498
|
/**
|
|
694
|
-
* Regula
|
|
695
|
-
*
|
|
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
|
|
696
501
|
*
|
|
697
|
-
* The version of the OpenAPI document:
|
|
502
|
+
* The version of the OpenAPI document: 5.2.0
|
|
698
503
|
*
|
|
699
504
|
*
|
|
700
505
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -799,10 +604,12 @@ export interface Detection {
|
|
|
799
604
|
'crop'?: ImageData;
|
|
800
605
|
/**
|
|
801
606
|
*
|
|
802
|
-
* @type {
|
|
607
|
+
* @type {{ [key: string]: object; }}
|
|
803
608
|
* @memberof Detection
|
|
804
609
|
*/
|
|
805
|
-
'attributes'?:
|
|
610
|
+
'attributes'?: {
|
|
611
|
+
[key: string]: object;
|
|
612
|
+
};
|
|
806
613
|
/**
|
|
807
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.
|
|
808
615
|
* @type {Array<Array<number>>}
|
|
@@ -822,10 +629,9 @@ export interface Detection {
|
|
|
822
629
|
*/
|
|
823
630
|
'roi': Array<number>;
|
|
824
631
|
/**
|
|
825
|
-
*
|
|
632
|
+
* Base64 of the cropped portrait.
|
|
826
633
|
* @type {string}
|
|
827
634
|
* @memberof Detection
|
|
828
|
-
* @deprecated
|
|
829
635
|
*/
|
|
830
636
|
'thumbnail'?: string;
|
|
831
637
|
}
|
|
@@ -880,10 +686,10 @@ export interface DetectResponseAllOf {
|
|
|
880
686
|
'results'?: DetectResult;
|
|
881
687
|
}
|
|
882
688
|
/**
|
|
883
|
-
* Regula
|
|
884
|
-
*
|
|
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
|
|
885
691
|
*
|
|
886
|
-
* The version of the OpenAPI document:
|
|
692
|
+
* The version of the OpenAPI document: 5.2.0
|
|
887
693
|
*
|
|
888
694
|
*
|
|
889
695
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -891,7 +697,7 @@ export interface DetectResponseAllOf {
|
|
|
891
697
|
* Do not edit the class manually.
|
|
892
698
|
*/
|
|
893
699
|
/**
|
|
894
|
-
* 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/
|
|
895
701
|
* @export
|
|
896
702
|
* @enum {string}
|
|
897
703
|
*/
|
|
@@ -935,8 +741,6 @@ export const FaceSDKResultCode: {
|
|
|
935
741
|
readonly FACER_TIMEOUT_LIVENESS_TRANSACTION: 250;
|
|
936
742
|
readonly FACER_FAILED_LIVENESS_TRANSACTION: 251;
|
|
937
743
|
readonly FACER_ABORTED_LIVENESS_TRANSACTION: 252;
|
|
938
|
-
readonly FACER_GENERAL_ERROR: 253;
|
|
939
|
-
readonly FACER_PASSIVE_LIVENESS_FAIL: 254;
|
|
940
744
|
};
|
|
941
745
|
export type FaceSDKResultCode = (typeof FaceSDKResultCode)[keyof typeof FaceSDKResultCode];
|
|
942
746
|
/**
|
|
@@ -958,10 +762,10 @@ export interface FaceSDKResult {
|
|
|
958
762
|
*/
|
|
959
763
|
export type DetectResponse = DetectResponseAllOf & FaceSDKResult;
|
|
960
764
|
/**
|
|
961
|
-
* Regula
|
|
962
|
-
*
|
|
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
|
|
963
767
|
*
|
|
964
|
-
* The version of the OpenAPI document:
|
|
768
|
+
* The version of the OpenAPI document: 5.2.0
|
|
965
769
|
*
|
|
966
770
|
*
|
|
967
771
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -999,24 +803,17 @@ export interface DetectionFace {
|
|
|
999
803
|
*/
|
|
1000
804
|
'roi'?: Array<number>;
|
|
1001
805
|
/**
|
|
1002
|
-
*
|
|
806
|
+
* Base64 of the cropped portrait.
|
|
1003
807
|
* @type {string}
|
|
1004
808
|
* @memberof DetectionFace
|
|
1005
|
-
* @deprecated
|
|
1006
809
|
*/
|
|
1007
810
|
'thumbnail'?: string;
|
|
1008
|
-
/**
|
|
1009
|
-
* Base64-encoded aligned and cropped portrait.
|
|
1010
|
-
* @type {string}
|
|
1011
|
-
* @memberof DetectionFace
|
|
1012
|
-
*/
|
|
1013
|
-
'crop'?: string;
|
|
1014
811
|
}
|
|
1015
812
|
/**
|
|
1016
|
-
* Regula
|
|
1017
|
-
*
|
|
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
|
|
1018
815
|
*
|
|
1019
|
-
* The version of the OpenAPI document:
|
|
816
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1020
817
|
*
|
|
1021
818
|
*
|
|
1022
819
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1055,10 +852,10 @@ export interface PersonAllOf {
|
|
|
1055
852
|
'groups'?: Array<string>;
|
|
1056
853
|
}
|
|
1057
854
|
/**
|
|
1058
|
-
* Regula
|
|
1059
|
-
*
|
|
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
|
|
1060
857
|
*
|
|
1061
|
-
* The version of the OpenAPI document:
|
|
858
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1062
859
|
*
|
|
1063
860
|
*
|
|
1064
861
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1072,17 +869,17 @@ export interface PersonAllOf {
|
|
|
1072
869
|
*/
|
|
1073
870
|
export interface PersonFields {
|
|
1074
871
|
/**
|
|
1075
|
-
*
|
|
872
|
+
* Session identificator.
|
|
1076
873
|
* @type {string}
|
|
1077
874
|
* @memberof PersonFields
|
|
1078
875
|
*/
|
|
1079
|
-
'
|
|
876
|
+
'tag'?: string;
|
|
1080
877
|
/**
|
|
1081
|
-
* Person
|
|
878
|
+
* Person name.
|
|
1082
879
|
* @type {string}
|
|
1083
880
|
* @memberof PersonFields
|
|
1084
881
|
*/
|
|
1085
|
-
'
|
|
882
|
+
'name'?: string;
|
|
1086
883
|
/**
|
|
1087
884
|
* A free-form object containing person\'s extended attributes.
|
|
1088
885
|
* @type {{ [key: string]: object; }}
|
|
@@ -1097,12 +894,6 @@ export interface PersonFields {
|
|
|
1097
894
|
* @memberof PersonFields
|
|
1098
895
|
*/
|
|
1099
896
|
'groups'?: Array<string>;
|
|
1100
|
-
/**
|
|
1101
|
-
* The lifespan of the Person\'s records, seconds. Optional.
|
|
1102
|
-
* @type {number}
|
|
1103
|
-
* @memberof PersonFields
|
|
1104
|
-
*/
|
|
1105
|
-
'ttl'?: number | null;
|
|
1106
897
|
}
|
|
1107
898
|
/**
|
|
1108
899
|
* @type Person
|
|
@@ -1111,10 +902,10 @@ export interface PersonFields {
|
|
|
1111
902
|
*/
|
|
1112
903
|
export type Person = PersonAllOf & PersonFields;
|
|
1113
904
|
/**
|
|
1114
|
-
* Regula
|
|
1115
|
-
*
|
|
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
|
|
1116
907
|
*
|
|
1117
|
-
* The version of the OpenAPI document:
|
|
908
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1118
909
|
*
|
|
1119
910
|
*
|
|
1120
911
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1173,10 +964,10 @@ export interface Image {
|
|
|
1173
964
|
};
|
|
1174
965
|
}
|
|
1175
966
|
/**
|
|
1176
|
-
* Regula
|
|
1177
|
-
*
|
|
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
|
|
1178
969
|
*
|
|
1179
|
-
* The version of the OpenAPI document:
|
|
970
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1180
971
|
*
|
|
1181
972
|
*
|
|
1182
973
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1214,7 +1005,7 @@ export type RecognizeImage = Image & RecognizeImageAllOf;
|
|
|
1214
1005
|
*/
|
|
1215
1006
|
export interface PersonWithImagesAllOf {
|
|
1216
1007
|
/**
|
|
1217
|
-
*
|
|
1008
|
+
*
|
|
1218
1009
|
* @type {Array<RecognizeImage>}
|
|
1219
1010
|
* @memberof PersonWithImagesAllOf
|
|
1220
1011
|
*/
|
|
@@ -1224,82 +1015,36 @@ export interface PersonWithImagesAllOf {
|
|
|
1224
1015
|
* @type PersonWithImages
|
|
1225
1016
|
* @export
|
|
1226
1017
|
*/
|
|
1227
|
-
export type PersonWithImages = Person & PersonWithImagesAllOf;
|
|
1228
|
-
/**
|
|
1229
|
-
*
|
|
1230
|
-
* @export
|
|
1231
|
-
* @interface FacesResponseAllOf
|
|
1232
|
-
*/
|
|
1233
|
-
export interface FacesResponseAllOf {
|
|
1234
|
-
/**
|
|
1235
|
-
* Detected Persons.
|
|
1236
|
-
* @type {Array<PersonWithImages>}
|
|
1237
|
-
* @memberof FacesResponseAllOf
|
|
1238
|
-
*/
|
|
1239
|
-
'persons'?: Array<PersonWithImages>;
|
|
1240
|
-
/**
|
|
1241
|
-
*
|
|
1242
|
-
* @type {number}
|
|
1243
|
-
* @memberof FacesResponseAllOf
|
|
1244
|
-
*/
|
|
1245
|
-
'rotationAngle'?: number;
|
|
1246
|
-
}
|
|
1247
|
-
/**
|
|
1248
|
-
* @type FacesResponse
|
|
1249
|
-
* @export
|
|
1250
|
-
*/
|
|
1251
|
-
export type FacesResponse = DetectionFace & FacesResponseAllOf;
|
|
1252
|
-
/**
|
|
1253
|
-
* Regula Face SDK Web API
|
|
1254
|
-
* <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
|
|
1255
|
-
*
|
|
1256
|
-
* The version of the OpenAPI document: 6.2.0
|
|
1257
|
-
*
|
|
1258
|
-
*
|
|
1259
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1260
|
-
* https://openapi-generator.tech
|
|
1261
|
-
* Do not edit the class manually.
|
|
1262
|
-
*/
|
|
1263
|
-
/**
|
|
1264
|
-
* 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.
|
|
1265
|
-
* @export
|
|
1266
|
-
* @enum {string}
|
|
1267
|
-
*/
|
|
1268
|
-
export const FilterOp: {
|
|
1269
|
-
readonly IN: "in";
|
|
1270
|
-
readonly NOT_IN: "nin";
|
|
1271
|
-
};
|
|
1272
|
-
export type FilterOp = (typeof FilterOp)[keyof typeof FilterOp];
|
|
1018
|
+
export type PersonWithImages = Person & PersonWithImagesAllOf;
|
|
1273
1019
|
/**
|
|
1274
|
-
*
|
|
1020
|
+
*
|
|
1275
1021
|
* @export
|
|
1276
|
-
* @interface
|
|
1022
|
+
* @interface FacesResponseAllOf
|
|
1277
1023
|
*/
|
|
1278
|
-
export interface
|
|
1024
|
+
export interface FacesResponseAllOf {
|
|
1279
1025
|
/**
|
|
1280
1026
|
*
|
|
1281
|
-
* @type {
|
|
1282
|
-
* @memberof
|
|
1283
|
-
*/
|
|
1284
|
-
'op'?: FilterOp;
|
|
1285
|
-
/**
|
|
1286
|
-
* `name` of the Person.
|
|
1287
|
-
* @type {string}
|
|
1288
|
-
* @memberof FilterSearchRequest
|
|
1027
|
+
* @type {Array<PersonWithImages>}
|
|
1028
|
+
* @memberof FacesResponseAllOf
|
|
1289
1029
|
*/
|
|
1290
|
-
'
|
|
1030
|
+
'persons'?: Array<PersonWithImages>;
|
|
1291
1031
|
/**
|
|
1292
|
-
*
|
|
1293
|
-
* @type {
|
|
1294
|
-
* @memberof
|
|
1032
|
+
*
|
|
1033
|
+
* @type {number}
|
|
1034
|
+
* @memberof FacesResponseAllOf
|
|
1295
1035
|
*/
|
|
1296
|
-
'
|
|
1036
|
+
'rotationAngle'?: number;
|
|
1297
1037
|
}
|
|
1298
1038
|
/**
|
|
1299
|
-
*
|
|
1300
|
-
*
|
|
1039
|
+
* @type FacesResponse
|
|
1040
|
+
* @export
|
|
1041
|
+
*/
|
|
1042
|
+
export type FacesResponse = DetectionFace & FacesResponseAllOf;
|
|
1043
|
+
/**
|
|
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
|
|
1301
1046
|
*
|
|
1302
|
-
* The version of the OpenAPI document:
|
|
1047
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1303
1048
|
*
|
|
1304
1049
|
*
|
|
1305
1050
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1326,10 +1071,10 @@ export interface GroupAllOf {
|
|
|
1326
1071
|
'createdAt'?: string;
|
|
1327
1072
|
}
|
|
1328
1073
|
/**
|
|
1329
|
-
* Regula
|
|
1330
|
-
*
|
|
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
|
|
1331
1076
|
*
|
|
1332
|
-
* The version of the OpenAPI document:
|
|
1077
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1333
1078
|
*
|
|
1334
1079
|
*
|
|
1335
1080
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1337,21 +1082,27 @@ export interface GroupAllOf {
|
|
|
1337
1082
|
* Do not edit the class manually.
|
|
1338
1083
|
*/
|
|
1339
1084
|
/**
|
|
1340
|
-
*
|
|
1085
|
+
* Request body of the group to create data, includes name and metadata.
|
|
1341
1086
|
* @export
|
|
1342
|
-
* @interface
|
|
1087
|
+
* @interface GroupToCreate
|
|
1343
1088
|
*/
|
|
1344
|
-
export interface
|
|
1089
|
+
export interface GroupToCreate {
|
|
1090
|
+
/**
|
|
1091
|
+
* Session identificator.
|
|
1092
|
+
* @type {string}
|
|
1093
|
+
* @memberof GroupToCreate
|
|
1094
|
+
*/
|
|
1095
|
+
'tag'?: string;
|
|
1345
1096
|
/**
|
|
1346
1097
|
* Group to create name.
|
|
1347
1098
|
* @type {string}
|
|
1348
|
-
* @memberof
|
|
1099
|
+
* @memberof GroupToCreate
|
|
1349
1100
|
*/
|
|
1350
1101
|
'name'?: string;
|
|
1351
1102
|
/**
|
|
1352
1103
|
* A free-form object containing group\'s extended attributes.
|
|
1353
1104
|
* @type {{ [key: string]: object; }}
|
|
1354
|
-
* @memberof
|
|
1105
|
+
* @memberof GroupToCreate
|
|
1355
1106
|
*/
|
|
1356
1107
|
'metadata'?: {
|
|
1357
1108
|
[key: string]: object;
|
|
@@ -1361,7 +1112,7 @@ export interface GroupResponse {
|
|
|
1361
1112
|
* @type Group
|
|
1362
1113
|
* @export
|
|
1363
1114
|
*/
|
|
1364
|
-
export type Group = GroupAllOf &
|
|
1115
|
+
export type Group = GroupAllOf & GroupToCreate;
|
|
1365
1116
|
/**
|
|
1366
1117
|
*
|
|
1367
1118
|
* @export
|
|
@@ -1376,10 +1127,10 @@ export interface GroupPageAllOf {
|
|
|
1376
1127
|
'items'?: Array<Group>;
|
|
1377
1128
|
}
|
|
1378
1129
|
/**
|
|
1379
|
-
* Regula
|
|
1380
|
-
*
|
|
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
|
|
1381
1132
|
*
|
|
1382
|
-
* The version of the OpenAPI document:
|
|
1133
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1383
1134
|
*
|
|
1384
1135
|
*
|
|
1385
1136
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1411,10 +1162,10 @@ export interface Page {
|
|
|
1411
1162
|
*/
|
|
1412
1163
|
export type GroupPage = GroupPageAllOf & Page;
|
|
1413
1164
|
/**
|
|
1414
|
-
* Regula
|
|
1415
|
-
*
|
|
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
|
|
1416
1167
|
*
|
|
1417
|
-
* The version of the OpenAPI document:
|
|
1168
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1418
1169
|
*
|
|
1419
1170
|
*
|
|
1420
1171
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1422,31 +1173,60 @@ export type GroupPage = GroupPageAllOf & Page;
|
|
|
1422
1173
|
* Do not edit the class manually.
|
|
1423
1174
|
*/
|
|
1424
1175
|
/**
|
|
1425
|
-
*
|
|
1176
|
+
* Set to resize the original image.
|
|
1426
1177
|
* @export
|
|
1427
|
-
* @interface
|
|
1178
|
+
* @interface ResizeOptions
|
|
1428
1179
|
*/
|
|
1429
|
-
export interface
|
|
1180
|
+
export interface ResizeOptions {
|
|
1430
1181
|
/**
|
|
1431
|
-
*
|
|
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;
|
|
1199
|
+
}
|
|
1200
|
+
/**
|
|
1201
|
+
* Uploaded image.
|
|
1202
|
+
* @export
|
|
1203
|
+
* @interface ImageFieldsImage
|
|
1204
|
+
*/
|
|
1205
|
+
export interface ImageFieldsImage {
|
|
1206
|
+
/**
|
|
1207
|
+
* Original media type of the uploaded image.
|
|
1432
1208
|
* @type {string}
|
|
1433
|
-
* @memberof
|
|
1209
|
+
* @memberof ImageFieldsImage
|
|
1434
1210
|
*/
|
|
1435
|
-
'
|
|
1211
|
+
'contentType'?: string;
|
|
1436
1212
|
/**
|
|
1437
|
-
*
|
|
1213
|
+
*
|
|
1214
|
+
* @type {ImageData}
|
|
1215
|
+
* @memberof ImageFieldsImage
|
|
1216
|
+
*/
|
|
1217
|
+
'content'?: ImageData;
|
|
1218
|
+
/**
|
|
1219
|
+
* Image URL.
|
|
1438
1220
|
* @type {string}
|
|
1439
|
-
* @memberof
|
|
1221
|
+
* @memberof ImageFieldsImage
|
|
1440
1222
|
*/
|
|
1441
|
-
'
|
|
1223
|
+
'imageUrl'?: string;
|
|
1442
1224
|
/**
|
|
1443
|
-
*
|
|
1444
|
-
* @type {
|
|
1445
|
-
* @memberof
|
|
1225
|
+
*
|
|
1226
|
+
* @type {ResizeOptions}
|
|
1227
|
+
* @memberof ImageFieldsImage
|
|
1446
1228
|
*/
|
|
1447
|
-
'
|
|
1448
|
-
[key: string]: object;
|
|
1449
|
-
};
|
|
1229
|
+
'resizeOptions'?: ResizeOptions;
|
|
1450
1230
|
}
|
|
1451
1231
|
/**
|
|
1452
1232
|
* Image in the request data, includes image and contentType.
|
|
@@ -1455,17 +1235,17 @@ export interface GroupToCreate {
|
|
|
1455
1235
|
*/
|
|
1456
1236
|
export interface ImageFields {
|
|
1457
1237
|
/**
|
|
1458
|
-
* Session identificator
|
|
1238
|
+
* Session identificator.
|
|
1459
1239
|
* @type {string}
|
|
1460
1240
|
* @memberof ImageFields
|
|
1461
1241
|
*/
|
|
1462
1242
|
'tag'?: string;
|
|
1463
1243
|
/**
|
|
1464
1244
|
*
|
|
1465
|
-
* @type {
|
|
1245
|
+
* @type {ImageFieldsImage}
|
|
1466
1246
|
* @memberof ImageFields
|
|
1467
1247
|
*/
|
|
1468
|
-
'image'?:
|
|
1248
|
+
'image'?: ImageFieldsImage;
|
|
1469
1249
|
/**
|
|
1470
1250
|
*
|
|
1471
1251
|
* @type {OutputImageParams}
|
|
@@ -1473,7 +1253,7 @@ export interface ImageFields {
|
|
|
1473
1253
|
*/
|
|
1474
1254
|
'outputImageParams'?: OutputImageParams;
|
|
1475
1255
|
/**
|
|
1476
|
-
* 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.
|
|
1477
1257
|
* @type {boolean}
|
|
1478
1258
|
* @memberof ImageFields
|
|
1479
1259
|
*/
|
|
@@ -1510,10 +1290,10 @@ export interface ImagePageAllOf {
|
|
|
1510
1290
|
*/
|
|
1511
1291
|
export type ImagePage = ImagePageAllOf & Page;
|
|
1512
1292
|
/**
|
|
1513
|
-
* Regula
|
|
1514
|
-
*
|
|
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
|
|
1515
1295
|
*
|
|
1516
|
-
* The version of the OpenAPI document:
|
|
1296
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1517
1297
|
*
|
|
1518
1298
|
*
|
|
1519
1299
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1521,7 +1301,7 @@ export type ImagePage = ImagePageAllOf & Page;
|
|
|
1521
1301
|
* Do not edit the class manually.
|
|
1522
1302
|
*/
|
|
1523
1303
|
/**
|
|
1524
|
-
* 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/
|
|
1525
1305
|
* @export
|
|
1526
1306
|
* @enum {string}
|
|
1527
1307
|
*/
|
|
@@ -1532,30 +1312,8 @@ export const ImageSource: {
|
|
|
1532
1312
|
readonly DOCUMENT_WITH_LIVE: 4;
|
|
1533
1313
|
readonly EXTERNAL: 5;
|
|
1534
1314
|
readonly GHOST: 6;
|
|
1535
|
-
readonly BARCODE: 7;
|
|
1536
1315
|
};
|
|
1537
1316
|
export type ImageSource = (typeof ImageSource)[keyof typeof ImageSource];
|
|
1538
|
-
/**
|
|
1539
|
-
* Regula Face SDK Web API
|
|
1540
|
-
* <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
|
|
1541
|
-
*
|
|
1542
|
-
* The version of the OpenAPI document: 6.2.0
|
|
1543
|
-
*
|
|
1544
|
-
*
|
|
1545
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1546
|
-
* https://openapi-generator.tech
|
|
1547
|
-
* Do not edit the class manually.
|
|
1548
|
-
*/
|
|
1549
|
-
/**
|
|
1550
|
-
* 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)
|
|
1551
|
-
* @export
|
|
1552
|
-
* @enum {string}
|
|
1553
|
-
*/
|
|
1554
|
-
export const LivenessType: {
|
|
1555
|
-
readonly ACTIVE: 0;
|
|
1556
|
-
readonly PASSIVE: 1;
|
|
1557
|
-
};
|
|
1558
|
-
export type LivenessType = (typeof LivenessType)[keyof typeof LivenessType];
|
|
1559
1317
|
/**
|
|
1560
1318
|
*
|
|
1561
1319
|
* @export
|
|
@@ -1582,29 +1340,74 @@ export interface MatchAndSearchRequestAllOfImages {
|
|
|
1582
1340
|
*/
|
|
1583
1341
|
export interface MatchAndSearchRequestAllOf {
|
|
1584
1342
|
/**
|
|
1585
|
-
* Session identificator
|
|
1343
|
+
* Session identificator.
|
|
1586
1344
|
* @type {string}
|
|
1587
1345
|
* @memberof MatchAndSearchRequestAllOf
|
|
1588
1346
|
*/
|
|
1589
1347
|
'tag'?: string;
|
|
1590
1348
|
/**
|
|
1591
|
-
* Person
|
|
1349
|
+
* Array of Person images.
|
|
1592
1350
|
* @type {Array<MatchAndSearchRequestAllOfImages>}
|
|
1593
1351
|
* @memberof MatchAndSearchRequestAllOf
|
|
1594
1352
|
*/
|
|
1595
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;
|
|
1596
1399
|
/**
|
|
1597
1400
|
* IDs of the groups in which the search is performed.
|
|
1598
|
-
* @type {Array<
|
|
1599
|
-
* @memberof
|
|
1401
|
+
* @type {Array<number>}
|
|
1402
|
+
* @memberof SearchParameters
|
|
1600
1403
|
*/
|
|
1601
|
-
'groupIds'?: Array<
|
|
1404
|
+
'groupIds'?: Array<number>;
|
|
1602
1405
|
}
|
|
1603
1406
|
/**
|
|
1604
1407
|
* @type MatchAndSearchRequest
|
|
1605
1408
|
* @export
|
|
1606
1409
|
*/
|
|
1607
|
-
export type MatchAndSearchRequest = MatchAndSearchRequestAllOf;
|
|
1410
|
+
export type MatchAndSearchRequest = MatchAndSearchRequestAllOf & SearchParameters;
|
|
1608
1411
|
/**
|
|
1609
1412
|
*
|
|
1610
1413
|
* @export
|
|
@@ -1612,13 +1415,13 @@ export type MatchAndSearchRequest = MatchAndSearchRequestAllOf;
|
|
|
1612
1415
|
*/
|
|
1613
1416
|
export interface MatchAndSearchResponseAllOfDetections {
|
|
1614
1417
|
/**
|
|
1615
|
-
*
|
|
1418
|
+
*
|
|
1616
1419
|
* @type {Array<FacesResponse>}
|
|
1617
1420
|
* @memberof MatchAndSearchResponseAllOfDetections
|
|
1618
1421
|
*/
|
|
1619
1422
|
'faces'?: Array<FacesResponse>;
|
|
1620
1423
|
/**
|
|
1621
|
-
* 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.
|
|
1622
1425
|
* @type {number}
|
|
1623
1426
|
* @memberof MatchAndSearchResponseAllOfDetections
|
|
1624
1427
|
*/
|
|
@@ -1637,7 +1440,7 @@ export interface MatchAndSearchResponseAllOfDetections {
|
|
|
1637
1440
|
*/
|
|
1638
1441
|
export interface MatchImageResult {
|
|
1639
1442
|
/**
|
|
1640
|
-
* 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.
|
|
1641
1444
|
* @type {number}
|
|
1642
1445
|
* @memberof MatchImageResult
|
|
1643
1446
|
*/
|
|
@@ -1655,7 +1458,7 @@ export interface MatchImageResult {
|
|
|
1655
1458
|
*/
|
|
1656
1459
|
'first'?: ImageSource;
|
|
1657
1460
|
/**
|
|
1658
|
-
* 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.
|
|
1659
1462
|
* @type {number}
|
|
1660
1463
|
* @memberof MatchImageResult
|
|
1661
1464
|
*/
|
|
@@ -1692,13 +1495,13 @@ export interface MatchImageResult {
|
|
|
1692
1495
|
*/
|
|
1693
1496
|
export interface MatchAndSearchResponseAllOf {
|
|
1694
1497
|
/**
|
|
1695
|
-
*
|
|
1498
|
+
*
|
|
1696
1499
|
* @type {Array<MatchImageResult>}
|
|
1697
1500
|
* @memberof MatchAndSearchResponseAllOf
|
|
1698
1501
|
*/
|
|
1699
1502
|
'results'?: Array<MatchImageResult>;
|
|
1700
1503
|
/**
|
|
1701
|
-
*
|
|
1504
|
+
*
|
|
1702
1505
|
* @type {number}
|
|
1703
1506
|
* @memberof MatchAndSearchResponseAllOf
|
|
1704
1507
|
*/
|
|
@@ -1712,7 +1515,7 @@ export interface MatchAndSearchResponseAllOf {
|
|
|
1712
1515
|
[key: string]: object;
|
|
1713
1516
|
};
|
|
1714
1517
|
/**
|
|
1715
|
-
*
|
|
1518
|
+
*
|
|
1716
1519
|
* @type {Array<MatchAndSearchResponseAllOfDetections>}
|
|
1717
1520
|
* @memberof MatchAndSearchResponseAllOf
|
|
1718
1521
|
*/
|
|
@@ -1730,7 +1533,7 @@ export type MatchAndSearchResponse = FaceSDKResult & MatchAndSearchResponseAllOf
|
|
|
1730
1533
|
*/
|
|
1731
1534
|
export interface MatchImage {
|
|
1732
1535
|
/**
|
|
1733
|
-
* 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.
|
|
1734
1537
|
* @type {number}
|
|
1735
1538
|
* @memberof MatchImage
|
|
1736
1539
|
*/
|
|
@@ -1748,7 +1551,7 @@ export interface MatchImage {
|
|
|
1748
1551
|
*/
|
|
1749
1552
|
'data': ImageData;
|
|
1750
1553
|
/**
|
|
1751
|
-
* 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.
|
|
1752
1555
|
* @type {boolean}
|
|
1753
1556
|
* @memberof MatchImage
|
|
1754
1557
|
*/
|
|
@@ -1761,13 +1564,13 @@ export interface MatchImage {
|
|
|
1761
1564
|
*/
|
|
1762
1565
|
export interface MatchImageDetection {
|
|
1763
1566
|
/**
|
|
1764
|
-
*
|
|
1567
|
+
* The array of detected faces.
|
|
1765
1568
|
* @type {Array<DetectionFace>}
|
|
1766
1569
|
* @memberof MatchImageDetection
|
|
1767
1570
|
*/
|
|
1768
1571
|
'faces'?: Array<DetectionFace>;
|
|
1769
1572
|
/**
|
|
1770
|
-
* 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.
|
|
1771
1574
|
* @type {number}
|
|
1772
1575
|
* @memberof MatchImageDetection
|
|
1773
1576
|
*/
|
|
@@ -1786,174 +1589,53 @@ export interface MatchImageDetection {
|
|
|
1786
1589
|
*/
|
|
1787
1590
|
export interface MatchRequest {
|
|
1788
1591
|
/**
|
|
1789
|
-
* Session identificator
|
|
1592
|
+
* Session identificator.
|
|
1790
1593
|
* @type {string}
|
|
1791
1594
|
* @memberof MatchRequest
|
|
1792
1595
|
*/
|
|
1793
|
-
'tag'?: string;
|
|
1794
|
-
/**
|
|
1795
|
-
* Use `outputImageParams.crop` instead.
|
|
1796
|
-
* @type {any}
|
|
1797
|
-
* @memberof MatchRequest
|
|
1798
|
-
* @deprecated
|
|
1799
|
-
*/
|
|
1800
|
-
'thumbnails'?: any;
|
|
1801
|
-
/**
|
|
1802
|
-
* All images included in the comparison.
|
|
1803
|
-
* @type {Array<MatchImage>}
|
|
1804
|
-
* @memberof MatchRequest
|
|
1805
|
-
*/
|
|
1806
|
-
'images': Array<MatchImage>;
|
|
1807
|
-
/**
|
|
1808
|
-
*
|
|
1809
|
-
* @type {OutputImageParams}
|
|
1810
|
-
* @memberof MatchRequest
|
|
1811
|
-
*/
|
|
1812
|
-
'outputImageParams'?: OutputImageParams;
|
|
1813
|
-
}
|
|
1814
|
-
/**
|
|
1815
|
-
*
|
|
1816
|
-
* @export
|
|
1817
|
-
* @interface MatchResponseAllOf
|
|
1818
|
-
*/
|
|
1819
|
-
export interface MatchResponseAllOf {
|
|
1820
|
-
/**
|
|
1821
|
-
* The detection results.
|
|
1822
|
-
* @type {Array<MatchImageDetection>}
|
|
1823
|
-
* @memberof MatchResponseAllOf
|
|
1824
|
-
*/
|
|
1825
|
-
'detections'?: Array<MatchImageDetection>;
|
|
1826
|
-
/**
|
|
1827
|
-
* The comparison results.
|
|
1828
|
-
* @type {Array<MatchImageResult>}
|
|
1829
|
-
* @memberof MatchResponseAllOf
|
|
1830
|
-
*/
|
|
1831
|
-
'results'?: Array<MatchImageResult>;
|
|
1832
|
-
/**
|
|
1833
|
-
* A free-form object containing person\'s extended attributes.
|
|
1834
|
-
* @type {{ [key: string]: object; }}
|
|
1835
|
-
* @memberof MatchResponseAllOf
|
|
1836
|
-
*/
|
|
1837
|
-
'metadata'?: {
|
|
1838
|
-
[key: string]: object;
|
|
1839
|
-
};
|
|
1840
|
-
}
|
|
1841
|
-
/**
|
|
1842
|
-
* @type MatchResponse
|
|
1843
|
-
* @export
|
|
1844
|
-
*/
|
|
1845
|
-
export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
|
|
1846
|
-
/**
|
|
1847
|
-
* Regula Face SDK Web API
|
|
1848
|
-
* <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
|
|
1849
|
-
*
|
|
1850
|
-
* The version of the OpenAPI document: 6.2.0
|
|
1851
|
-
*
|
|
1852
|
-
*
|
|
1853
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1854
|
-
* https://openapi-generator.tech
|
|
1855
|
-
* Do not edit the class manually.
|
|
1856
|
-
*/
|
|
1857
|
-
/**
|
|
1858
|
-
*
|
|
1859
|
-
* @export
|
|
1860
|
-
* @interface OperationLog
|
|
1861
|
-
*/
|
|
1862
|
-
export interface OperationLog {
|
|
1863
|
-
/**
|
|
1864
|
-
* Status code.
|
|
1865
|
-
* @type {number}
|
|
1866
|
-
* @memberof OperationLog
|
|
1867
|
-
*/
|
|
1868
|
-
'statusCode'?: number;
|
|
1869
|
-
/**
|
|
1870
|
-
* Error type.
|
|
1871
|
-
* @type {string}
|
|
1872
|
-
* @memberof OperationLog
|
|
1873
|
-
*/
|
|
1874
|
-
'type'?: string;
|
|
1875
|
-
/**
|
|
1876
|
-
* Error message.
|
|
1877
|
-
* @type {string}
|
|
1878
|
-
* @memberof OperationLog
|
|
1879
|
-
*/
|
|
1880
|
-
'msg'?: string;
|
|
1881
|
-
/**
|
|
1882
|
-
* A free-form object containing group\'s extended attributes.
|
|
1883
|
-
* @type {{ [key: string]: object; }}
|
|
1884
|
-
* @memberof OperationLog
|
|
1885
|
-
*/
|
|
1886
|
-
'metadata'?: {
|
|
1887
|
-
[key: string]: object;
|
|
1888
|
-
};
|
|
1889
|
-
}
|
|
1890
|
-
/**
|
|
1891
|
-
* Regula Face SDK Web API
|
|
1892
|
-
* <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
|
|
1893
|
-
*
|
|
1894
|
-
* The version of the OpenAPI document: 6.2.0
|
|
1895
|
-
*
|
|
1896
|
-
*
|
|
1897
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1898
|
-
* https://openapi-generator.tech
|
|
1899
|
-
* Do not edit the class manually.
|
|
1900
|
-
*/
|
|
1901
|
-
/**
|
|
1902
|
-
* Person Request body: name and metadata.
|
|
1903
|
-
* @export
|
|
1904
|
-
* @interface PersonToUpdateFields
|
|
1905
|
-
*/
|
|
1906
|
-
export interface PersonToUpdateFields {
|
|
1907
|
-
/**
|
|
1908
|
-
* 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.
|
|
1909
|
-
* @type {string}
|
|
1910
|
-
* @memberof PersonToUpdateFields
|
|
1911
|
-
*/
|
|
1912
|
-
'externalId'?: string;
|
|
1913
|
-
/**
|
|
1914
|
-
* Person\'s name.
|
|
1915
|
-
* @type {string}
|
|
1916
|
-
* @memberof PersonToUpdateFields
|
|
1917
|
-
*/
|
|
1918
|
-
'name'?: string;
|
|
1596
|
+
'tag'?: string;
|
|
1919
1597
|
/**
|
|
1920
|
-
*
|
|
1921
|
-
* @type {
|
|
1922
|
-
* @memberof
|
|
1598
|
+
* Whether to return thumbnails: Base64 cropped images that contain vertically aligned faces.
|
|
1599
|
+
* @type {boolean}
|
|
1600
|
+
* @memberof MatchRequest
|
|
1923
1601
|
*/
|
|
1924
|
-
'
|
|
1925
|
-
[key: string]: object;
|
|
1926
|
-
};
|
|
1602
|
+
'thumbnails'?: boolean;
|
|
1927
1603
|
/**
|
|
1928
|
-
*
|
|
1929
|
-
* @type {Array<
|
|
1930
|
-
* @memberof
|
|
1604
|
+
* The array of all images included in the comparison.
|
|
1605
|
+
* @type {Array<MatchImage>}
|
|
1606
|
+
* @memberof MatchRequest
|
|
1931
1607
|
*/
|
|
1932
|
-
'
|
|
1608
|
+
'images': Array<MatchImage>;
|
|
1933
1609
|
}
|
|
1934
1610
|
/**
|
|
1935
1611
|
*
|
|
1936
1612
|
* @export
|
|
1937
|
-
* @interface
|
|
1613
|
+
* @interface MatchResponseAllOf
|
|
1938
1614
|
*/
|
|
1939
|
-
export interface
|
|
1615
|
+
export interface MatchResponseAllOf {
|
|
1940
1616
|
/**
|
|
1941
|
-
*
|
|
1942
|
-
* @type {Array<
|
|
1943
|
-
* @memberof
|
|
1617
|
+
* The array of detected faces.
|
|
1618
|
+
* @type {Array<MatchImageDetection>}
|
|
1619
|
+
* @memberof MatchResponseAllOf
|
|
1944
1620
|
*/
|
|
1945
|
-
'
|
|
1621
|
+
'detections'?: Array<MatchImageDetection>;
|
|
1622
|
+
/**
|
|
1623
|
+
* The array of matching results.
|
|
1624
|
+
* @type {Array<MatchImageResult>}
|
|
1625
|
+
* @memberof MatchResponseAllOf
|
|
1626
|
+
*/
|
|
1627
|
+
'results'?: Array<MatchImageResult>;
|
|
1946
1628
|
}
|
|
1947
1629
|
/**
|
|
1948
|
-
* @type
|
|
1630
|
+
* @type MatchResponse
|
|
1949
1631
|
* @export
|
|
1950
1632
|
*/
|
|
1951
|
-
export type
|
|
1633
|
+
export type MatchResponse = FaceSDKResult & MatchResponseAllOf;
|
|
1952
1634
|
/**
|
|
1953
|
-
* Regula
|
|
1954
|
-
*
|
|
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
|
|
1955
1637
|
*
|
|
1956
|
-
* The version of the OpenAPI document:
|
|
1638
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1957
1639
|
*
|
|
1958
1640
|
*
|
|
1959
1641
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1963,33 +1645,33 @@ export type PersonsPage = Page & PersonsPageAllOf;
|
|
|
1963
1645
|
/**
|
|
1964
1646
|
*
|
|
1965
1647
|
* @export
|
|
1966
|
-
* @interface
|
|
1648
|
+
* @interface OperationLog
|
|
1967
1649
|
*/
|
|
1968
|
-
export interface
|
|
1969
|
-
/**
|
|
1970
|
-
*
|
|
1971
|
-
* @type {string}
|
|
1972
|
-
* @memberof SearchBadParams
|
|
1973
|
-
*/
|
|
1974
|
-
'msg'?: string;
|
|
1650
|
+
export interface OperationLog {
|
|
1975
1651
|
/**
|
|
1976
|
-
*
|
|
1652
|
+
* Status code.
|
|
1977
1653
|
* @type {number}
|
|
1978
|
-
* @memberof
|
|
1654
|
+
* @memberof OperationLog
|
|
1979
1655
|
*/
|
|
1980
1656
|
'statusCode'?: number;
|
|
1981
1657
|
/**
|
|
1982
|
-
*
|
|
1658
|
+
* Error type.
|
|
1983
1659
|
* @type {string}
|
|
1984
|
-
* @memberof
|
|
1660
|
+
* @memberof OperationLog
|
|
1985
1661
|
*/
|
|
1986
1662
|
'type'?: string;
|
|
1663
|
+
/**
|
|
1664
|
+
* Error message.
|
|
1665
|
+
* @type {string}
|
|
1666
|
+
* @memberof OperationLog
|
|
1667
|
+
*/
|
|
1668
|
+
'msg'?: string;
|
|
1987
1669
|
}
|
|
1988
1670
|
/**
|
|
1989
|
-
* Regula
|
|
1990
|
-
*
|
|
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
|
|
1991
1673
|
*
|
|
1992
|
-
* The version of the OpenAPI document:
|
|
1674
|
+
* The version of the OpenAPI document: 5.2.0
|
|
1993
1675
|
*
|
|
1994
1676
|
*
|
|
1995
1677
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2069,69 +1751,6 @@ export interface SearchDetection {
|
|
|
2069
1751
|
*/
|
|
2070
1752
|
'versionSDK'?: string;
|
|
2071
1753
|
}
|
|
2072
|
-
/**
|
|
2073
|
-
* Regula Face SDK Web API
|
|
2074
|
-
* <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
|
|
2075
|
-
*
|
|
2076
|
-
* The version of the OpenAPI document: 6.2.0
|
|
2077
|
-
*
|
|
2078
|
-
*
|
|
2079
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
2080
|
-
* https://openapi-generator.tech
|
|
2081
|
-
* Do not edit the class manually.
|
|
2082
|
-
*/
|
|
2083
|
-
/**
|
|
2084
|
-
* If a person is not found, a new person entry is created using the descriptor calculated while searching.
|
|
2085
|
-
* @export
|
|
2086
|
-
* @interface SearchParametersCreatePerson
|
|
2087
|
-
*/
|
|
2088
|
-
export interface SearchParametersCreatePerson {
|
|
2089
|
-
/**
|
|
2090
|
-
* Person\'s name.
|
|
2091
|
-
* @type {string}
|
|
2092
|
-
* @memberof SearchParametersCreatePerson
|
|
2093
|
-
*/
|
|
2094
|
-
'name'?: string;
|
|
2095
|
-
/**
|
|
2096
|
-
* A free-form object containing person\'s extended attributes.
|
|
2097
|
-
* @type {{ [key: string]: object; }}
|
|
2098
|
-
* @memberof SearchParametersCreatePerson
|
|
2099
|
-
*/
|
|
2100
|
-
'metadata'?: {
|
|
2101
|
-
[key: string]: object;
|
|
2102
|
-
};
|
|
2103
|
-
/**
|
|
2104
|
-
* The lifespan of the Person\'s records, seconds. Optional.
|
|
2105
|
-
* @type {number}
|
|
2106
|
-
* @memberof SearchParametersCreatePerson
|
|
2107
|
-
*/
|
|
2108
|
-
'ttl'?: number | null;
|
|
2109
|
-
}
|
|
2110
|
-
/**
|
|
2111
|
-
* Request search data.
|
|
2112
|
-
* @export
|
|
2113
|
-
* @interface SearchParameters
|
|
2114
|
-
*/
|
|
2115
|
-
export interface SearchParameters {
|
|
2116
|
-
/**
|
|
2117
|
-
*
|
|
2118
|
-
* @type {SearchParametersCreatePerson}
|
|
2119
|
-
* @memberof SearchParameters
|
|
2120
|
-
*/
|
|
2121
|
-
'createPerson'?: SearchParametersCreatePerson;
|
|
2122
|
-
/**
|
|
2123
|
-
* IDs of the groups in which the search is performed.
|
|
2124
|
-
* @type {Array<string>}
|
|
2125
|
-
* @memberof SearchParameters
|
|
2126
|
-
*/
|
|
2127
|
-
'groupIds'?: Array<string>;
|
|
2128
|
-
/**
|
|
2129
|
-
*
|
|
2130
|
-
* @type {FilterSearchRequest}
|
|
2131
|
-
* @memberof SearchParameters
|
|
2132
|
-
*/
|
|
2133
|
-
'filter'?: FilterSearchRequest;
|
|
2134
|
-
}
|
|
2135
1754
|
/**
|
|
2136
1755
|
* Person data.
|
|
2137
1756
|
* @export
|
|
@@ -2156,68 +1775,122 @@ export interface SearchPersonAllOf {
|
|
|
2156
1775
|
* @export
|
|
2157
1776
|
*/
|
|
2158
1777
|
export type SearchPerson = Person & SearchPersonAllOf;
|
|
2159
|
-
/**
|
|
2160
|
-
* @type SearchRequest
|
|
2161
|
-
* @export
|
|
2162
|
-
*/
|
|
2163
|
-
export type SearchRequest = ImageFields & SearchParameters;
|
|
2164
1778
|
/**
|
|
2165
1779
|
*
|
|
2166
1780
|
* @export
|
|
2167
|
-
* @interface
|
|
1781
|
+
* @interface PersonCreatedResponse
|
|
2168
1782
|
*/
|
|
2169
|
-
export interface
|
|
1783
|
+
export interface PersonCreatedResponse {
|
|
2170
1784
|
/**
|
|
2171
|
-
* Result code.
|
|
1785
|
+
* Result code.
|
|
2172
1786
|
* @type {number}
|
|
2173
|
-
* @memberof
|
|
1787
|
+
* @memberof PersonCreatedResponse
|
|
2174
1788
|
*/
|
|
2175
1789
|
'code'?: number;
|
|
2176
1790
|
/**
|
|
2177
|
-
* Array of Person images.
|
|
1791
|
+
* Array of Person images.
|
|
2178
1792
|
* @type {Array<SearchPerson>}
|
|
2179
|
-
* @memberof
|
|
1793
|
+
* @memberof PersonCreatedResponse
|
|
2180
1794
|
*/
|
|
2181
1795
|
'persons'?: Array<SearchPerson>;
|
|
2182
1796
|
/**
|
|
2183
|
-
*
|
|
2184
|
-
* @type {string}
|
|
2185
|
-
* @memberof
|
|
1797
|
+
* A free-form object containing person\'s extended attributes.
|
|
1798
|
+
* @type {{ [key: string]: object; }}
|
|
1799
|
+
* @memberof PersonCreatedResponse
|
|
2186
1800
|
*/
|
|
2187
|
-
'
|
|
1801
|
+
'metadata'?: {
|
|
1802
|
+
[key: string]: object;
|
|
1803
|
+
};
|
|
1804
|
+
}
|
|
1805
|
+
/**
|
|
1806
|
+
*
|
|
1807
|
+
* @export
|
|
1808
|
+
* @interface PersonsPageAllOf
|
|
1809
|
+
*/
|
|
1810
|
+
export interface PersonsPageAllOf {
|
|
2188
1811
|
/**
|
|
2189
|
-
*
|
|
2190
|
-
* @type {
|
|
2191
|
-
* @memberof
|
|
1812
|
+
*
|
|
1813
|
+
* @type {Array<Person>}
|
|
1814
|
+
* @memberof PersonsPageAllOf
|
|
2192
1815
|
*/
|
|
2193
|
-
'
|
|
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 {
|
|
2194
1840
|
/**
|
|
2195
|
-
*
|
|
1841
|
+
*
|
|
2196
1842
|
* @type {string}
|
|
2197
|
-
* @memberof
|
|
1843
|
+
* @memberof SearchBadParams
|
|
2198
1844
|
*/
|
|
2199
|
-
'
|
|
1845
|
+
'msg'?: string;
|
|
2200
1846
|
/**
|
|
2201
|
-
*
|
|
2202
|
-
* @type {
|
|
2203
|
-
* @memberof
|
|
1847
|
+
*
|
|
1848
|
+
* @type {number}
|
|
1849
|
+
* @memberof SearchBadParams
|
|
2204
1850
|
*/
|
|
2205
|
-
'
|
|
1851
|
+
'statusCode'?: number;
|
|
2206
1852
|
/**
|
|
2207
|
-
*
|
|
1853
|
+
*
|
|
2208
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}
|
|
2209
1873
|
* @memberof SearchResult
|
|
2210
1874
|
*/
|
|
2211
|
-
'
|
|
1875
|
+
'code'?: number;
|
|
2212
1876
|
/**
|
|
2213
|
-
*
|
|
2214
|
-
* @type {
|
|
1877
|
+
* Person data.
|
|
1878
|
+
* @type {Array<SearchPerson>}
|
|
2215
1879
|
* @memberof SearchResult
|
|
2216
1880
|
*/
|
|
2217
|
-
'
|
|
2218
|
-
[key: string]: object;
|
|
2219
|
-
};
|
|
1881
|
+
'persons'?: Array<SearchPerson>;
|
|
2220
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
|
+
*/
|
|
2221
1894
|
/**
|
|
2222
1895
|
*
|
|
2223
1896
|
* @export
|
|
@@ -2225,19 +1898,19 @@ export interface SearchResult {
|
|
|
2225
1898
|
*/
|
|
2226
1899
|
export interface TransactionInfo {
|
|
2227
1900
|
/**
|
|
2228
|
-
* 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/
|
|
2229
1902
|
* @type {number}
|
|
2230
1903
|
* @memberof TransactionInfo
|
|
2231
1904
|
*/
|
|
2232
1905
|
'code'?: number;
|
|
2233
1906
|
/**
|
|
2234
|
-
* Whether the liveness detection is confirmed
|
|
1907
|
+
* Whether the liveness detection is confirmed (0) or not (1).
|
|
2235
1908
|
* @type {number}
|
|
2236
1909
|
* @memberof TransactionInfo
|
|
2237
1910
|
*/
|
|
2238
1911
|
'status'?: number;
|
|
2239
1912
|
/**
|
|
2240
|
-
* Session identificator
|
|
1913
|
+
* Session identificator.
|
|
2241
1914
|
* @type {string}
|
|
2242
1915
|
* @memberof TransactionInfo
|
|
2243
1916
|
*/
|
|
@@ -2249,21 +1922,25 @@ export interface TransactionInfo {
|
|
|
2249
1922
|
*/
|
|
2250
1923
|
'transactionId'?: string;
|
|
2251
1924
|
/**
|
|
2252
|
-
* Link to the session video
|
|
1925
|
+
* Link to the session video.
|
|
2253
1926
|
* @type {string}
|
|
2254
1927
|
* @memberof TransactionInfo
|
|
2255
1928
|
*/
|
|
2256
1929
|
'video'?: string;
|
|
1930
|
+
/**
|
|
1931
|
+
* List of base64 images
|
|
1932
|
+
* @type {Array<string>}
|
|
1933
|
+
* @memberof TransactionInfo
|
|
1934
|
+
*/
|
|
1935
|
+
'images'?: Array<string>;
|
|
2257
1936
|
/**
|
|
2258
1937
|
* Approximate age with an accuracy of +/-3 years.
|
|
2259
|
-
* @type {
|
|
1938
|
+
* @type {number}
|
|
2260
1939
|
* @memberof TransactionInfo
|
|
2261
1940
|
*/
|
|
2262
|
-
'
|
|
2263
|
-
[key: string]: object;
|
|
2264
|
-
}>;
|
|
1941
|
+
'estimatedAge'?: number;
|
|
2265
1942
|
/**
|
|
2266
|
-
* Link to the portrait
|
|
1943
|
+
* Link to the portrait.
|
|
2267
1944
|
* @type {string}
|
|
2268
1945
|
* @memberof TransactionInfo
|
|
2269
1946
|
*/
|
|
@@ -2276,18 +1953,12 @@ export interface TransactionInfo {
|
|
|
2276
1953
|
'metadata'?: {
|
|
2277
1954
|
[key: string]: object;
|
|
2278
1955
|
};
|
|
2279
|
-
/**
|
|
2280
|
-
*
|
|
2281
|
-
* @type {LivenessType}
|
|
2282
|
-
* @memberof TransactionInfo
|
|
2283
|
-
*/
|
|
2284
|
-
'type'?: LivenessType;
|
|
2285
1956
|
}
|
|
2286
1957
|
/**
|
|
2287
|
-
* Regula
|
|
2288
|
-
*
|
|
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
|
|
2289
1960
|
*
|
|
2290
|
-
* The version of the OpenAPI document:
|
|
1961
|
+
* The version of the OpenAPI document: 5.2.0
|
|
2291
1962
|
*
|
|
2292
1963
|
*
|
|
2293
1964
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -2313,96 +1984,10 @@ export interface UpdateGroup {
|
|
|
2313
1984
|
*/
|
|
2314
1985
|
'removeItems'?: Array<string>;
|
|
2315
1986
|
}
|
|
2316
|
-
type TDetection = {
|
|
2317
|
-
/**
|
|
2318
|
-
*
|
|
2319
|
-
* @type {ImageData}
|
|
2320
|
-
* @memberof Detection
|
|
2321
|
-
*/
|
|
2322
|
-
crop?: ImageData;
|
|
2323
|
-
/**
|
|
2324
|
-
*
|
|
2325
|
-
* @memberof Detection
|
|
2326
|
-
*/
|
|
2327
|
-
attributes?: {
|
|
2328
|
-
/**
|
|
2329
|
-
*
|
|
2330
|
-
* @type {Array<{ name?: string; confidence?: number; value?: any; }>}
|
|
2331
|
-
*/
|
|
2332
|
-
details?: {
|
|
2333
|
-
name?: string;
|
|
2334
|
-
confidence?: number;
|
|
2335
|
-
value?: any;
|
|
2336
|
-
}[];
|
|
2337
|
-
/**
|
|
2338
|
-
* The elapsed time for attribute detection.
|
|
2339
|
-
* @type {number}
|
|
2340
|
-
*/
|
|
2341
|
-
elapsedTime?: number;
|
|
2342
|
-
};
|
|
2343
|
-
/**
|
|
2344
|
-
* Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
|
|
2345
|
-
* @type {Array<Array<number>>}
|
|
2346
|
-
* @memberof Detection
|
|
2347
|
-
*/
|
|
2348
|
-
landmarks: Array<Array<number>>;
|
|
2349
|
-
/**
|
|
2350
|
-
*
|
|
2351
|
-
* @type {DetectionQuality}
|
|
2352
|
-
* @memberof Detection
|
|
2353
|
-
*/
|
|
2354
|
-
quality?: DetectionQuality;
|
|
2355
|
-
/**
|
|
2356
|
-
* 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.
|
|
2357
|
-
* @type {Array<number>}
|
|
2358
|
-
* @memberof Detection
|
|
2359
|
-
*/
|
|
2360
|
-
roi: Array<number>;
|
|
2361
|
-
/**
|
|
2362
|
-
* Base64 of the cropped portrait.
|
|
2363
|
-
* @type {string}
|
|
2364
|
-
* @memberof Detection
|
|
2365
|
-
*/
|
|
2366
|
-
thumbnail?: string;
|
|
2367
|
-
};
|
|
2368
|
-
type TDetectResponse = {
|
|
2369
|
-
results?: {
|
|
2370
|
-
/**
|
|
2371
|
-
*
|
|
2372
|
-
* @type {Array<Detection>}
|
|
2373
|
-
* @memberof DetectResult
|
|
2374
|
-
*/
|
|
2375
|
-
detections: Array<TDetection>;
|
|
2376
|
-
/**
|
|
2377
|
-
* Internal.
|
|
2378
|
-
* @type {number}
|
|
2379
|
-
* @memberof DetectResult
|
|
2380
|
-
*/
|
|
2381
|
-
detectorType?: number;
|
|
2382
|
-
/**
|
|
2383
|
-
* Internal.
|
|
2384
|
-
* @type {number}
|
|
2385
|
-
* @memberof DetectResult
|
|
2386
|
-
*/
|
|
2387
|
-
landmarksType?: number;
|
|
2388
|
-
/**
|
|
2389
|
-
*
|
|
2390
|
-
* @type {FaceQualityScenarios}
|
|
2391
|
-
* @memberof DetectResult
|
|
2392
|
-
*/
|
|
2393
|
-
scenario?: FaceQualityScenarios;
|
|
2394
|
-
/**
|
|
2395
|
-
* The total time taken for the detection.
|
|
2396
|
-
* @type {number}
|
|
2397
|
-
* @memberof DetectResult
|
|
2398
|
-
*/
|
|
2399
|
-
timer?: number;
|
|
2400
|
-
};
|
|
2401
|
-
} & FaceSDKResult;
|
|
2402
1987
|
declare class MatchingApi {
|
|
2403
1988
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
2404
|
-
match(compareRequest: MatchRequest, xRequestID
|
|
2405
|
-
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>;
|
|
2406
1991
|
}
|
|
2407
1992
|
declare class GroupApi {
|
|
2408
1993
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
@@ -2417,7 +2002,7 @@ declare class GroupApi {
|
|
|
2417
2002
|
declare class PersonApi {
|
|
2418
2003
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
2419
2004
|
createPerson(personFields: PersonFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Person>;
|
|
2420
|
-
addImageToPerson(personId: string, imageFields:
|
|
2005
|
+
addImageToPerson(personId: string, imageFields: ImageFields, xRequestID?: string, options?: AxiosRequestConfig): Promise<Image>;
|
|
2421
2006
|
deleteImageOfPerson(imageId: string, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
|
|
2422
2007
|
deletePerson(personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<void>;
|
|
2423
2008
|
getAllGroupsByPersonId(page: number, size: number, personId: string, xRequestID?: string, options?: AxiosRequestConfig): Promise<GroupPage>;
|
|
@@ -2436,7 +2021,7 @@ declare class DiagnosticsApi {
|
|
|
2436
2021
|
}
|
|
2437
2022
|
declare class Liveness20Api {
|
|
2438
2023
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
2439
|
-
getLivenessTransactionInfo(transactionId:
|
|
2024
|
+
getLivenessTransactionInfo(transactionId: number, options?: AxiosRequestConfig): Promise<TransactionInfo>;
|
|
2440
2025
|
}
|
|
2441
2026
|
export class FaceSdk {
|
|
2442
2027
|
protected basePath: string;
|