home-assistant.io/source/_integrations/microsoft_face_identify.markdown
c0ffeeca7 530204bb23
m-o integrations: apply sentence-style caps to categories (#29904)
* m-o integrations: apply sentence-style caps to categories

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Apply suggestions from code review

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>

* Apply suggestions from code review

Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>

---------

Co-authored-by: Joakim Sørensen <joasoe@gmail.com>
Co-authored-by: Joost Lekkerkerker <joostlek@outlook.com>
2023-11-19 13:58:07 +01:00

1.9 KiB

title, description, ha_category, ha_iot_class, ha_release, ha_domain, ha_integration_type
title description ha_category ha_iot_class ha_release ha_domain ha_integration_type
Microsoft Face Identify Instructions on how to integrate Microsoft Face Identify into Home Assistant.
Image processing
Cloud Push 0.37 microsoft_face_identify integration

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

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

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

{% configuration %} group: description: Microsoft face group to detect person from it. required: true type: string confidence: description: The minimum of confidence in percent to process with Home Assistant. required: false type: integer default: 80 source: description: List of image sources. required: true type: list keys: entity_id: description: A camera entity id to get picture from. required: true type: string name: description: This parameter allows you to override the name of your image_processing entity. required: false type: string {% endconfiguration %}