Intents

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:

NameTypeDescription
hassHome AssistantThe Home Assistant instance that fired the intent.
platformstringThe platform that fired the intent
intent_typestringThe type (name) of the intent
slotsdictionaryContains the slot values keyed by slot name.
text_inputstringOptional. The raw text input that initiated the intent.

Description of the slots dictionary values.

NameTypeDescription
ValueanythingValue of the slot.