@regulaforensics/face-sdk 6.3.82-beta → 6.3.85-nightly

package/www/types/liveness/liveness_notification.d.ts

@@ -7,6 +7,9 @@ export class LivenessNotification {
     private constructor()
 }
 
+/**
+ * Liveness process statuses.
+ */
 export enum LivenessProcessStatus {
     START,
     PREPARING,

package/www/types/liveness/liveness_response.d.ts

@@ -1,18 +1,42 @@
 
 import { LivenessException } from './liveness_exception'
 
+/**
+ * The response from the Liveness module.
+ */
 export class LivenessResponse {
+    /**
+     * The input image used to determine the liveness.
+     */
     get image(): string | null
+
+    /**
+     * The status of the Liveness processing.
+     */
     get liveness(): LivenessStatus
+
     get tag(): string | null
     get transactionId(): string | null
     get estimatedAge(): number | null
+
+    /**
+     * The error describes a failed liveness check and contains {@link LivenessErrorCode} codes.
+     */
     get error(): LivenessException | null
 
     private constructor()
 }
 
+/**
+ * The status of the Liveness processing.
+ */
 export enum LivenessStatus {
+    /**
+     * The liveness check is passed successfully.
+     */
     PASSED,
+    /**
+     * The liveness check result is unknown.
+     */
     UNKNOWN,
 }

package/www/types/match_faces/compared_face.d.ts

@@ -1,10 +1,28 @@
 import { MatchFacesImage } from './match_faces_image'
 import { MatchFacesDetectionFace } from './match_faces_detection_face'
 
+/**
+ * Represents a reference information of the compared face.
+ */
 export class ComparedFace {
+    /**
+     * The index to the input image in the input array provided to the request.
+     */
     get imageIndex(): number
+
+    /**
+     * The input image used for comparison operation.
+     */
     get image(): MatchFacesImage
+
+    /**
+     * The index to the array of `faces` in the `detection` results.
+     */
     get faceIndex(): number | null
+
+    /**
+     * The face detection result.
+     */
     get face(): MatchFacesDetectionFace | null
 
     private constructor()

package/www/types/match_faces/compared_faces_pair.d.ts

@@ -1,11 +1,35 @@
 import { ComparedFace } from './compared_face'
 import { MatchFacesException } from './match_faces_exception'
 
+/**
+ * Represents a result of the {@link ComparedFace} attempt to compare input images.
+ */
 export class ComparedFacesPair {
+    /**
+     * The first face in the comparison pair.
+     */
     get first(): ComparedFace
+
+    /**
+     * The second face in the comparison pair.
+     */
     get second(): ComparedFace
+
+    /**
+     * Similarity of the faces pair. Floating point value from 0 to 1.
+     */
     get similarity(): number
+
+    /**
+     * The raw value returned by the service without applying any thresholds or comparison rules.
+     * The value shows the degree of similarity of compared faces, the lower - the more similar, and vice versa less similar.
+     * The `score` is used in conjunction with the input image `imageType` to evaluate `similarity`.
+     */
     get score(): number
+
+    /**
+     * The error describes a failed pair comparison and contains {@link MatchFacesErrorCode} codes.
+     */
     get error(): MatchFacesException | null
 
     private constructor()

package/www/types/match_faces/match_faces_detection.d.ts

@@ -2,10 +2,28 @@ import { MatchFacesImage } from './match_faces_image'
 import { MatchFacesDetectionFace } from './match_faces_detection_face'
 import { MatchFacesException } from './match_faces_exception'
 
+/**
+ * Represents detection results on an input image as a part of {@link MatchFacesResponse}.
+ */
 export class MatchFacesDetection {
+    /**
+     * The index to the input image in the input array provided to the request.
+     */
     get imageIndex(): number
+
+    /**
+     * The input image used for comparison operation.
+     */
     get image(): MatchFacesImage
+
+    /**
+     * The array of faces detected on the image.
+     */
     get faces(): Array<MatchFacesDetectionFace>
+
+    /**
+     * The error describes a failed face detection and contains {@link MatchFacesErrorCode} codes.
+     */
     get error(): MatchFacesException | null
 
     private constructor()

package/www/types/match_faces/match_faces_detection_face.d.ts

@@ -1,12 +1,42 @@
 import { Point } from '../image_params/point'
 import { Rect } from '../image_params/rect'
 
+/**
+ * Represents face detection information as a part of {@link MatchFacesResponse}.
+ */
 export class MatchFacesDetectionFace {
+    /**
+     * The index of the face detection object in the array of detections.
+     */
     get faceIndex(): number
+
+    /**
+     * Main coordinates of the detected face (eyes, nose, lips, ears and etc.).
+     */
     get landmarks(): Array<Point>
+
+    /**
+     * Rectangular area of the detected face in the original image.
+     */
     get faceRect(): Rect
+
+    /**
+     * Rotation is measured counterclockwise in degrees, with zero indicating
+     * that a line drawn between the eyes is horizontal relative to the image orientation.
+     */
     get rotationAngle(): number | null
+
+    /**
+     * Coordinates of the rectangle with the face on the original image prepared for the face crop.
+     * Requires {@link OutputImageCrop.returnOriginalRect} is set.
+     * Returns `null` if {@link OutputImageCrop.returnOriginalRect} isn't set.
+     */
     get originalRect(): Rect | null
+
+    /**
+     * String image of the aligned and cropped portrait.
+     * Returned if {@link MatchFacesRequest.outputImageParams} is set or predefined scenario is used.
+     */
     get crop(): string | null
 
     private constructor()

package/www/types/match_faces/match_faces_image.d.ts

@@ -1,9 +1,27 @@
 import { ImageType } from '../face_capture/face_capture_image'
 
+/**
+ * This class represents the input image and its attributes for {@link MatchFacesRequest}.
+ */
 export class MatchFacesImage {
+    /**
+     * The underlying image.
+     */
     get image(): string
+
+    /**
+     * The image type.
+     * The imageType influences matching results, therefore this field is required.
+     */
     get imageType(): ImageType
+
+    /**
+     * Defines whether the comparison and detection should apply for all faces found on the image. Defaults to `false`.
+     * When set to `false`, only the most centered faces are compared and detected.
+     * Otherwise, all the faces are compared and detected.
+     */
     get detectAll(): boolean
+    
     get identifier(): string
 
     constructor(

package/www/types/match_faces/match_faces_request.d.ts

@@ -1,10 +1,26 @@
 import { MatchFacesImage } from './match_faces_image'
 import { OutputImageParams } from '../image_params/output_image_params'
 
+/**
+ * Compares two or more images with faces on them to find out the similarity of pairs.
+ * The request is used as a parameter to {@link FaceSDK.matchFaces}.
+ */
 export class MatchFacesRequest {
+    /**
+     * Images with faces to match.
+     */
     get images(): Array<MatchFacesImage>
+
+    /**
+     * If set the uploaded image is processed according to the indicated settings.
+     */
     get outputImageParams(): OutputImageParams | null
+
+    /**
+     * Defines tag that can be used in match faces processing. Defaults to `null`.
+     */
     get tag(): string | null
+
     get metadata(): Record<string, any> | null
 
     constructor(

package/www/types/match_faces/match_faces_response.d.ts

@@ -2,10 +2,25 @@ import { ComparedFacesPair } from './compared_faces_pair'
 import { MatchFacesDetection } from './match_faces_detection'
 import { MatchFacesException } from './match_faces_exception'
 
+/**
+ * The response from the {@link MatchFacesRequest}.
+ */
 export class MatchFacesResponse {
+    /**
+     * Face comparison results with score and similarity values.
+     */
     get results(): Array<ComparedFacesPair>
+
+    /**
+     * Face detection results for each given image.
+     */
     get detections(): Array<MatchFacesDetection>
+
     get tag(): string | null
+
+    /**
+     * The error describes a failed match faces request and contains {@link MatchFacesErrorCode} codes.
+     */
     get error(): MatchFacesException | null
 
     private constructor()

package/www/types/person_database/image_upload.d.ts

@@ -1,5 +1,19 @@
+/**
+ * An object that represents uploaded image with its settings.
+ */
 export class ImageUpload {
+    /**
+     * Creates an object of {@link ImageUpload} using an image.
+     * 
+     * @param imageData - Image base64.
+     */
     static withImageData(imageData: string): ImageUpload
+
+    /**
+     * Creates an object of {@link ImageUpload} using an image url.
+     * 
+     * @param imageUrl - Image url.
+     */
     static withImageUrl(imageUrl: string): ImageUpload
 
     private constructor()

package/www/types/person_database/person.d.ts

@@ -1,9 +1,32 @@
+
+/**
+ * A Person Database object that represents Person.
+ */
 export class Person {
+    /**
+     * Person name.
+     * Updatable field.
+     */
     name: string
+
+    /**
+     * Person update date.
+     */
     get updatedAt(): Date
+
+    /**
+     * Array if Group IDs Person belongs to.
+     */
     get groups(): string[]
+
     get id(): string
+
+    /**
+     * A free-form object containing Person extended attributes.
+     * Updatable field.
+     */
     metadata: any
+
     get createdAt(): Date
 
     private constructor()

package/www/types/person_database/person_database.d.ts

@@ -7,6 +7,9 @@ import { EditGroupPersonsRequest } from './edit_group_persons_request'
 import { SearchPersonRequest } from './search_person_request'
 import { SearchPerson } from './search_person'
 
+/**
+ * Represents Regula Database layer and is the entry point for Person Database operations.
+ */
 export class PersonDatabase {
     createPerson(
         name: string,

package/www/types/person_database/person_group.d.ts

@@ -1,7 +1,21 @@
+/**
+ * Person Database object that represents Group of {@link Person}.
+ */
 export class PersonGroup {
+    /**
+     * PersonGroup name.
+     * Updatable field.
+     */
     name: string
+
     get id(): string
+
+    /**
+     * A free-form object containing Group extended attributes.
+     * Updatable field.
+     */
     metadata: any
+
     get createdAt(): Date
 
     private constructor()

package/www/types/person_database/search_person.d.ts

@@ -1,14 +1,30 @@
 import { SearchPersonImage } from './search_person_image'
 import { SearchPersonDetection } from './search_person_detection'
 
+/**
+ * A Person Database object that represents th result of Person search.
+ */
 export class SearchPerson {
+    /**
+     * Array of images where the Person is found.
+     */
     get images(): SearchPersonImage[]
+
+    /**
+     * Detection data relative to the search input image.
+     */
     get detection(): SearchPersonDetection | null
+
     name: string
+
     get updatedAt(): Date
+
     get groups(): string[]
+
     get id(): string
+
     metadata: any
+    
     get createdAt(): Date
 
     private constructor()

package/www/types/person_database/search_person_image.d.ts

@@ -1,5 +1,18 @@
+/**
+ * A Person Database object that represents Image result of Person Search.
+ */
 export class SearchPersonImage {
+    /**
+     * The similarity score.
+     * From 0.0 to 1.0.
+     */
     get similarity(): number
+
+    /**
+     * The similarity distance score.
+     * The lower the distance, the higher the face's similarity.
+     * From 0.0 to 2.0.
+     */
     get distance(): number
     get path(): string
     get url(): string

package/www/types/person_database/search_person_request.d.ts

@@ -1,7 +1,31 @@
 import { ImageUpload } from './image_upload'
 import { OutputImageParams } from '../image_params/output_image_params'
 
+/**
+ * Request object that configures Search settings.
+ */
 export class SearchPersonRequest {
+    /**
+     * Create {@link SearchPersonRequest} object.
+     * 
+     * @param image - Image Upload object to apply search with.
+     * 
+     * @param params.groupIdsForSearch - The Group IDs of the groups in which the search is performed.
+     * 
+     * @param params.threshold - The similarity distance threshold, should be between 0.0 and 2.0, 
+     * where 0.0 is for returning results for only the most similar persons and 2.0 
+     * is for all the persons, even the dissimilar ones.
+     * Default: 1.
+     * 
+     * @param params.limit - The number of returned Persons limit. 
+     * Default: 100.
+     * 
+     * @param params.detectAll - Whether to process only the one face on the image or all the faces. 
+     * Default: `false`.
+     * 
+     * @param params.outputImageParams - If set the uploaded image is processed according to the indicated settings.
+     */
+
     constructor(
         image: ImageUpload,
         params?: {