mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-04 17:26:50 +00:00

* 🔥 Removes octopress.js * 🔥 Removes use of root_url var * 🔥 Removes Octopress generator reference from feed * 🔥 Removes delicious support * 🔥 Removes support for Pinboard * 🔥 Removes support for Disqus * 🔥 Removes support for Google Plus * ↩️ Migrate custom after_footer to default template * ↩️ Migrate custom footer to default template * ↩️ Migrate custom header to default template * 🔥 Removes unused template files * 🚀 Places time to read directly in post template * 🚀 Removes unneeded capture from archive_post.html template * 🔥 🚀 Removes unused, but heaving sorting call in component page * 🚀 Merged javascripts into a single file * 🔥 Removes more uses of root_url * 🚀 Removal of unneeded captures from head * 🔥 🚀 Removal of expensive liquid HTML compressor * 🔥 Removes unneeded templates * 🚀 Replaces kramdown with GitHub's CommonMark 🚀 * 💄 Adds Prism code syntax highlighting * ✨ Adds support for redirect in Netlify * ↩️ 🔥 Let Netlify handle all developer doc redirects * ✏️ Fixes typo in redirects file: Netify -> Netlify * 🔥 Removes unused .themes folder * 🔥 Removes unused aside.html template * 🔥 Removes Disqus config leftover * 🔥 Removes rouge highlighter config * 🔥 Removes Octopress 🎉 * 💄 Adjust code block font size and adds soft wraps * 💄 Adds styling for inline code blocks * 💄 Improve styling of note/warning/info boxes + div support * 🔨 Rewrites all note/warning/info boxes
64 lines
1.9 KiB
Markdown
64 lines
1.9 KiB
Markdown
---
|
|
title: "Microsoft Face Detect"
|
|
description: "Instructions on how to integrate Microsoft Face Detect into Home Assistant."
|
|
logo: microsoft.png
|
|
ha_category:
|
|
- Image Processing
|
|
ha_release: 0.38
|
|
redirect_from:
|
|
- /components/image_processing.microsoft_face_detect/
|
|
---
|
|
|
|
The `microsoft_face_detect` image processing platform allows you to use the
|
|
[Microsoft Face Identify](https://www.microsoft.com/cognitive-services/en-us/)
|
|
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](/components/microsoft_face/) configuration on
|
|
how to setup the API key.
|
|
|
|
For using the result inside an automation rule,
|
|
take a look at the [Image Processing component](/components/image_processing/) page.
|
|
|
|
<div class='note'>
|
|
|
|
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.
|
|
|
|
</div>
|
|
|
|
### Configuration
|
|
|
|
```yaml
|
|
# 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 %}
|