@regulaforensics/facesdk-webclient 3.1.2 → 4.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (215) hide show
  1. package/dist/cjs-es5/api/group-api.js +695 -0
  2. package/dist/cjs-es5/api/matching-api.js +101 -127
  3. package/dist/cjs-es5/api/person-api.js +952 -0
  4. package/dist/cjs-es5/api/search-api.js +200 -0
  5. package/dist/cjs-es5/api.js +6 -3
  6. package/dist/cjs-es5/base.js +3 -3
  7. package/dist/cjs-es5/common.js +235 -0
  8. package/dist/cjs-es5/configuration.js +18 -3
  9. package/dist/cjs-es5/ext/face-sdk.js +7 -1
  10. package/dist/cjs-es5/ext/group-api.js +47 -0
  11. package/dist/cjs-es5/ext/index.js +1 -2
  12. package/dist/cjs-es5/ext/matching-api.js +3 -7
  13. package/dist/cjs-es5/ext/person-api.js +61 -0
  14. package/dist/cjs-es5/ext/search-api.js +33 -0
  15. package/dist/cjs-es5/index.js +1 -2
  16. package/dist/cjs-es5/models/crop.js +16 -0
  17. package/dist/cjs-es5/models/detect-request.js +2 -2
  18. package/dist/cjs-es5/models/detect-response-all-of.js +2 -2
  19. package/dist/cjs-es5/models/detect-response.js +2 -2
  20. package/dist/cjs-es5/models/detect-result.js +2 -2
  21. package/dist/cjs-es5/models/detection-face.js +2 -2
  22. package/dist/cjs-es5/models/detection-quality.js +16 -0
  23. package/dist/cjs-es5/models/detection.js +2 -2
  24. package/dist/cjs-es5/models/face-align-type-quality.js +29 -0
  25. package/dist/cjs-es5/models/face-image-quality-groups.js +32 -0
  26. package/dist/cjs-es5/models/face-quality-config-name.js +70 -0
  27. package/dist/cjs-es5/models/face-quality-scenarios.js +31 -0
  28. package/dist/cjs-es5/models/face-quality-status.js +27 -0
  29. package/dist/cjs-es5/models/face-recognition-result-code.js +1 -6
  30. package/dist/cjs-es5/models/face-sdkresult-code.js +36 -37
  31. package/dist/cjs-es5/models/face-sdkresult.js +2 -2
  32. package/dist/cjs-es5/models/group-all-of.js +16 -0
  33. package/dist/cjs-es5/models/group-page-all-of.js +16 -0
  34. package/dist/cjs-es5/models/group-page.js +16 -0
  35. package/dist/cjs-es5/models/group-to-create.js +16 -0
  36. package/dist/cjs-es5/models/group.js +16 -0
  37. package/dist/cjs-es5/models/image-fields-image.js +16 -0
  38. package/dist/cjs-es5/models/image-fields.js +16 -0
  39. package/dist/cjs-es5/models/image-page-all-of.js +16 -0
  40. package/dist/cjs-es5/models/image-page.js +16 -0
  41. package/dist/cjs-es5/models/image-source.js +11 -12
  42. package/dist/cjs-es5/models/image.js +16 -0
  43. package/dist/cjs-es5/models/index.js +54 -16
  44. package/dist/cjs-es5/models/match-image-detection.js +2 -2
  45. package/dist/cjs-es5/models/match-image-result.js +2 -2
  46. package/dist/cjs-es5/models/match-image.js +2 -2
  47. package/dist/cjs-es5/models/match-request.js +2 -2
  48. package/dist/cjs-es5/models/match-response-all-of.js +2 -2
  49. package/dist/cjs-es5/models/match-response.js +2 -2
  50. package/dist/cjs-es5/models/operation-log.js +16 -0
  51. package/dist/cjs-es5/models/output-image-params.js +16 -0
  52. package/dist/cjs-es5/models/page.js +16 -0
  53. package/dist/cjs-es5/models/person-all-of.js +16 -0
  54. package/dist/cjs-es5/models/person-fields.js +16 -0
  55. package/dist/cjs-es5/models/person.js +16 -0
  56. package/dist/cjs-es5/models/persons-page-all-of.js +16 -0
  57. package/dist/cjs-es5/models/persons-page.js +16 -0
  58. package/dist/cjs-es5/models/process-param.js +16 -0
  59. package/dist/cjs-es5/models/quality-config.js +16 -0
  60. package/dist/cjs-es5/models/quality-detail.js +16 -0
  61. package/dist/cjs-es5/models/quality-details-groups.js +16 -0
  62. package/dist/cjs-es5/models/quality-request.js +16 -0
  63. package/dist/cjs-es5/models/recognize-image-all-of.js +16 -0
  64. package/dist/cjs-es5/models/recognize-image.js +16 -0
  65. package/dist/cjs-es5/models/search-person-all-of.js +16 -0
  66. package/dist/cjs-es5/models/search-person.js +16 -0
  67. package/dist/cjs-es5/models/search-request-all-of.js +16 -0
  68. package/dist/cjs-es5/models/search-request.js +16 -0
  69. package/dist/cjs-es5/models/search-result-all-of.js +16 -0
  70. package/dist/cjs-es5/models/search-result.js +16 -0
  71. package/dist/cjs-es5/models/update-group.js +16 -0
  72. package/dist/esm-es5/api/group-api.js +692 -0
  73. package/dist/esm-es5/api/matching-api.js +100 -126
  74. package/dist/esm-es5/api/person-api.js +949 -0
  75. package/dist/esm-es5/api/search-api.js +197 -0
  76. package/dist/esm-es5/api.js +6 -3
  77. package/dist/esm-es5/base.js +3 -3
  78. package/dist/esm-es5/common.js +232 -0
  79. package/dist/esm-es5/configuration.js +18 -3
  80. package/dist/esm-es5/ext/face-sdk.js +7 -1
  81. package/dist/esm-es5/ext/group-api.js +44 -0
  82. package/dist/esm-es5/ext/index.js +1 -2
  83. package/dist/esm-es5/ext/matching-api.js +3 -7
  84. package/dist/esm-es5/ext/person-api.js +58 -0
  85. package/dist/esm-es5/ext/search-api.js +30 -0
  86. package/dist/esm-es5/index.js +1 -2
  87. package/dist/esm-es5/models/crop.js +14 -0
  88. package/dist/esm-es5/models/detect-request.js +2 -2
  89. package/dist/esm-es5/models/detect-response-all-of.js +2 -2
  90. package/dist/esm-es5/models/detect-response.js +2 -2
  91. package/dist/esm-es5/models/detect-result.js +2 -2
  92. package/dist/esm-es5/models/detection-face.js +2 -2
  93. package/dist/esm-es5/models/detection-quality.js +14 -0
  94. package/dist/esm-es5/models/detection.js +2 -2
  95. package/dist/esm-es5/models/face-align-type-quality.js +26 -0
  96. package/dist/esm-es5/models/face-image-quality-groups.js +29 -0
  97. package/dist/esm-es5/models/face-quality-config-name.js +67 -0
  98. package/dist/esm-es5/models/face-quality-scenarios.js +28 -0
  99. package/dist/esm-es5/models/face-quality-status.js +24 -0
  100. package/dist/esm-es5/models/face-recognition-result-code.js +1 -3
  101. package/dist/esm-es5/models/face-sdkresult-code.js +36 -37
  102. package/dist/esm-es5/models/face-sdkresult.js +2 -2
  103. package/dist/esm-es5/models/group-all-of.js +14 -0
  104. package/dist/esm-es5/models/group-page-all-of.js +14 -0
  105. package/dist/esm-es5/models/group-page.js +14 -0
  106. package/dist/esm-es5/models/group-to-create.js +14 -0
  107. package/dist/esm-es5/models/group.js +14 -0
  108. package/dist/esm-es5/models/image-fields-image.js +14 -0
  109. package/dist/esm-es5/models/image-fields.js +14 -0
  110. package/dist/esm-es5/models/image-page-all-of.js +14 -0
  111. package/dist/esm-es5/models/image-page.js +14 -0
  112. package/dist/esm-es5/models/image-source.js +11 -12
  113. package/dist/esm-es5/models/image.js +14 -0
  114. package/dist/esm-es5/models/index.js +54 -16
  115. package/dist/esm-es5/models/match-image-detection.js +2 -2
  116. package/dist/esm-es5/models/match-image-result.js +2 -2
  117. package/dist/esm-es5/models/match-image.js +2 -2
  118. package/dist/esm-es5/models/match-request.js +2 -2
  119. package/dist/esm-es5/models/match-response-all-of.js +2 -2
  120. package/dist/esm-es5/models/match-response.js +2 -2
  121. package/dist/esm-es5/models/operation-log.js +14 -0
  122. package/dist/esm-es5/models/output-image-params.js +14 -0
  123. package/dist/esm-es5/models/page.js +14 -0
  124. package/dist/esm-es5/models/person-all-of.js +14 -0
  125. package/dist/esm-es5/models/person-fields.js +14 -0
  126. package/dist/esm-es5/models/person.js +14 -0
  127. package/dist/esm-es5/models/persons-page-all-of.js +14 -0
  128. package/dist/esm-es5/models/persons-page.js +14 -0
  129. package/dist/esm-es5/models/process-param.js +14 -0
  130. package/dist/esm-es5/models/quality-config.js +14 -0
  131. package/dist/esm-es5/models/quality-detail.js +14 -0
  132. package/dist/esm-es5/models/quality-details-groups.js +14 -0
  133. package/dist/esm-es5/models/quality-request.js +14 -0
  134. package/dist/esm-es5/models/recognize-image-all-of.js +14 -0
  135. package/dist/esm-es5/models/recognize-image.js +14 -0
  136. package/dist/esm-es5/models/search-person-all-of.js +14 -0
  137. package/dist/esm-es5/models/search-person.js +14 -0
  138. package/dist/esm-es5/models/search-request-all-of.js +14 -0
  139. package/dist/esm-es5/models/search-request.js +14 -0
  140. package/dist/esm-es5/models/search-result-all-of.js +14 -0
  141. package/dist/esm-es5/models/search-result.js +14 -0
  142. package/dist/esm-es5/models/update-group.js +14 -0
  143. package/package.json +1 -1
  144. package/src/api/group-api.ts +592 -0
  145. package/src/api/matching-api.ts +152 -172
  146. package/src/api/person-api.ts +831 -0
  147. package/src/api/search-api.ts +133 -0
  148. package/src/api.ts +5 -2
  149. package/src/base.ts +4 -4
  150. package/src/common.ts +138 -0
  151. package/src/configuration.ts +27 -2
  152. package/src/ext/face-sdk.ts +10 -0
  153. package/src/ext/group-api.ts +34 -0
  154. package/src/ext/index.ts +0 -1
  155. package/src/ext/matching-api.ts +5 -9
  156. package/src/ext/person-api.ts +51 -0
  157. package/src/ext/search-api.ts +14 -0
  158. package/src/index.ts +0 -1
  159. package/src/models/crop.ts +49 -0
  160. package/src/models/detect-request.ts +18 -12
  161. package/src/models/detect-response-all-of.ts +3 -4
  162. package/src/models/detect-response.ts +2 -3
  163. package/src/models/detect-result.ts +18 -6
  164. package/src/models/detection-face.ts +8 -9
  165. package/src/models/detection-quality.ts +57 -0
  166. package/src/models/detection.ts +22 -9
  167. package/src/models/face-align-type-quality.ts +34 -0
  168. package/src/models/face-image-quality-groups.ts +37 -0
  169. package/src/models/face-quality-config-name.ts +75 -0
  170. package/src/models/face-quality-scenarios.ts +36 -0
  171. package/src/models/face-quality-status.ts +32 -0
  172. package/src/models/face-recognition-result-code.ts +0 -4
  173. package/src/models/face-sdkresult-code.ts +38 -35
  174. package/src/models/face-sdkresult.ts +3 -4
  175. package/src/models/group-all-of.ts +36 -0
  176. package/src/models/group-page-all-of.ts +31 -0
  177. package/src/models/group-page.ts +26 -0
  178. package/src/models/group-to-create.ts +36 -0
  179. package/src/models/group.ts +25 -0
  180. package/src/models/image-fields-image.ts +37 -0
  181. package/src/models/image-fields.ts +31 -0
  182. package/src/models/image-page-all-of.ts +31 -0
  183. package/src/models/image-page.ts +26 -0
  184. package/src/models/image-source.ts +13 -10
  185. package/src/models/image.ts +54 -0
  186. package/src/models/index.ts +53 -15
  187. package/src/models/match-image-detection.ts +6 -7
  188. package/src/models/match-image-result.ts +15 -16
  189. package/src/models/match-image.ts +6 -7
  190. package/src/models/match-request.ts +8 -9
  191. package/src/models/match-response-all-of.ts +5 -6
  192. package/src/models/match-response.ts +2 -3
  193. package/src/models/operation-log.ts +42 -0
  194. package/src/models/output-image-params.ts +37 -0
  195. package/src/models/page.ts +36 -0
  196. package/src/models/person-all-of.ts +42 -0
  197. package/src/models/person-fields.ts +36 -0
  198. package/src/models/person.ts +26 -0
  199. package/src/models/persons-page-all-of.ts +31 -0
  200. package/src/models/persons-page.ts +26 -0
  201. package/src/models/process-param.ts +51 -0
  202. package/src/models/quality-config.ts +37 -0
  203. package/src/models/quality-detail.ts +57 -0
  204. package/src/models/quality-details-groups.ts +50 -0
  205. package/src/models/quality-request.ts +37 -0
  206. package/src/models/recognize-image-all-of.ts +30 -0
  207. package/src/models/recognize-image.ts +25 -0
  208. package/src/models/search-person-all-of.ts +31 -0
  209. package/src/models/search-person.ts +26 -0
  210. package/src/models/search-request-all-of.ts +42 -0
  211. package/src/models/search-request.ts +26 -0
  212. package/src/models/search-result-all-of.ts +30 -0
  213. package/src/models/search-result.ts +37 -0
  214. package/src/models/update-group.ts +36 -0
  215. package/update-models.sh +2 -3
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Regula FaceSDK Web API
5
- * Regula FaceSDK Web API
5
+ * 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
6
6
  *
