models Package

Classes

APIError

Error information returned by the API.

APIErrorException

Server responsed with exception of type: 'APIError'.

Accessory

Accessory item and corresponding confidence level.

ApplySnapshotRequest

Request body for applying snapshot operation.

All required parameters must be populated in order to send to Azure.

Blur

Properties describing any presence of blur within the image.

Coordinate

Coordinates within an image.

All required parameters must be populated in order to send to Azure.

DetectedFace

Detected Face object.

All required parameters must be populated in order to send to Azure.

Emotion

Properties describing facial emotion in form of confidence ranging from 0 to 1.

Error

Error body.

Exposure

Properties describing exposure level of the image.

FaceAttributes

Face Attributes.

FaceLandmarks

A collection of 27-point face landmarks pointing to the important positions of face components.

FaceList

Face list object.

All required parameters must be populated in order to send to Azure.

FaceRectangle

A rectangle within which a face can be found.

All required parameters must be populated in order to send to Azure.

FacialHair

Properties describing facial hair attributes.

FindSimilarRequest

Request body for find similar operation.

All required parameters must be populated in order to send to Azure.

GroupRequest

Request body for group request.

All required parameters must be populated in order to send to Azure.

GroupResult

An array of face groups based on face similarity.

All required parameters must be populated in order to send to Azure.

Hair

Properties describing hair attributes.

HairColor

Hair color and associated confidence.

HeadPose

Properties indicating head pose of the face.

IdentifyCandidate

All possible faces that may qualify.

All required parameters must be populated in order to send to Azure.

IdentifyRequest

Request body for identify face operation.

All required parameters must be populated in order to send to Azure.

IdentifyResult

Response body for identify face operation.

All required parameters must be populated in order to send to Azure.

ImageUrl

ImageUrl.

All required parameters must be populated in order to send to Azure.

LargeFaceList

Large face list object.

All required parameters must be populated in order to send to Azure.

LargePersonGroup

Large person group object.

All required parameters must be populated in order to send to Azure.

Makeup

Properties describing the presence of makeup on a given face.

Mask

Properties describing the presence of a mask on a given face.

MetaDataContract

A combination of user defined name and user specified data and recognition model name for largePersonGroup/personGroup, and largeFaceList/faceList.

All required parameters must be populated in order to send to Azure.

NameAndUserDataContract

A combination of user defined name and user specified data for the person, largePersonGroup/personGroup, and largeFaceList/faceList.

Noise

Properties describing noise level of the image.

Occlusion

Properties describing occlusions on a given face.

OperationStatus

Operation status object. Operation refers to the asynchronous backend task including taking a snapshot and applying a snapshot.

All required parameters must be populated in order to send to Azure.

PersistedFace

PersonFace object.

All required parameters must be populated in order to send to Azure.

Person

Person object.

All required parameters must be populated in order to send to Azure.

PersonGroup

Person group object.

All required parameters must be populated in order to send to Azure.

SimilarFace

Response body for find similar face operation.

All required parameters must be populated in order to send to Azure.

Snapshot

Snapshot object.

All required parameters must be populated in order to send to Azure.

TakeSnapshotRequest

Request body for taking snapshot operation.

All required parameters must be populated in order to send to Azure.

TrainingStatus

Training status object.

All required parameters must be populated in order to send to Azure.

UpdateFaceRequest

Request to update face data.

UpdateSnapshotRequest

Request body for updating a snapshot, with a combination of user defined apply scope and user specified data.

VerifyFaceToFaceRequest

Request body for face to face verification.

All required parameters must be populated in order to send to Azure.

VerifyFaceToPersonRequest

Request body for face to person verification.

All required parameters must be populated in order to send to Azure.

VerifyResult

Result of the verify operation.

All required parameters must be populated in order to send to Azure.

Enums

AccessoryType

An enumeration.

BlurLevel

An enumeration.

DetectionModel

An enumeration.

ExposureLevel

An enumeration.

FaceAttributeType

An enumeration.

FindSimilarMatchMode

An enumeration.

Gender

An enumeration.

GlassesType

An enumeration.

HairColorType

An enumeration.

MaskType

An enumeration.

NoiseLevel

An enumeration.

OperationStatusType

An enumeration.

QualityForRecognition

An enumeration.

RecognitionModel

An enumeration.

SnapshotApplyMode

An enumeration.

SnapshotObjectType

An enumeration.

TrainingStatusType

An enumeration.