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

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

@@ -0,0 +1,418 @@
+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

@@ -0,0 +1,8 @@
+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

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

@@ -1,24 +1,135 @@
+import { CameraPosition } from './customization/camera_position'
+import { CustomizationColors } from './customization/customization_colors'
+import { CustomizationFonts } from './customization/customization_fonts'
+import { CustomizationImages } from './customization/customization_images'
+import { Customization, CustomButtonTappedCompletion } from './customization/customization'
+import { Font } from './customization/font'
+import { ScreenOrientation } from './customization/screen_orientation'
+export { CameraPosition, CustomizationColors, CustomizationFonts, CustomizationImages, Customization, CustomButtonTappedCompletion, Font, ScreenOrientation }
 
+import { FaceSDKVersion } from './init/face_sdk_version'
 import { InitConfig } from './init/init_config'
 import { InitException } from './init/init_exception'
 import { InitErrorCode } from './init/init_exception'
 import { LicenseException } from './init/license_exception'
 import { LicensingResultCode } from './init/license_exception'
-export { InitConfig, InitException, InitErrorCode, LicenseException, LicensingResultCode }
+export { FaceSDKVersion, InitConfig, InitException, InitErrorCode, LicenseException, LicensingResultCode }
+
+import { DetectFaceResult } from './detect_faces/detect_face_result'
+import { DetectFacesAttributeResult } from './detect_faces/detect_faces_attribute_result'
+import { DetectFacesAttribute } from './detect_faces/detect_faces_attribute'
+import { DetectFacesBackendException, DetectFacesBackendErrorCode } from './detect_faces/detect_faces_backend_exception'
+import { DetectFacesConfig } from './detect_faces/detect_faces_config'
+import { DetectFacesException, DetectFacesErrorCode } from './detect_faces/detect_faces_exception'
+import { DetectFacesRequest } from './detect_faces/detect_faces_request'
+import { DetectFacesResponse } from './detect_faces/detect_faces_response'
+import { DetectFacesScenario } from './detect_faces/detect_faces_scenario'
+export { DetectFaceResult, DetectFacesAttributeResult, DetectFacesAttribute, DetectFacesBackendException, DetectFacesBackendErrorCode, DetectFacesConfig, DetectFacesException, DetectFacesErrorCode, DetectFacesRequest, DetectFacesResponse, DetectFacesScenario }
+
+import { FaceCaptureConfig } from './face_capture/face_capture_config'
+import { FaceCaptureException, FaceCaptureErrorCode } from './face_capture/face_capture_exception'
+import { FaceCaptureImage, ImageType } from './face_capture/face_capture_image'
+import { FaceCaptureResponse } from './face_capture/face_capture_response'
+export { FaceCaptureConfig, FaceCaptureException, FaceCaptureErrorCode, FaceCaptureImage, ImageType, FaceCaptureResponse }
+
+import { OutputImageCrop, OutputImageCropAspectRatio } from './image_params/output_image_crop'
+import { OutputImageParams } from './image_params/output_image_params'
+import { Point } from './image_params/point'
+import { Rect } from './image_params/rect'
+import { Size } from './image_params/size'
+export { OutputImageCrop, OutputImageCropAspectRatio, OutputImageParams, Point, Rect, Size }
+
+import { ImageQualityCharacteristicName } from './image_quality/image_quality_characteristic_name'
+import { ImageQualityCharacteristic } from './image_quality/image_quality_characteristic'
+import { ImageQualityGroup } from './image_quality/image_quality_group'
+import { ImageQualityRange } from './image_quality/image_quality_range'
+import { ImageQualityResult, ImageQualityGroupName, ImageQualityResultStatus } from './image_quality/image_quality_result'
+export { ImageQualityCharacteristicName, ImageQualityCharacteristic, ImageQualityGroup, ImageQualityRange, ImageQualityResult, ImageQualityGroupName, ImageQualityResultStatus }
 
-import { CameraPosition } from './customization/camera_position'
-import { ScreenOrientation } from './customization/screen_orientation'
 import { LivenessBackendException, LivenessBackendErrorCode } from './liveness/liveness_backend_exception'
 import { LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep } from './liveness/liveness_config'
 import { LivenessException, LivenessErrorCode } from './liveness/liveness_exception'
 import { LivenessNotification, LivenessProcessStatus, LivenessNotificationCompletion } from './liveness/liveness_notification'
 import { LivenessResponse, LivenessStatus } from './liveness/liveness_response'
