@azure/cognitiveservices-face package

Classes

FaceClient
FaceClientContext
Face

Class representing a Face.

FaceListOperations

Class representing a FaceListOperations.

LargeFaceListOperations

Class representing a LargeFaceListOperations.

LargePersonGroupOperations

Class representing a LargePersonGroupOperations.

LargePersonGroupPerson

Class representing a LargePersonGroupPerson.

PersonGroupOperations

Class representing a PersonGroupOperations.

PersonGroupPerson

Class representing a PersonGroupPerson.

SnapshotOperations

Class representing a SnapshotOperations.

Interfaces

APIError

Error information returned by the API

Accessory

Accessory item and corresponding confidence level.

ApplySnapshotRequest

Request body for applying snapshot operation.

Blur

Properties describing any presence of blur within the image.

Coordinate

Coordinates within an image

DetectedFace

Detected Face object.

Emotion

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

ErrorModel

Error body.

Exposure

Properties describing exposure level of the image.

FaceAttributes

Face Attributes

FaceDetectWithStreamOptionalParams

Optional Parameters.

FaceDetectWithUrlOptionalParams

Optional Parameters.

FaceFindSimilarOptionalParams

Optional Parameters.

FaceIdentifyOptionalParams

Optional Parameters.

FaceLandmarks

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

FaceList

Face list object.

FaceListAddFaceFromStreamOptionalParams

Optional Parameters.

FaceListAddFaceFromUrlOptionalParams

Optional Parameters.

FaceListCreateOptionalParams

Optional Parameters.

FaceListGetOptionalParams

Optional Parameters.

FaceListListOptionalParams

Optional Parameters.

FaceListUpdateOptionalParams

Optional Parameters.

FaceRectangle

A rectangle within which a face can be found

FaceVerifyFaceToPersonOptionalParams

Optional Parameters.

FacialHair

Properties describing facial hair attributes.

FindSimilarRequest

Request body for find similar operation.

GroupRequest

Request body for group request.

GroupResult

An array of face groups based on face similarity.

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.

IdentifyRequest

Request body for identify face operation.

IdentifyResult

Response body for identify face operation.

ImageUrl

An interface representing ImageUrl.

LargeFaceList

Large face list object.

LargeFaceListAddFaceFromStreamOptionalParams

Optional Parameters.

LargeFaceListAddFaceFromUrlOptionalParams

Optional Parameters.

LargeFaceListCreateOptionalParams

Optional Parameters.

LargeFaceListGetOptionalParams

Optional Parameters.

LargeFaceListListFacesOptionalParams

Optional Parameters.

LargeFaceListListOptionalParams

Optional Parameters.

LargeFaceListUpdateFaceOptionalParams

Optional Parameters.

LargeFaceListUpdateOptionalParams

Optional Parameters.

LargePersonGroup

Large person group object.

LargePersonGroupCreateOptionalParams

Optional Parameters.

LargePersonGroupGetOptionalParams

Optional Parameters.

LargePersonGroupListOptionalParams

Optional Parameters.

LargePersonGroupPersonAddFaceFromStreamOptionalParams

Optional Parameters.

LargePersonGroupPersonAddFaceFromUrlOptionalParams

Optional Parameters.

LargePersonGroupPersonCreateOptionalParams

Optional Parameters.

LargePersonGroupPersonListOptionalParams

Optional Parameters.

LargePersonGroupPersonUpdateFaceOptionalParams

Optional Parameters.

LargePersonGroupPersonUpdateOptionalParams

Optional Parameters.

LargePersonGroupUpdateOptionalParams

Optional Parameters.

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.

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.

PersistedFace

PersonFace object.

Person

Person object.

PersonGroup

Person group object.

PersonGroupCreateOptionalParams

Optional Parameters.

PersonGroupGetOptionalParams

Optional Parameters.

PersonGroupListOptionalParams

Optional Parameters.

PersonGroupPersonAddFaceFromStreamOptionalParams

Optional Parameters.

PersonGroupPersonAddFaceFromUrlOptionalParams

Optional Parameters.

PersonGroupPersonCreateOptionalParams

Optional Parameters.

PersonGroupPersonListOptionalParams

Optional Parameters.

PersonGroupPersonUpdateFaceOptionalParams

Optional Parameters.

PersonGroupPersonUpdateOptionalParams

Optional Parameters.

PersonGroupUpdateOptionalParams

Optional Parameters.

SimilarFace

Response body for find similar face operation.

Snapshot

Snapshot object.

SnapshotApplyHeaders

Defines headers for Apply operation.

SnapshotApplyOptionalParams

Optional Parameters.

SnapshotListOptionalParams

Optional Parameters.

SnapshotTakeHeaders

Defines headers for Take operation.

SnapshotTakeOptionalParams

Optional Parameters.

SnapshotUpdateOptionalParams

Optional Parameters.

TakeSnapshotRequest

Request body for taking snapshot operation.

TrainingStatus

Training status object.

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.

VerifyFaceToPersonRequest

Request body for face to person verification.

VerifyResult

Result of the verify operation.

Type Aliases

AccessoryType

Defines values for AccessoryType. Possible values include: 'headWear', 'glasses', 'mask'

BlurLevel

