@regulaforensics/face-sdk 6.5.63-beta → 6.5.67-beta

package/www/types/image_quality/image_quality_group.d.ts

@@ -1,418 +0,0 @@
-import { ImageQualityCharacteristic } from './image_quality_characteristic'
-import { ImageQualityRange } from './image_quality_range'
-
-/**
- * Image Quality characteristic group
- */
-export class ImageQualityGroup {
-    /**
-     * The Image characteristics group includes width, height, width to height proportions,
-     * the image RGB channels number, and padding ratio.
-     */
-    static get image(): _Image
-    /**
-     * The Head size and position group includes the position of the "middle point"
-     * relative to the width and height of the image, the head width to the image
-     * width and height ratio, inter-eye distance, yaw, pitch, roll.
-     */
-    static get headSizeAndPosition(): _HeadSizeAndPosition
-    /**
-     * The Face image quality group includes blur and noise levels, unnatural skin tone,
-     * and face dynamic range checks.
-     */
-    static get faceImage(): _FaceImage
-    /**
-     * The Eyes characteristics group checks eyes closure, occlusion, hair coverage,
-     * red eye effect, and whether a person is looking directly at the camera.
-     */
-    static get eyes(): _Eyes
-    /**
-     * The Shadows and lightning characteristics group checks whether a photo
-     * is too dark or overexposed, if there are glares or shadows on the face.
-     */
-    static get shadowsAndLightning(): _ShadowsAndLightning
-    /**
-     * The Pose and expression characteristics group checks the shoulders pose,
-     * face expression, whether there is an open mouth or smile.
-     */
-    static get poseAndExpression(): _PoseAndExpression
-    /**
-     * The Head occlusion group includes checks of glasses, face occlusion, and head coverage.
-     */
-    static get headOcclusion(): _HeadOcclusion
-    /**
-     * The Background characteristics group checks the background uniformity,
-     * shadows on background, and other faces presence on the picture.
-     */
-    static get background(): _Background
-}
-
-export class _Image {
-    /**
-     * The image width, pixels.
-     * Doesn't have recommended value. 
-     */
-    imageWidth(range: ImageQualityRange): ImageQualityCharacteristic
-
-    /**
-     * The image height, pixels.
-     * Doesn't have recommended value.
-     */
-    imageHeight(range: ImageQualityRange): ImageQualityCharacteristic
-
-    /**
-     * The image width to height proportion.
-     * Doesn't have recommended value.
-     */
-    imageWidthToHeight(range: ImageQualityRange): ImageQualityCharacteristic
-
-    /**
-     * The image RGB channels number.
-     * Doesn't have recommended value.
-     * 
-     * @param channelsNumber - 3 is for RGB images.
-     */
-    imageChannelsNumber(channelsNumber: number): ImageQualityCharacteristic
-
-    /**
-     * The percentage of the area of the image that was "padded" during alignment.
-     * The characteristic is needed to determine if the head goes beyond the image.
-     * The range is from 0 to 1 where 0 is 0% of the image is "padded".
-     * Doesn't have recommended value. 
-     */
-    paddingRatio(range: ImageQualityRange): ImageQualityCharacteristic
-
-    /**
-     * Whether the face in the image is a photo, not a drawing, sculpture, cartoon, etc.
-     * If the returned value is out of the recommended range, the image is not a photo.
-     * The range is from 0 to 1 where 0 means the image is a photo.
-     */
-    artFace(): ImageQualityCharacteristic
-
-    /**
-     * All Group characteristics with default (recommended) values.
-     * Doesn't include characteristics without default values.
-     */
-    allRecommended(): Array<ImageQualityCharacteristic>
-
-    private constructor()
-}
-
-export class _HeadSizeAndPosition {
-    /**
-     * The position of the "middle point" (the middle of the line connecting the eye centers)
-     * relative to the width of the image.
-     * The range is from 0 to 1 where range [0.5, 0.5] is for "middle point" strictly in the center .
-     */
-    faceMidPointHorizontalPosition(): ImageQualityCharacteristic
-
-    /**
-     * The position of the "middle point" (the middle of the line connecting the eye centers)
-     * relative to the height of the image.
-     * The range is from 0 to 1 where range [0.5, 0.5] is for "middle point" strictly in the center .
-     */
-    faceMidPointVerticalPosition(): ImageQualityCharacteristic
-
-    /**
-     * The head width to the image width ratio.
-     * The range is from 0 to 1.
-     */
-    headWidthRatio(): ImageQualityCharacteristic
-
-    /**
-     * The head height to the image height ratio.
-     * The range is from 0 to 1.
-     */
-    headHeightRatio(): ImageQualityCharacteristic
-
-    /**
-     * Inter-eye distance — the length of the line connecting the eye centers of the left and right eye, pixels.
-     */
-    eyesDistance(): ImageQualityCharacteristic
-
-    /**
-     * The yaw of the head, degrees.
-     * The range is from -90 to 90. Range value [0, 0] for strictly stright head position.
-     */
-    yaw(): ImageQualityCharacteristic
-
-    /**
-     * The pitch of the head, degrees.
-     * The range is from -90 to 90. Range value [0, 0] for strictly stright head position.
-     */
-    pitch(): ImageQualityCharacteristic
-
-    /**
-     * The roll of the head, degrees.
-     * The range is from -90 to 90. Range value [0, 0] for strictly stright head position.
-     */
-    roll(): ImageQualityCharacteristic
-
-    /**
-     * All Group characteristics with default (recommended) values.
-     * Doesn't include characteristics without default values.
-     */
-    allRecommended(): Array<ImageQualityCharacteristic>
-
-    private constructor()
-}
-
-export class _FaceImage {
-    /**
-     * The blur level.
-     * The range is from 0 to 1 where 0 is the absence of blur effect
-     */
-    blurLevel(): ImageQualityCharacteristic
-
-    /**
-     * The noise level.
-     * The range is from 0 to 1 where 0 is minimal noise level.
-     */
-    noiseLevel(): ImageQualityCharacteristic
-
-    /**
-     * The true-colour representation of the skin colour.
-     * The range is from 0 to 1.
-     */
-    unnaturalSkinTone(): ImageQualityCharacteristic
-
-    /**
-     * The range of tonal difference between the lightest light and darkest dark of an image, bits.
-     */
-    faceDynamicRange(): ImageQualityCharacteristic
-
-    /**
-     * All Group characteristics with default (recommended) values.
-     * Doesn't include characteristics without default values.
-     */
-    allRecommended(): Array<ImageQualityCharacteristic>
-
-    private constructor()
-}
-
-export class _Eyes {
-    /**
-     * Whether the right eye is closed.
-     * The range is from 0 to 1 where 1 is the eye is fully closed.
-     */
-    eyeRightClosed(): ImageQualityCharacteristic
-
-    /**
-     * Whether the left eye is closed.
-     * The range is from 0 to 1 where 1 is the eye is fully closed.
-     */
-    eyeLeftClosed(): ImageQualityCharacteristic
-
-    /**
-     * Whether the right eye is occluded.
-     * The range is from 0 to 1 where 1 is the eye is fully occluded.
-     */
-    eyeRightOccluded(): ImageQualityCharacteristic
-
-    /**
-     *  Whether the left eye is occluded.
-     * The range is from 0 to 1 where 1 is the eye is fully occluded.
-     */
-    eyeLeftOccluded(): ImageQualityCharacteristic
-
-    /**
-     * Whether there is the red-eye effect.
-     * The range is from 0 to 1 where 0 is the absence of  red-eye effect.
-     */
-    eyesRed(): ImageQualityCharacteristic
-
-    /**
-     * Whether the right eye is covered with hair.
-     * The range is from 0 to 1 where 1 is 100% of the eye is covered by hair.
-     */
-    eyeRightCoveredWithHair(): ImageQualityCharacteristic
-
-    /**
-     * Whether the left eye is covered with hair.
-     * The range is from 0 to 1 where 1 is 100% of the eye is covered by hair.
-     */
-    eyeLeftCoveredWithHair(): ImageQualityCharacteristic
-
-    /**
-     * Whether the person is not looking directly at the camera.
-     * The range is from 0 to 1 where 0 is for absolutely direct look.
-     */
-    offGaze(): ImageQualityCharacteristic
-
-    /**
-     * All Group characteristics with default (recommended) values.
-     * Doesn't include characteristics without default values.
-     */
-    allRecommended(): Array<ImageQualityCharacteristic>
-
-    private constructor()
-}
-
-export class _ShadowsAndLightning {
-    /**
-     * Whether the photo is too dark.
-     * The range is from 0 to 1.
-     */
-    tooDark(): ImageQualityCharacteristic
-
-    /**
-     * Whether the photo is overexposed.
-     * The range is from 0 to 1.
-     */
-    tooLight(): ImageQualityCharacteristic
-
-    /**
-     * Whether there is glare on the face.
-     * The range is from 0 to 1 where 0 is the absence of glare.
-     */
-    faceGlare(): ImageQualityCharacteristic
-
-    /**
-     * Whether there are shadows on the face.
-     * The range is from 0 to 1 where 0 is the absence of shadows on the face.
-     */
-    shadowsOnFace(): ImageQualityCharacteristic
-
-    /**
-     * All Group characteristics with default (recommended) values.
-     * Doesn't include characteristics without default values.
-     */
-    allRecommended(): Array<ImageQualityCharacteristic>
-
-    private constructor()
-}
-
-export class _PoseAndExpression {
-    /**
-     * Checks the symmetry of the shoulders.
-     * The range is from 0 to 1 where 1 is for absolutely symmetrical shoulders.
-     */
-    shouldersPose(): ImageQualityCharacteristic
-
-    /**
-     * Checks the presence of any emotional facial expression.
-     * The range is from 0 to 1 where 0 is for absolutely non-emotional expression.
-     */
-    expressionLevel(): ImageQualityCharacteristic
-
-    /**
-     * Whether the mouth is open.
-     * The range is from 0 to 1 where 0 is closed mouth.
-     */
-    mouthOpen(): ImageQualityCharacteristic
-
-    /**
-     * Whether the person smiles.
-     * The range is from 0 to 1 where 0 is smile absence.
-     */
-    smile(): ImageQualityCharacteristic
-
-    /**
-     * All Group characteristics with default (recommended) values.
-     * Doesn't include characteristics without default values.
-     */
-    allRecommended(): Array<ImageQualityCharacteristic>
-
-    private constructor()
-}
-
-export class _HeadOcclusion {
-    /**
-     * Whether the person wears dark glasses.
-     * The range is from 0 to 1 where 0 is dark glasses absence.
-     */
-    darkGlasses(): ImageQualityCharacteristic
-
-    /**
-     * Whether there are reflections on glasses.
-     * The range is from 0 to 1 where 0 is reflections absence.
-     * In the current release, always succeeds. Will be developed in the coming releases.
-     */
-    reflectionOnGlasses(): ImageQualityCharacteristic
-
-    /**
-     * Whether the glasses frames do not obscure eye details and the irises of both eyes are visible.
-     * The range is from 0 to 20 where 0 the absence of frames (glasses).
-     */
-    framesTooHeavy(): ImageQualityCharacteristic
-
-    /**
-     * Whether the face is visible and not occluded.
-     * The range is from 0 to 1 where 0 is face occlusion absence.
-     */
-    faceOccluded(): ImageQualityCharacteristic
-
-    /**
-     * Whether there is any head coverage other than religious headwear.
-     * The range is from 0 to 1.
-     */
-    headCovering(): ImageQualityCharacteristic
-
-    /**
-     * Whether the forehead is covered.
-     * The range is from 0 to 1.
-     */
-    foreheadCovering(): ImageQualityCharacteristic
-
-    /**
-     * Whether the makeup is too strong.
-     * In the current release, always succeeds. Will be developed in the coming releases.
-     * The range is from 0 to 1.
-     */
-    strongMakeup(): ImageQualityCharacteristic
-
-    /**
-     * Whether the person is wearing headphones.
-     * The range is from 0 to 1 where 0 is headphones absence.
-     */
-    headphones(): ImageQualityCharacteristic
-
-    /**
-     * Whether the person is wearing a medical mask.
-     * The range is from 0 to 1 where 0 is medical mask absence.
-     */
-    medicalMask(): ImageQualityCharacteristic
-
-    /**
-     * All Group characteristics with default (recommended) values.
-     * Doesn't include characteristics without default values.
-     */
-    allRecommended(): Array<ImageQualityCharacteristic>
-
-    private constructor()
-}
-
-export class _Background {
-    /**
-     * Checks uniformity of the portrait background.
-     * The range is from 0 to 1 where 1 is absolute background uniformity.
-     */
-    backgroundUniformity(): ImageQualityCharacteristic
-
-    /**
-     * Whether there are shadows on the portrait background.
-     * The range is from 0 to 1 where 1 is the absence of shadows on the portrait background.
-     */
-    shadowsOnBackground(): ImageQualityCharacteristic
-
-    /** 
-     * The number of faces on the photo.
-     * The range is from 0 to 1 where 1 is full background color match.
-     */
-    otherFaces(): ImageQualityCharacteristic
-
-    /**
-     * Whether the background color matches default background color.
-     * Default color is white (RGB(255,255,255) or hex #FFFFFF)
-     * The range is from 0 to 1 where 1 is full background color match.
-     */
-    backgroundColorMatch(params?: { color?: number }): ImageQualityCharacteristic
-
-    /**
-     * Whether the background color matches the required color.
-     * The range is from 0 to 1 where 1 is full background color match.
-     */
-    allRecommended(): Array<ImageQualityCharacteristic>
-
-    private constructor()
-}