7
- * The version of the OpenAPI document: 3.2.0
7
+ * The version of the OpenAPI document: 4.1.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,6 @@ export interface DetectResponseAllOf {
26
26
  * @type {DetectResult}
27
27
  * @memberof DetectResponseAllOf
28
28
  */
29
- results?: DetectResult;
29
+ 'results'?: DetectResult;
30
30
  }
31
31
 
32
-
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Regula FaceSDK Web API
5
- * Regula FaceSDK Web API
5
+ * 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
6
6
  *
7
- * The version of the OpenAPI document: 3.2.0
7
+ * The version of the OpenAPI document: 4.1.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -25,4 +25,3 @@ import { FaceSDKResultCode } from './face-sdkresult-code';
25
25
  export type DetectResponse = DetectResponseAllOf & FaceSDKResult;
26
26
 
27
27
 
28
-
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Regula FaceSDK Web API
5
- * Regula FaceSDK Web API
5
+ * 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
6
6
  *
7
- * The version of the OpenAPI document: 3.2.0
7
+ * The version of the OpenAPI document: 4.1.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -14,6 +14,7 @@
14
14
 
15
15
 
16
16
  import { Detection } from './detection';
17
+ import { FaceQualityScenarios } from './face-quality-scenarios';
17
18
 
18
19
  /**
19
20
  *
@@ -26,19 +27,30 @@ export interface DetectResult {
26
27
  * @type {Array<Detection>}
27
28
  * @memberof DetectResult
28
29
  */
