Class DetectFacesRequest

Detect Faces Request. Could be created by predefined scenarios (e.g: DetectFacesRequest.qualityICAO, DetectFacesRequest.cropAllFaces etc. ) or by using custom DetectFacesConfig.

Index

Constructors

Methods

allAttributes cropAllFaces cropCentralFace qualityFull qualityICAO qualityVisaSchengen qualityVisaUSA thumbnail

Constructors

constructor

new DetectFacesRequest(
    image: string,
    config: DetectFacesConfig,
    options?: { tag?: string },
): DetectFacesRequest
Create DetectFacesRequest object.
Parameters
- image: string
  Image base64.
- config: DetectFacesConfig
  Custom Request configuration to specify image, quality, attributes parameters.
- Optionaloptions: { tag?: string }
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:17

Methods

`Static`allAttributes

allAttributes(image: string): DetectFacesRequest
Creates a request for all available attribute results.
Parameters
- image: string
  Image base64.
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:79

`Static`cropAllFaces

cropAllFaces(image: string): DetectFacesRequest
Creates a request for cropped portraits of all the people in the image.
Parameters
- image: string
  Image base64.
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:65

`Static`cropCentralFace

cropCentralFace(image: string): DetectFacesRequest
Creates a request for a cropped portrait of the person whose face is the most central.
Parameters
- image: string
  Image base64.
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:58

`Static`qualityFull

qualityFull(image: string): DetectFacesRequest
Creates a request to check all the available quality characteristics.
Parameters
- image: string
  Image base64.
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:30

`Static`qualityICAO

qualityICAO(image: string): DetectFacesRequest
Creates a request to check the quality characteristics based on the ICAO standard.
Parameters
- image: string
  Image base64.
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:37

`Static`qualityVisaSchengen

qualityVisaSchengen(image: string): DetectFacesRequest
Creates a request to check the quality characteristics based on the Schengen visa standard.
Parameters
- image: string
  Image base64.
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:44

`Static`qualityVisaUSA

qualityVisaUSA(image: string): DetectFacesRequest
Creates a request to check the quality characteristics based on the USA visa standard.
Parameters
- image: string
  Image base64.
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:51

`Static`thumbnail

thumbnail(image: string): DetectFacesRequest
Creates a request for a cropped portrait of the person whose face is the most central in the image in the original size.
Parameters
- image: string
  Image base64.
Returns DetectFacesRequest
- Defined in detect_faces/detect_faces_request.d.ts:72