package/www/types/image_quality/image_quality_range.d.ts

@@ -1,8 +0,0 @@
-export class ImageQualityRange {
-    get min(): number
-    get max(): number
-
-    constructor(min: number, max: number)
-
-    static withValue(value: number): ImageQualityRange
-}

package/www/types/image_quality/image_quality_result.d.ts

@@ -1,30 +0,0 @@
-import { ImageQualityRange } from './image_quality_range'
-import { ImageQualityCharacteristicName } from './image_quality_characteristic_name'
-
-export class ImageQualityResult {
-    get group(): ImageQualityGroupName
-    get name(): ImageQualityCharacteristicName
-    get status(): ImageQualityResultStatus
-    get value(): number
-    get range(): ImageQualityRange
-
-    private constructor()
-}
-
-export enum ImageQualityGroupName {
-    IMAGE_CHARACTERISTICS,
-    HEAD_SIZE_AND_POSITION,
-    FACE_QUALITY,
-    EYES_CHARACTERISTICS,
-    SHADOWS_AND_LIGHTNING,
-    POSE_AND_EXPRESSION,
-    HEAD_OCCLUSION,
-    BACKGROUND,
-    UNKNOWN,
-}
-
-export enum ImageQualityResultStatus {
-    FALSE,
-    TRUE,
-    UNDETERMINED,
-}