29
- detections: Array<Detection>;
30
+ 'detections': Array<Detection>;
30
31
  /**
31
32
  * Internal.
32
33
  * @type {number}
33
34
  * @memberof DetectResult
34
35
  */
35
- detectorType?: number;
36
+ 'detectorType'?: number;
36
37
  /**
37
38
  * Internal.
38
39
  * @type {number}
39
40
  * @memberof DetectResult
40
41
  */
41
- landmarksType?: number;
42
+ 'landmarksType'?: number;
43
+ /**
44
+ *
45
+ * @type {FaceQualityScenarios}
46
+ * @memberof DetectResult
47
+ */
48
+ 'scenario'?: FaceQualityScenarios;
49
+ /**
50
+ * The total time taken for the detection.
51
+ * @type {number}
52
+ * @memberof DetectResult
53
+ */
54
+ 'timer'?: number;
42
55
  }
43
56
 
44
-
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Regula FaceSDK Web API
5
- * Regula FaceSDK Web API
5
+ * 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
6
6
  *
7
- * The version of the OpenAPI document: 3.2.0
7
+ * The version of the OpenAPI document: 4.1.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -25,25 +25,24 @@ export interface DetectionFace {
25
25
  * @type {number}
26
26
  * @memberof DetectionFace
27
27
  */
28
- faceIndex?: number;
28
+ 'faceIndex'?: number;
29
29
  /**
30
- * Main coordinates of the detected face (eyes, nose, lips, ears and etc.).
30
+ * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
31
31
  * @type {Array<Array<number>>}
32
32
  * @memberof DetectionFace
33
33
  */
34
- landmarks?: Array<Array<number>>;
34
+ 'landmarks'?: Array<Array<number>>;
35
35
  /**
36
36
  * Rectangular area of the detected face. First element - X-axis coordinate. Second element - Y-axis coordinate. (X, Y) - left top point. Third element - rectangular width. Fourth element - rectangular height.
37
37
  * @type {Array<number>}
38
38
  * @memberof DetectionFace
39
39
  */
40
- roi?: Array<number>;
40
+ 'roi'?: Array<number>;
41
41
  /**
42
- * Formatted base64 face detection image.
42
+ * Base64 of the cropped portrait.
43
43
  * @type {string}
44
44
  * @memberof DetectionFace
45
45
  */
46
- thumbnail?: string;
46
+ 'thumbnail'?: string;
47
47
  }
