Package version:

Interface DetectQueryParamProperties

interface DetectQueryParamProperties {
    detectionModel?: string;
    faceIdTimeToLive?: number;
    recognitionModel?: string;
    returnFaceAttributes?: {};
    returnFaceId?: boolean;
    returnFaceLandmarks?: boolean;
    returnRecognitionModel?: boolean;
}

Properties

detectionModel? faceIdTimeToLive? recognitionModel? returnFaceAttributes? returnFaceId? returnFaceLandmarks? returnRecognitionModel?

Properties

Optional detectionModel

detectionModel?: string

The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'.

Optional faceIdTimeToLive

faceIdTimeToLive?: number

The number of seconds for the face ID being cached. Supported range from 60 seconds up to 86400 seconds. The default value is 86400 (24 hours).

Optional recognitionModel

recognitionModel?: string

The 'recognitionModel' associated with the detected faceIds. Supported 'recognitionModel' values include 'recognition_01', 'recognition_02', 'recognition_03' or 'recognition_04'. The default value is 'recognition_01'. 'recognition_04' is recommended since its accuracy is improved on faces wearing masks compared with 'recognition_03', and its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.

Optional returnFaceAttributes

returnFaceAttributes?: {}

Analyze and return the one or more specified face attributes in the comma-separated string like 'returnFaceAttributes=headPose,glasses'. Face attribute analysis has additional computational and time cost.

Type declaration

    Optional returnFaceId

    returnFaceId?: boolean

    Return faceIds of the detected faces or not. The default value is true.

    Optional returnFaceLandmarks

    returnFaceLandmarks?: boolean

    Return face landmarks of the detected faces or not. The default value is false.

    Optional returnRecognitionModel

    returnRecognitionModel?: boolean

    Return 'recognitionModel' or not. The default value is false. This is only applicable when returnFaceId = true.

    Settings

    Member Visibility

    Theme