-export { LivenessBackendException, LivenessBackendErrorCode, LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep, LivenessException, LivenessErrorCode, LivenessNotification, LivenessProcessStatus, LivenessNotificationCompletion, LivenessResponse, LivenessStatus, CameraPosition, ScreenOrientation }
+export { LivenessBackendException, LivenessBackendErrorCode, LivenessConfig, RecordingProcess, LivenessType, LivenessSkipStep, LivenessException, LivenessErrorCode, LivenessNotification, LivenessProcessStatus, LivenessNotificationCompletion, LivenessResponse, LivenessStatus }
+
+import { ComparedFace } from './match_faces/compared_face'
+import { ComparedFacesPair } from './match_faces/compared_faces_pair'
+import { ComparedFacesSplit } from './match_faces/compared_faces_split'
+import { MatchFacesBackendException } from './match_faces/match_faces_backend_exception'
+import { MatchFacesConfig, ProcessingMode } from './match_faces/match_faces_config'
+import { MatchFacesDetectionFace } from './match_faces/match_faces_detection_face'
+import { MatchFacesDetection } from './match_faces/match_faces_detection'
+import { MatchFacesException, MatchFacesErrorCode } from './match_faces/match_faces_exception'
+import { MatchFacesImage } from './match_faces/match_faces_image'
+import { MatchFacesRequest } from './match_faces/match_faces_request'
+import { MatchFacesResponse } from './match_faces/match_faces_response'
+export { ComparedFace, ComparedFacesPair, ComparedFacesSplit, MatchFacesBackendException, MatchFacesConfig, ProcessingMode, MatchFacesDetectionFace, MatchFacesDetection, MatchFacesException, MatchFacesErrorCode, MatchFacesImage, MatchFacesRequest, MatchFacesResponse }
+
+import { EditGroupPersonsRequest } from './person_database/edit_group_persons_request'
+import { ImageUpload } from './person_database/image_upload'
+import { PageableItemList } from './person_database/pageable_item_list'
+import { PersonDatabase } from './person_database/person_database'
+import { PersonGroup } from './person_database/person_group'
+import { PersonImage } from './person_database/person_image'
+import { Person } from './person_database/person'
+import { SearchPersonDetection } from './person_database/search_person_detection'
+import { SearchPersonImage } from './person_database/search_person_image'
+import { SearchPersonRequest } from './person_database/search_person_request'
+import { SearchPerson } from './person_database/search_person'
+export { EditGroupPersonsRequest, ImageUpload, PageableItemList, PersonDatabase, PersonGroup, PersonImage, Person, SearchPersonDetection, SearchPersonImage, SearchPersonRequest, SearchPerson }
 
 /**
  * Entry point of the Regula Face SDK.
  */
 export class FaceSDK {
+    /**
+     * The only instance of singleton class {@link FaceSDK}.
+     */
+    static get instance(): FaceSDK
+    private constructor()
+
+    /**
+     * Information about the SDK.
+     */
+    get version(): FaceSDKVersion | null
+
+    get serviceUrl(): string | null
+    set serviceUrl(val: string | null)
+
+    /**
+     * A localization dictionary to override default localization logic.
+     * Allows to replace any string of FaceSDK with an arbitrary string.
+     * 
+     * To see all the localization keys, look up the RegulaSDK.strings file at
+     * ios/Pods/FaceSDK/FaceSDK.xcframework/ios-arm64/FaceSDK.framework/FaceSDK.bundle/en.lproj/FaceSDK.strings.
+     * 
+     * Immutable property. Use setter instead of editing.
+     */
+    get localizationDictionary(): Record<string, string> | null
+    set localizationDictionary(val: Record<string, string> | null)
+
+    /**
+     * Immutable property. Use setter instead of editing.
+     */
+    get requestHeaders(): Record<string, string> | null
+    set requestHeaders(val: Record<string, string> | null)
+
+    get customization(): Customization
+    set customization(val: Customization)
+
+    /**
+     * Allows user to receive a video file of current session.
+     */
+    set videoEncoderCompletion(completion: VideoEncoderCompletion)
+
+    get personDatabase(): PersonDatabase
+
+    /**
+     * Checks if FaceSDK is initialized.
+     */
+    isInitialized(): Promise<boolean>
+
     /**
      * Allows you to initialize FaceSDK.
      * 
@@ -39,6 +150,15 @@ export class FaceSDK {
      */
     deinitialize(): void
 
+    startFaceCapture(
+        params?: {
+            config?: FaceCaptureConfig,
+            cameraSwitchCallback?: CameraSwitchCallback,
+        }
+    ): Promise<FaceCaptureResponse>
+
+    stopFaceCapture(): void
+
     startLiveness(
         params?: {
             config?: LivenessConfig,
@@ -48,6 +168,22 @@ export class FaceSDK {
     ): Promise<LivenessResponse>
 
     stopLiveness(): void
+
+    matchFaces(
+        request: MatchFacesRequest,
+        params?: {
+            config?: MatchFacesConfig
+        }
+    ): Promise<MatchFacesResponse>
+
+    splitComparedFaces(
+        facesPairs: Array<ComparedFacesPair>,
+        similarityThreshold: number
+    ): Promise<ComparedFacesSplit>
+
+    detectFaces(request: DetectFacesRequest): Promise<DetectFacesResponse>
 }
 
+export type VideoEncoderCompletion = (transactionId: string, success: boolean) => void
+
 export type CameraSwitchCallback = (cameraId: number) => void

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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,29 @@
+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()
+}