48
48
 
49
-
@@ -0,0 +1,57 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula FaceSDK Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 4.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { FaceQualityConfigName } from './face-quality-config-name';
17
+ import { QualityDetail } from './quality-detail';
18
+ import { QualityDetailsGroups } from './quality-details-groups';
19
+
20
+ /**
21
+ * Field for checking the portrait quality. If it is not mentioned, no quality check is performed.
22
+ * @export
23
+ * @interface DetectionQuality
24
+ */
25
+ export interface DetectionQuality {
26
+ /**
27
+ * The array of all the non-compliant assessment characteristics.
28
+ * @type {Array<FaceQualityConfigName>}
29
+ * @memberof DetectionQuality
30
+ */
31
+ 'nonCompliant'?: Array<FaceQualityConfigName>;
32
+ /**
33
+ * The array of the assessment results for each group of characteristics.
34
+ * @type {Array<QualityDetailsGroups>}
35
+ * @memberof DetectionQuality
36
+ */
37
+ 'detailsGroups'?: Array<QualityDetailsGroups>;
38
+ /**
39
+ * The array of the assessment characteristics that were set in the request.
40
+ * @type {Array<QualityDetail>}
41
+ * @memberof DetectionQuality
42
+ */
43
+ 'details'?: Array<QualityDetail>;
44
+ /**
45
+ * Returns the estimated portrait quality assessment result, a number from 0 to 1, where 1 is for absolute compliance.
46
+ * @type {number}
47
+ * @memberof DetectionQuality
48
+ */
49
+ 'score'?: number;
50
+ /**
51
+ * The total time the quality assessment has taken.
52
+ * @type {number}
53
+ * @memberof DetectionQuality
54
+ */
55
+ 'timer'?: number;
56
+ }
57
+
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Regula FaceSDK Web API
5
- * Regula FaceSDK Web API
5
+ * 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
6
6
  *
