Adapter - Azure Face
This page describes version 2.0.6 of the adapter.
Overview
This adapter uses the Microsoft Azure Face service to provide functionality to detect faces in an image, and verify if two faces are the same person.
Properties
| Name |
Display |
Is Required |
Comments |
Type |
Default Value |
Maximum Value |
Minimum Value |
Maximum Length |
Minimum Length |
| faceSubscriptionKey |
Face Subscription Key |
True |
Subscription Key for the Face API. |
password |
|
|
|
1024 |
1 |
| faceApiUrl |
Face API URL |
True |
URL to the Face API. |
string |
|
|
|
1024 |
1 |
Commands
Detect Faces (detectFaces)
Detect faces in an image.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
image |
Input image |
True |
string |
Response Properties
| Name |
Description |
Type |
| detectedFaces |
The array of faces. |
array |
| detectedFaces.faceId |
GUID for face found. |
string |
| detectedFaces.age |
The approximate Age of face found. |
string |
| detectedFaces.gender |
The detected gender of face found. |
string |
| detectedFaces.beard |
Confidence score indicating if a beard exists or not (0-1). |
string |
| detectedFaces.mustache |
Confidence score indicating if a mustache exists or not (0-1). |
string |
| detectedFaces.glasses |
A list of values indicating the type of glasses. This will be one of the following value: NoGlasses, Sunglasses, ReadingGlasses, SwimmingGoggles. |
string |
| detectedFaces.smile |
Confidence score indicating the face is smiling or not (0-1). |
string |
| detectedFaces.height |
The height of the face rectangle of the detected face. |
string |
| detectedFaces.width |
The width of the face rectangle of the detected face. |
string |
| detectedFaces.top |
The top point of the face rectangle of the detected face. |
string |
| detectedFaces.left |
the left point of the face rectangle of the detected face. |
string |
Detect Face Mask (detectFacesWithMask)
Detect faces in an image wearing masks.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image |
image |
Input image |
True |
string |
Response Properties
| Name |
Description |
Type |
| detectedFaces |
The array of faces. |
array |
| detectedFaces.faceId |
GUID for face found. |
string |
| detectedFaces.noseAndMouthCovered |
true, if both the nose and mouth are covered with a mask |
string |
| detectedFaces.maskType |
The mask type (i.e. NoMask, FaskMask, OtherMaskOrOcclusion or Uncertain). |
string |
| detectedFaces.height |
The height of the face rectangle of the detected face. |
string |
| detectedFaces.width |
The width of the face rectangle of the detected face. |
string |
| detectedFaces.top |
The top point of the face rectangle of the detected face. |
string |
| detectedFaces.left |
the left point of the face rectangle of the detected face. |
string |
Verify Faces (verifyFaces)
Verify 2 detected faces for similarity.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| faceId1 |
Face Id 1 |
Face GUID of the first face (received from Azure after detecting face). |
True |
string |
| faceId2 |
Face Id 2 |
Face GUID of the second face (received from Azure after detecting face). |
True |
string |
Response Properties
| Name |
Description |
Type |
| isIdentical |
True if the 2 faces belong to the same person. False otherwise. |
string |
| confidence |
Number indicating face similarity confidence. (0-1). |
string |
Detect And Verify Faces (detectAndVerifyFaces)
Detect faces in 2 images and compare them for similarity.
Request Properties
| Name |
Display |
Description |
Is Required |
Type |
| image1 |
Image 1 |
First input image. (In case of more than 1 face, error is returned). |
True |
string |
| image2 |
Image 2 |
Second input image. (In case of more than 1 face, error is returned). |
True |
string |
Response Properties
| Name |
Description |
Type |
| isIdentical |
True if the 2 faces belong to the same person. False otherwise. |
string |
| confidence |
The confidence value of the 2 faces belonging to the same person. |
string |
Release History
| Version |
Type |
Description |
Tracking # |
Date |
| 2.0.1 |
Initial |
First release in the Adapter Type store. |
|
|
| 2.0.5 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-11518 |
|
| 2.0.6 |
Maintenance |
Updated third-party components and improved maintainability. |
NAP-23945 |
2022-11-30 |
Categories