Defines values for BlurLevel. Possible values include: 'Low', 'Medium', 'High'

DetectionModel

Defines values for DetectionModel. Possible values include: 'detection_01', 'detection_02', 'detection_03'

ExposureLevel

Defines values for ExposureLevel. Possible values include: 'UnderExposure', 'GoodExposure', 'OverExposure'

FaceAttributeType

Defines values for FaceAttributeType. Possible values include: 'age', 'gender', 'headPose', 'smile', 'facialHair', 'glasses', 'emotion', 'hair', 'makeup', 'occlusion', 'accessories', 'blur', 'exposure', 'noise', 'mask'

FaceDetectWithStreamResponse

Contains response data for the detectWithStream operation.

FaceDetectWithUrlResponse

Contains response data for the detectWithUrl operation.

FaceFindSimilarResponse

Contains response data for the findSimilar operation.

FaceGroupResponse

Contains response data for the group operation.

FaceIdentifyResponse

Contains response data for the identify operation.

FaceListAddFaceFromStreamResponse

Contains response data for the addFaceFromStream operation.

FaceListAddFaceFromUrlResponse

Contains response data for the addFaceFromUrl operation.

FaceListGetResponse

Contains response data for the get operation.

FaceListListResponse

Contains response data for the list operation.

FaceVerifyFaceToFaceResponse

Contains response data for the verifyFaceToFace operation.

FaceVerifyFaceToPersonResponse

Contains response data for the verifyFaceToPerson operation.

FindSimilarMatchMode

Defines values for FindSimilarMatchMode. Possible values include: 'matchPerson', 'matchFace'

Gender

Defines values for Gender. Possible values include: 'male', 'female'

GlassesType

Defines values for GlassesType. Possible values include: 'noGlasses', 'readingGlasses', 'sunglasses', 'swimmingGoggles'

HairColorType

Defines values for HairColorType. Possible values include: 'unknown', 'white', 'gray', 'blond', 'brown', 'red', 'black', 'other'

LargeFaceListAddFaceFromStreamResponse

Contains response data for the addFaceFromStream operation.

LargeFaceListAddFaceFromUrlResponse

Contains response data for the addFaceFromUrl operation.

LargeFaceListGetFaceResponse

Contains response data for the getFace operation.

LargeFaceListGetResponse

Contains response data for the get operation.

LargeFaceListGetTrainingStatusResponse

Contains response data for the getTrainingStatus operation.

LargeFaceListListFacesResponse

Contains response data for the listFaces operation.

LargeFaceListListResponse

Contains response data for the list operation.

LargePersonGroupGetResponse

Contains response data for the get operation.

LargePersonGroupGetTrainingStatusResponse

Contains response data for the getTrainingStatus operation.

LargePersonGroupListResponse

Contains response data for the list operation.

LargePersonGroupPersonAddFaceFromStreamResponse

Contains response data for the addFaceFromStream operation.

LargePersonGroupPersonAddFaceFromUrlResponse

Contains response data for the addFaceFromUrl operation.

LargePersonGroupPersonCreateResponse

Contains response data for the create operation.

LargePersonGroupPersonGetFaceResponse

Contains response data for the getFace operation.

LargePersonGroupPersonGetResponse

Contains response data for the get operation.

LargePersonGroupPersonListResponse

Contains response data for the list operation.

MaskType

Defines values for MaskType. Possible values include: 'noMask', 'faceMask', 'otherMaskOrOcclusion', 'uncertain'

NoiseLevel

Defines values for NoiseLevel. Possible values include: 'Low', 'Medium', 'High'

OperationStatusType

Defines values for OperationStatusType. Possible values include: 'notstarted', 'running', 'succeeded', 'failed'

PersonGroupGetResponse

Contains response data for the get operation.

PersonGroupGetTrainingStatusResponse

Contains response data for the getTrainingStatus operation.

PersonGroupListResponse

Contains response data for the list operation.

PersonGroupPersonAddFaceFromStreamResponse

Contains response data for the addFaceFromStream operation.

PersonGroupPersonAddFaceFromUrlResponse

Contains response data for the addFaceFromUrl operation.

PersonGroupPersonCreateResponse

Contains response data for the create operation.

PersonGroupPersonGetFaceResponse

Contains response data for the getFace operation.

PersonGroupPersonGetResponse

Contains response data for the get operation.

PersonGroupPersonListResponse

Contains response data for the list operation.

RecognitionModel

Defines values for RecognitionModel. Possible values include: 'recognition_01', 'recognition_02', 'recognition_03', 'recognition_04'

SnapshotApplyMode

Defines values for SnapshotApplyMode. Possible values include: 'CreateNew'

SnapshotApplyResponse

Contains response data for the apply operation.

SnapshotGetOperationStatusResponse

Contains response data for the getOperationStatus operation.

SnapshotGetResponse

Contains response data for the get operation.

SnapshotListResponse

Contains response data for the list operation.

SnapshotObjectType

Defines values for SnapshotObjectType. Possible values include: 'FaceList', 'LargeFaceList', 'LargePersonGroup', 'PersonGroup'

SnapshotTakeResponse

Contains response data for the take operation.

TrainingStatusType

Defines values for TrainingStatusType. Possible values include: 'nonstarted', 'running', 'succeeded', 'failed'