7
- * The version of the OpenAPI document: 3.2.0
7
+ * The version of the OpenAPI document: 4.1.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,8 @@
13
13
  */
14
14
 
15
15
 
16
+ import { DetectionQuality } from './detection-quality';
17
+ import { ImageData } from './image-data';
16
18
 
17
19
  /**
18
20
  *
@@ -20,30 +22,41 @@
20
22
  * @interface Detection
21
23
  */
22
24
  export interface Detection {
25
+ /**
26
+ *
27
+ * @type {ImageData}
28
+ * @memberof Detection
29
+ */
30
+ 'crop'?: ImageData;
23
31
  /**
24
32
  *
25
33
  * @type {{ [key: string]: object; }}
26
34
  * @memberof Detection
27
35
  */
28
- attributes?: { [key: string]: object; };
36
+ 'attributes'?: { [key: string]: object; };
29
37
  /**
30
- * Main coordinates of the detected face (eyes, nose, lips, ears and etc.).
38
+ * Absolute coordinates (x,y) of five points of each detected face: left eye, right eye, nose, left point of lips, right point of lips.
31
39
  * @type {Array<Array<number>>}
32
40
  * @memberof Detection
33
41
  */
34
- landmarks: Array<Array<number>>;
42
+ 'landmarks': Array<Array<number>>;
43
+ /**
44
+ *
45
+ * @type {DetectionQuality}
46
+ * @memberof Detection
47
+ */
48
+ 'quality'?: DetectionQuality;
35
49
  /**
36
50
  * Rectangular area of the detected face. First element - X-axis coordinate. Second element - Y-axis coordinate. (X, Y) - left top point. Third element - rectangular width. Fourth element - rectangular height.
37
51
  * @type {Array<number>}
38
52
  * @memberof Detection
39
53
  */
40
- roi: Array<number>;
54
+ 'roi': Array<number>;
41
55
  /**
42
- * Formatted base64 face detection image.
56
+ * Base64 of the cropped portrait.
43
57
  * @type {string}
44
58
  * @memberof Detection
45
59
  */
46
- thumbnail?: string;
60
+ 'thumbnail'?: string;
47
61
  }
48
62
 
