DetectFromSessionImageIdQueryParamProperties interface

Package:

@azure-rest/ai-vision-face

Properties

detectionModel	The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. 'detection_03' is recommended since its accuracy is improved on smaller faces (64x64 pixels) and rotated face orientations. Possible values: "detection_01", "detection_02", "detection_03"
faceIdTimeToLive	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).
recognitionModel	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'. Possible values: "recognition_01", "recognition_02", "recognition_03", "recognition_04"
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.
returnFaceId	Return faceIds of the detected faces or not. The default value is true.
returnFaceLandmarks	Return face landmarks of the detected faces or not. The default value is false.
returnRecognitionModel	Return 'recognitionModel' or not. The default value is false. This is only applicable when returnFaceId = true.

Property Details

detectionModel

The 'detectionModel' associated with the detected faceIds. Supported 'detectionModel' values include 'detection_01', 'detection_02' and 'detection_03'. The default value is 'detection_01'. 'detection_03' is recommended since its accuracy is improved on smaller faces (64x64 pixels) and rotated face orientations.

Possible values: "detection_01", "detection_02", "detection_03"

detectionModel?: string

Property Value

string

faceIdTimeToLive

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).

faceIdTimeToLive?: number

Property Value

number

recognitionModel

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'.

Possible values: "recognition_01", "recognition_02", "recognition_03", "recognition_04"

recognitionModel?: string

Property Value

string

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.

returnFaceAttributes?: string[] | DetectFromSessionImageIdReturnFaceAttributesQueryParam

Property Value

string[] | DetectFromSessionImageIdReturnFaceAttributesQueryParam

returnFaceId

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

returnFaceId?: boolean

Property Value

boolean

returnFaceLandmarks

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

returnFaceLandmarks?: boolean

Property Value

boolean

returnRecognitionModel

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

returnRecognitionModel?: boolean

Property Value

boolean