Microsoft Face

The microsoft_face component platform is the main component for Microsoft Azure Cognitive service Face. All data are stored in your own private instance in the Azure cloud.

You need an API key, which is free, but requires an Azure registration using your Microsoft ID. The free resource (F0) is limited to 20 requests per minute and 30k requests in a month. If you don’t want to use the Azure cloud, you can also get an API key by registering with cognitive-services. Please note that all keys on cognitive services must be recreated every 90 days.

To enable the Microsoft Face component, add the following to your configuration.yaml:

timeout (Optional): Set timeout for the API connection. Defaults to 10s.

Person and Groups

For most services, you need to set up a group or a person. This limits the processing and detection to elements provided by the group. Home Assistant creates an entity for all groups and allows you to show the state, person, and IDs directly on the frontend.

The following services are available for managing this feature and can be called via the Frontend, a script, or the REST API.

microsoft_face.create_group

microsoft_face.delete_group

service:microsoft_face.create_groupdata:name:'Family'

microsoft_face.create_person

microsoft_face.delete_person

service:microsoft_face.create_persondata:group:familyname:'HansMaier'

You need to add an image of a person. You can add multiple images for every person to make the detection better. You can take a picture from a camera or send a local image to your Azure resource.