49
-
@@ -0,0 +1,34 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula FaceSDK Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 4.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * The aspect ratio according to which face alignment is performed during face detection.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const FaceAlignTypeQuality = {
24
+ ALIGN_3x4: 0,
25
+ ALIGN_4x5: 1,
26
+ ALIGN_2x3: 2,
27
+ ALIGN_1x1: 3,
28
+ ALIGN_7x9: 4
29
+ } as const;
30
+
31
+ export type FaceAlignTypeQuality = typeof FaceAlignTypeQuality[keyof typeof FaceAlignTypeQuality];
32
+
33
+
34
+
@@ -0,0 +1,37 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula FaceSDK Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 4.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * Face image quality group types for face image quality assessment.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const FaceImageQualityGroups = {
24
+ IMAGE_CHARACTERISTICS: 1,
25
+ HEAD_SIZE_AND_POSITIONS: 2,
26
+ FACE_QUALITY: 3,
27
+ EYES_CHARACTERISTICS: 4,
28
+ SHADOWS_AND_LIGHTNING: 5,
29
+ POSE_AND_EXPRESSION: 6,
30
+ HEAD_OCCLUSION: 7,
31
+ BACKGROUND: 8
32
+ } as const;
33
+
34
+ export type FaceImageQualityGroups = typeof FaceImageQualityGroups[keyof typeof FaceImageQualityGroups];
35
+
36
+
37
+
@@ -0,0 +1,75 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula FaceSDK Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 4.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * All image characteristics that can be assessed during face image quality assessment.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const FaceQualityConfigName = {
24
+ IMAGE_WIDTH: 'ImageWidth',
25
+ IMAGE_HEIGHT: 'ImageHeight',
26
+ IMAGE_WIDTH_TO_HEIGHT: 'ImageWidthToHeight',
27
+ IMAGE_CHANNELS_NUMBER: 'ImageChannelsNumber',
28
+ PADDING_RATIO: 'PaddingRatio',
29
+ FACE_MID_POINT_HORIZONTAL_POSITION: 'FaceMidPointHorizontalPosition',
30
+ FACE_MID_POINT_VERTICAL_POSITION: 'FaceMidPointVerticalPosition',
31
+ HEAD_WIDTH_RATIO: 'HeadWidthRatio',
32
+ HEAD_HEIGHT_RATIO: 'HeadHeightRatio',
33
+ EYES_DISTANCE: 'EyesDistance',
34
+ YAW: 'Yaw',
35
+ PITCH: 'Pitch',
36
+ ROLL: 'Roll',
37
+ BLUR_LEVEL: 'BlurLevel',
38
+ NOISE_LEVEL: 'NoiseLevel',
39
+ EYE_RIGHT_CLOSED: 'EyeRightClosed',
40
+ EYE_LEFT_CLOSED: 'EyeLeftClosed',
41
+ EYE_RIGHT_OCCLUDED: 'EyeRightOccluded',
42
+ EYE_LEFT_OCCLUDED: 'EyeLeftOccluded',
43
+ EYES_RED: 'EyesRed',
44
+ EYE_RIGHT_COVERED_WITH_HAIR: 'EyeRightCoveredWithHair',
45
+ EYE_LEFT_COVERED_WITH_HAIR: 'EyeLeftCoveredWithHair',
46
+ OFF_GAZE: 'OffGaze',
47
+ FACE_DYNAMIC_RANGE: 'FaceDynamicRange',
48
+ UNNATURAL_SKIN_TONE: 'UnnaturalSkinTone',
49
+ TOO_DARK: 'TooDark',
50
+ TOO_LIGHT: 'TooLight',
51
+ FACE_GLARE: 'FaceGlare',
52
+ SHADOWS_ON_FACE: 'ShadowsOnFace',
53
+ DARK_GLASSES: 'DarkGlasses',
54
+ REFLECTION_ON_GLASSES: 'ReflectionOnGlasses',
55
+ FRAMES_TOO_HEAVY: 'FramesTooHeavy',
56
+ FACE_OCCLUDED: 'FaceOccluded',
57
+ HEAD_COVERING: 'HeadCovering',
58
+ BACKGROUND_UNIFORMITY: 'BackgroundUniformity',
59
+ SHADOWS_ON_BACKGROUND: 'ShadowsOnBackground',
60
+ OTHER_FACES: 'OtherFaces',
61
+ SHOULDERS_POSE: 'ShouldersPose',
62
+ EXPRESSION_LEVEL: 'ExpressionLevel',
63
+ MOUTH_OPEN: 'MouthOpen',
64
+ FOREHEAD_COVERING: 'ForeheadCovering',
65
+ SMILE: 'Smile',
66
+ STRONG_MAKEUP: 'StrongMakeup',
67
+ HEADPHONES: 'Headphones',
68
+ MEDICAL_MASK: 'MedicalMask',
69
+ BACKGROUND_COLOR_MATCH: 'BackgroundColorMatch'
70
+ } as const;
71
+
72
+ export type FaceQualityConfigName = typeof FaceQualityConfigName[keyof typeof FaceQualityConfigName];
73
+
74
+
75
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula FaceSDK Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 4.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * Face detection scenarios.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const FaceQualityScenarios = {
24
+ QUALITY_FULL: 'QualityFull',
25
+ QUALITY_ICAO: 'QualityICAO',
26
+ QUALITY_VISA_SCHENGEN: 'QualityVisaSchengen',
27
+ QUALITY_VISA_USA: 'QualityVisaUSA',
28
+ CROP_CENTRAL_FACE: 'CropCentralFace',
29
+ CROP_ALL_FACES: 'CropAllFaces',
30
+ THUMBNAIL: 'Thumbnail'
31
+ } as const;
32
+
33
+ export type FaceQualityScenarios = typeof FaceQualityScenarios[keyof typeof FaceQualityScenarios];
34
+
35
+
36
+
@@ -0,0 +1,32 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula FaceSDK Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 4.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * The processing status returned for each assessed quality characteristic.
19
+ * @export
20
+ * @enum {string}
21
+ */
22
+
23
+ export const FaceQualityStatus = {
24
+ QUALITY_STATUS_FALSE: 0,
25
+ QUALITY_STATUS_TRUE: 1,
26
+ QUALITY_STATUS_UNDETERMINED: 2
27
+ } as const;
28
+
29
+ export type FaceQualityStatus = typeof FaceQualityStatus[keyof typeof FaceQualityStatus];
30
+
31
+
32
+
@@ -11,7 +11,3 @@
11
11
  * https://openapi-generator.tech
