jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-03 09:38:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/developers/intent/index.markdown
Paulus Schoutsen 80814f25ca update docs for intents (#3046) 
* update docs for intents

* Fix alexa docs

* Fix api.ai reference
2017-07-23 23:17:13 -07:00

1.4 KiB
Raw Blame History

layout, title, description, date, sidebar, comments, sharing, footer
layout title description date sidebar comments sharing footer
page Intents Intents are helping Home Assistant to gather 2017-07-23 20:00 true false true true

An intent is a description of a user's intention. Intents are generated by user actions, like asking Amazon Echo to turn on a light.

Architectural overview of intents in Home Assistant

Intents are fired by components that receive them from external sources/services. Conversation, Alexa, API.ai and Snips are currently sourcing intents.

Any component can handle intents. This makes it very easy for developers to integrate with all voice assistants at once.

Intents are implemented using the homeassistant.helpers.intent.Intent class. It contains the following properties:

Name Type Description
hass Home Assistant The Home Assistant instance that fired the intent.
platform string The platform that fired the intent
intent_type string The type (name) of the intent
slots dictionary Contains the slot values keyed by slot name.
text_input string Optional. The raw text input that initiated the intent.

Description of the slots dictionary values.

Name Type Description
Value anything Value of the slot.