Class MatchFacesRequest

Compares two or more images with faces on them to find out the similarity of pairs. The request is used as a parameter to FaceSDK.matchFaces.

Index

Constructors

Accessors

images metadata outputImageParams tag

Constructors

constructor

new MatchFacesRequest(
    images: MatchFacesImage[],
    options?: {
        metadata?: Record<string, any>;
        outputImageParams?: OutputImageParams;
        tag?: string;
    },
): MatchFacesRequest
Parameters
- images: MatchFacesImage[]
- Optionaloptions: {
      metadata?: Record<string, any>;
      outputImageParams?: OutputImageParams;
      tag?: string;
  }
Returns MatchFacesRequest
- Defined in match_faces/match_faces_request.d.ts:26

Accessors

images

get images(): MatchFacesImage[]
Images with faces to match.

Returns MatchFacesImage[]
- Defined in match_faces/match_faces_request.d.ts:12

metadata

get metadata(): Record<string, any> | null
Returns Record<string, any> | null
- Defined in match_faces/match_faces_request.d.ts:24

outputImageParams

get outputImageParams(): OutputImageParams | null
If set the uploaded image is processed according to the indicated settings.

Returns OutputImageParams | null
- Defined in match_faces/match_faces_request.d.ts:17

tag

get tag(): string | null
Defines tag that can be used in match faces processing. Defaults to null.

Returns string | null
- Defined in match_faces/match_faces_request.d.ts:22