models Package

Classes

AccessoryItem	Accessory item and corresponding confidence level. All required parameters must be populated in order to send to server.
AuditLivenessResponseInfo	Audit entry for a response in the session. All required parameters must be populated in order to send to server.
AuditRequestInfo	Audit entry for a request in the session. All required parameters must be populated in order to send to server.
BlurProperties	Properties describing any presence of blur within the image. All required parameters must be populated in order to send to server.
CreateLivenessSessionContent	Request for creating liveness session. All required parameters must be populated in order to send to server.
CreateLivenessSessionResult	Response of liveness session creation. All required parameters must be populated in order to send to server.
CreateLivenessWithVerifySessionResult	Response of liveness session with verify creation with verify image provided. All required parameters must be populated in order to send to server.
ExposureProperties	Properties describing exposure level of the image. All required parameters must be populated in order to send to server.
FaceAttributes	Face attributes for the detected face.
FaceDetectionResult	Response for detect API. All required parameters must be populated in order to send to server.
FaceError	The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages. All required parameters must be populated in order to send to server.
FaceErrorResponse	A response containing error details. All required parameters must be populated in order to send to server.
FaceFindSimilarResult	Response body for find similar face operation. All required parameters must be populated in order to send to server.
FaceGroupingResult	Response body for group face operation. All required parameters must be populated in order to send to server.
FaceLandmarks	A collection of 27-point face landmarks pointing to the important positions of face components. All required parameters must be populated in order to send to server.
FaceRectangle	A rectangle within which a face can be found. All required parameters must be populated in order to send to server.
FaceVerificationResult	Verify result. All required parameters must be populated in order to send to server.
FacialHair	Properties describing facial hair attributes. All required parameters must be populated in order to send to server.
HairColor	An array of candidate colors and confidence level in the presence of each. All required parameters must be populated in order to send to server.
HairProperties	Properties describing hair attributes. All required parameters must be populated in order to send to server.
HeadPose	3-D roll/yaw/pitch angles for face direction. All required parameters must be populated in order to send to server.
LandmarkCoordinate	Landmark coordinates within an image. All required parameters must be populated in order to send to server.
LivenessOutputsTarget	The liveness classification for target face. All required parameters must be populated in order to send to server.
LivenessResponseBody	The response body of detect liveness API call.
LivenessSession	Session result of detect liveness. Readonly variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
LivenessSessionAuditEntry	Audit entry for a request in session. All required parameters must be populated in order to send to server.
LivenessSessionItem	Session data returned for enumeration. Readonly variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
LivenessWithVerifyImage	The detail of face for verification. All required parameters must be populated in order to send to server.
LivenessWithVerifyOutputs	The face verification output. All required parameters must be populated in order to send to server.
LivenessWithVerifySession	Session result of detect liveness with verify. Readonly variables are only populated by the server, and will be ignored when sending a request. All required parameters must be populated in order to send to server.
MaskProperties	Properties describing the presence of a mask on a given face. All required parameters must be populated in order to send to server.
NoiseProperties	Properties describing noise level of the image. All required parameters must be populated in order to send to server.
OcclusionProperties	Properties describing occlusions on a given face. All required parameters must be populated in order to send to server.

Enums

AccessoryType	Type of the accessory.
BlurLevel	Indicates level of blurriness.
ExposureLevel	Indicates level of exposure.
FaceAttributeType	Available options for detect face with attribute.
FaceAttributeTypeDetection01	Available attribute options for detection_01 model.
FaceAttributeTypeDetection03	Available attribute options for detection_03 model.
FaceAttributeTypeRecognition03	Available attribute options for recognition_03 model.
FaceAttributeTypeRecognition04	Available attribute options for recognition_04 model.
FaceDetectionModel	The detection model for the face.
FaceImageType	The type of image.
FaceLivenessDecision	The outcome of the liveness classification.
FaceRecognitionModel	The recognition model for the face.
FaceSessionStatus	The current status of the session.
FindSimilarMatchMode	Similar face searching mode.
GlassesType	Glasses type of the face.
HairColorType	Name of the hair color.
LivenessModel	The model version used for liveness classification.
LivenessOperationMode	The liveness operation mode to drive the client's end-user experience.
MaskType	Type of the mask.
NoiseLevel	Indicates level of noise.
QualityForRecognition	Indicates quality of image for recognition.
Versions	API versions for Azure AI Face API.