3a499af278
* Use the correct bear. An incredibly picky edit. I'm sorry. * Move scan_interval documentation from the facebox bage up to the main image_processing page, as it it useful to all image processing entities * Add explicit example for setting scan_interval * Be explicit about which components are being referred to * Add notes on microsoft face detect and microsoft face identify pages that scan_interval should be applied
2.0 KiB
| layout | title | description | date | sidebar | comments | sharing | footer | logo | ha_category | featured | ha_release |
|---|---|---|---|---|---|---|---|---|---|---|---|
| page | Microsoft Face Detect | Instructions on how to integrate Microsoft Face Detect into Home Assistant. | 2017-01-25 00:00 | true | false | true | true | microsoft.png | Image Processing | false | 0.38 |
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](/components/image_processing/) page.
{% linkable_title Configuration %}
# Example configuration.yaml entry
image_processing:
- platform: microsoft_face_detect
source:
- entity_id: camera.door
{% configuration %}
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
attributes:
description: "The image search attributes. Supported: age, gender, glasses."
required: false
type: list
default: "[age, gender]"
{% endconfiguration %}