Microsoft Face Detect


The microsoft_face_detect image processing platform allows you to use the Microsoft Face Identify API through Home Assistant. This platform enables you do detect face 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.

Configuration

# Example configuration.yaml entry
image_processing:
  - platform: microsoft_face_detect
    source:
      - entity_id: camera.door

Configuration Variables

confidence

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

Default value: 80

source

(list)(Required)List of image sources.

entity_id

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

name

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

attributes

(list)(Optional)The image search attributes. Supported: age, gender, glasses.

Default value: [age, gender]