12
12
  * Do not edit the class manually.
13
13
  */
14
-
15
-
16
- import {FaceSDKResultCode} from './face-sdkresult-code.js';
17
- export import FaceRecognitionResultCode = FaceSDKResultCode;
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Regula FaceSDK Web API
5
- * Regula FaceSDK Web API
5
+ * 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
6
6
  *
7
- * The version of the OpenAPI document: 3.2.0
7
+ * The version of the OpenAPI document: 4.1.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,39 +19,42 @@
19
19
  * @export
20
20
  * @enum {string}
21
21
  */
22
- export enum FaceSDKResultCode {
23
- FACER_OK = 0,
24
- FACER_NO_LICENSE = 200,
25
- FACER_IS_NOT_INITIALIZED = 201,
26
- FACER_COMMAND_IS_NOT_SUPPORTED = 202,
27
- FACER_COMMAND_PARAMS_READ_ERROR = 203,
28
- FACER_SEARCHER_INDEX_FILE_NOT_EXIST = 204,
29
- FACER_SEARCHER_INDEX_FILE_READ_ERROR = 205,
30
- FACER_SEARCHER_INDEX_FILE_DECRYPTION_ERROR = 206,
31
- FACER_SEARCHER_INDEX_LOAD_ERROR = 207,
32
- FACER_SEARCHER_WRONG_DESCRIPTOR_VERSION = 208,
33
- FACER_SEARCHER_INDEX_FILE_ENCRYPTION_ERROR = 209,
34
- FACER_SEARCHER_INDEX_FILE_SAVE_ERROR = 210,
35
- FACER_SEARCHER_IMAGE_DECODE_ERROR = 211,
36
- FACER_SEARCHER_ID_EXISTS_IN_INDEX = 212,
37
- FACER_SEARCHER_ID_NOT_IN_INDEX = 213,
38
- FACER_SEARCHER_NO_FACES = 214,
39
- FACER_SEARCHER_DESCRIPTOR_EXTRACTOR_ERROR = 215,
40
- FACER_SEARCHER_METADATA_READ_ERROR = 216,
41
- FACER_SEARCHER_NO_SEARCH_LICENSE = 217,
42
- FACER_SEARCHER_DESCRIPTOR_DECODE_ERROR = 218,
43
- FACER_SEARCHER_DESCRIPTOR_WRONG_SIZE = 219,
44
- FACER_SEARCHER_ZIP_IMAGE_READ_ERROR = 220,
45
- FACER_SEARCHER_ZIP_META_READ_ERROR = 221,
46
- FACER_SEARCHER_SIMILAR_PHOTOS_EXIST = 222,
47
- FACER_SEARCHER_PERSON_ZIP_READ_ERROR = 223,
48
- FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST = 224,
49
- FACER_SEARCHER_WRONG_ID = 225,
50
- FACER_SEARCHER_ID_EXISTS_IN_DELETED = 226,
51
- FACER_VIDEO_DECODE_ERROR = 227,
52
- FACER_NOT_ENOUGH_FRAMES = 228,
53
- FACER_OUTPUT_IS_NOT_DEFINED = 229
54
- }
22
+
23
+ export const FaceSDKResultCode = {
24
+ FACER_OK: 0,
25
+ FACER_NO_LICENSE: 200,
26
+ FACER_IS_NOT_INITIALIZED: 201,
27
+ FACER_COMMAND_IS_NOT_SUPPORTED: 202,
28
+ FACER_COMMAND_PARAMS_READ_ERROR: 203,
29
+ FACER_SEARCHER_INDEX_FILE_NOT_EXIST: 204,
30
+ FACER_SEARCHER_INDEX_FILE_READ_ERROR: 205,
31
+ FACER_SEARCHER_INDEX_FILE_DECRYPTION_ERROR: 206,
32
+ FACER_SEARCHER_INDEX_LOAD_ERROR: 207,
33
+ FACER_SEARCHER_WRONG_DESCRIPTOR_VERSION: 208,
34
+ FACER_SEARCHER_INDEX_FILE_ENCRYPTION_ERROR: 209,
35
+ FACER_SEARCHER_INDEX_FILE_SAVE_ERROR: 210,
36
+ FACER_SEARCHER_IMAGE_DECODE_ERROR: 211,
37
+ FACER_SEARCHER_ID_EXISTS_IN_INDEX: 212,
38
+ FACER_SEARCHER_ID_NOT_IN_INDEX: 213,
39
+ FACER_SEARCHER_NO_FACES: 214,
40
+ FACER_SEARCHER_DESCRIPTOR_EXTRACTOR_ERROR: 215,
41
+ FACER_SEARCHER_METADATA_READ_ERROR: 216,
42
+ FACER_SEARCHER_NO_SEARCH_LICENSE: 217,
43
+ FACER_SEARCHER_DESCRIPTOR_DECODE_ERROR: 218,
44
+ FACER_SEARCHER_DESCRIPTOR_WRONG_SIZE: 219,
45
+ FACER_SEARCHER_ZIP_IMAGE_READ_ERROR: 220,
46
+ FACER_SEARCHER_ZIP_META_READ_ERROR: 221,
47
+ FACER_SEARCHER_SIMILAR_PHOTOS_EXIST: 222,
48
+ FACER_SEARCHER_PERSON_ZIP_READ_ERROR: 223,
49
+ FACER_LESS_THAN_TWO_IMAGES_IN_REQUEST: 224,
50
+ FACER_SEARCHER_WRONG_ID: 225,
51
+ FACER_SEARCHER_ID_EXISTS_IN_DELETED: 226,
52
+ FACER_VIDEO_DECODE_ERROR: 227,
53
+ FACER_NOT_ENOUGH_FRAMES: 228,
54
+ FACER_OUTPUT_IS_NOT_DEFINED: 229
55
+ } as const;
56
+
57
+ export type FaceSDKResultCode = typeof FaceSDKResultCode[keyof typeof FaceSDKResultCode];
55
58
 
56
59
 
57
60
 
@@ -2,9 +2,9 @@
2
2
  /* eslint-disable */
3
3
  /**
4
4
  * Regula FaceSDK Web API
5
- * Regula FaceSDK Web API
5
+ * 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
6
6
  *
7
- * The version of the OpenAPI document: 3.2.0
7
+ * The version of the OpenAPI document: 4.1.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -26,7 +26,6 @@ export interface FaceSDKResult {
26
26
  * @type {FaceSDKResultCode}
27
27
  * @memberof FaceSDKResult
28
28
  */
29
- code: FaceSDKResultCode;
29
+ 'code': FaceSDKResultCode;
30
30
  }
31
31
 
32
-
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula FaceSDK Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 4.1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * Additional group data in the response, includes id and created_at.
19
+ * @export
20
+ * @interface GroupAllOf
21
+ */
22
+ export interface GroupAllOf {
23
+ /**
24
+ * Group ID.
25
+ * @type {number}
26
+ * @memberof GroupAllOf
27
+ */
28
+ 'id'?: number;
29
+ /**
30
+ * Group creation date.
31
+ * @type {string}
32
+ * @memberof GroupAllOf
33
+ */
34
+ 'created_at'?: string;
35
+ }
36
+