home-assistant.github.io/source/_components/image_processing.microsoft_face_detect.markdown
Pascal Vizeli 3af68990ad Add new platform microsoft_face_detect / add braking changes for 0.38 (#2004)
* Add new platform microsoft_face_detect / add braking changes

* add more infos
2017-02-11 18:00:15 +01:00

38 lines
1.5 KiB
Markdown

---
layout: page
title: "Microsoft Face detect"
description: "Instructions how to integrate microsoft face detect into Home Assistant."
date: 2017-01-25 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: microsoft.png
ha_category: Image Processing
featured: false
ha_release: 0.37
---
The `microsoft_face_detect` image processing platform lets you use [Microsoft Face identify](https://www.microsoft.com/cognitive-services/en-us/) API through Home Assistant. This platform allow you do detect face on camera and fire a event with attributes.
Please refer to the [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 [component](/components/image_processing/) page.
### {% linkable_title Configuration Home Assistant %}
```yaml
# Example configuration.yaml entry
image_processing:
- platform: microsoft_face_detect
source:
- entity_id: camera.door
```
Configuration variables:
- **group** (*Required*): Micrsoft face group to detect person from it.
- **confidence** (*Optional*): The minimum of confidence in percent to process with Home Assistant. Defaults to 80.
- **source** array (*Required*): List of image sources.
- **entity_id** (*Required*): A camera entity id to get picture from.
- **name** (*Optional*): This parameter allows you to override the name of your `image_processing` entity.
- **attributes** array (*Optional*): Default age,gender. Attributes for search on picture. Supported: age, gender, glasses