Microsoft Face Identify

The microsoft_face_identify image processing platform lets you use Microsoft Face identify API through Home Assistant. This platform allow you do identify persons on camera and fire an event with attributes.

Please refer to the Microsoft Face component configuration on how to setup the API key.

For using the result inside an automation rule, take a look at the Image Processing component page.

The free version of the Microsoft Face identify API limits the number of requests possible per month. Therefore, it is strongly recommended that you limit the scan_interval when setting up an instance of this entity as detailed on the main Image Processing component page.


# Example configuration.yaml entry
  - platform: microsoft_face_identify
    group: family
      - entity_id: camera.door

Configuration Variables


(string)(Required)Micrsoft face group to detect person from it.


(integer)(Optional)The minimum of confidence in percent to process with Home Assistant.

Default value: 80


(list)(Required)List of image sources.


(string)(Required)A camera entity id to get picture from.


(string)(Optional)This parameter allows you to override the name of your image_processing entity.