2024.10.4
Home ▸ Integrations ▸

Microsoft Face Detect

The microsoft_face_detect image processing integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to use the Microsoft Face Identify API through Home Assistant. This platform enables you to detect face on camera and fire an event with attributes.

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

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

Important

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 integration page.

Configuration

To enable the integration, add it to your configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes.

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

Configuration Variables

Looking for your configuration file?
confidence integer (Optional, default: 80)

The minimum of confidence in percent to process with Home Assistant.

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, default: [age, gender])

The image search attributes. Supported: age, gender, glasses.

Related topics