@azure/cognitiveservices-face
v5.0.0
Published
FaceClient Library with typescript type definitions for node.js and browser.
Downloads
2,693
Readme
An isomorphic javascript sdk for - FaceClient
This package contains an isomorphic SDK for FaceClient.
Currently supported environments
- LTS versions of Node.js
- Latest versions of Safari, Chrome, Edge, and Firefox.
How to Install
npm install @azure/cognitiveservices-face
How to use
nodejs - Authentication, client creation and list personGroupPerson as an example written in TypeScript.
Install @azure/ms-rest-azure-js
npm install @azure/ms-rest-azure-js
Sample code
The following sample detects the facial features on the given image. To know more, refer to the Azure Documentation on Face APIs
const { FaceClient, FaceModels } = require("@azure/cognitiveservices-face");
const { CognitiveServicesCredentials } = require("@azure/ms-rest-azure-js");
async function main() {
const faceKey = process.env["faceKey"] || "<faceKey>";
const faceEndPoint = process.env["faceEndPoint"] || "<faceEndPoint>";
const cognitiveServiceCredentials = new CognitiveServicesCredentials(faceKey);
const client = new FaceClient(cognitiveServiceCredentials, faceEndPoint);
const url =
"https://pbs.twimg.com/profile_images/3354326900/3a5168f2b45c07d0965098be1a4e3007.jpeg";
const options = {
returnFaceLandmarks: true
};
client.face
.detectWithUrl(url, options)
.then(result => {
console.log("The result is: ");
console.log(result);
})
.catch(err => {
console.log("An error occurred:");
console.error(err);
});
}
main();
browser - Authentication, client creation and list personGroupPerson as an example written in JavaScript.
Sample code
- index.html
<!DOCTYPE html>
<html lang="en">
<head>
<title>@azure/cognitiveservices-face sample</title>
<script src="node_modules/@azure/ms-rest-js/dist/msRest.browser.js"></script>
<script src="node_modules/@azure/cognitiveservices-face/dist/cognitiveservices-face.js"></script>
<script type="text/javascript">
const faceKey = "<YOUR_FACE_KEY>";
const faceEndPoint = "<YOUR_FACE_ENDPOINT>";
const cognitiveServiceCredentials = new msRest.ApiKeyCredentials({
inHeader: {
"Ocp-Apim-Subscription-Key": faceKey
}
});
const client = new Azure.CognitiveservicesFace.FaceClient(
cognitiveServiceCredentials,
faceEndPoint
);
const url =
"https://pbs.twimg.com/profile_images/3354326900/3a5168f2b45c07d0965098be1a4e3007.jpeg";
const options = {
returnFaceLandmarks: true
};
client.face
.detectWithUrl(url, options)
.then(result => {
console.log("The result is: ");
console.log(result);
})
.catch(err => {
console.log("An error occurred:");
console.error(err);
});
</script>
</head>
<body></body>
</html>