package/www/types/init/face_sdk_version.d.ts

@@ -1,16 +0,0 @@
-export class FaceSDKVersion {
-    /**
-     * Version of the API module.
-     */
-    get api(): string | null
-    /**
-     * Version of the CORE module.
-     */
-    get core(): string | null
-    /**
-     * CORE module variant.
-     */
-    get coreMode(): string | null
-
-    private constructor()
-}

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

@@ -1,29 +0,0 @@
-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,36 +0,0 @@
-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/compared_faces_split.d.ts

@@ -1,8 +0,0 @@
-import { ComparedFacesPair } from './compared_faces_pair'
-
-export class ComparedFacesSplit {
-    get matchedFaces(): Array<ComparedFacesPair>
-    get unmatchedFaces(): Array<ComparedFacesPair>
-
-    private constructor()
-}

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

@@ -1,6 +0,0 @@
-export class MatchFacesBackendException {
-    get code(): number
-    get message(): string
-
-    private constructor()
-}

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

@@ -1,14 +0,0 @@
-export class MatchFacesConfig {
-    processingMode: ProcessingMode
-
-    constructor(
-        params?: {
-            processingMode?: ProcessingMode
-        }
-    )
-}
-
-export enum ProcessingMode {
-    ONLINE,
-    OFFLINE,
-}

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

@@ -1,30 +0,0 @@
-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,43 +0,0 @@
-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_exception.d.ts

@@ -1,21 +0,0 @@
-import { MatchFacesBackendException } from './match_faces_backend_exception'
-
-export class MatchFacesException {
-    get code(): MatchFacesErrorCode
-    get message(): string
-    get underlyingError(): MatchFacesBackendException | null
-
-    private constructor()
-}
-
-export enum MatchFacesErrorCode {
-    IMAGE_EMPTY,
-    FACE_NOT_DETECTED,
-    LANDMARKS_NOT_DETECTED,
-    FACE_ALIGNER_FAILED,
-    DESCRIPTOR_EXTRACTOR_ERROR,
-    IMAGES_COUNT_LIMIT_EXCEEDED,
-    API_CALL_FAILED,
-    PROCESSING_FAILED,
-    NO_LICENSE
-}