The Home Assistant Intent Language parser
Project description
HassIL
The Home Assistant Intent Language (HassIL) parser for intents.
Dependencies
- antlr4-python3-runtime
- PyYAML
- dataclasses-json
Installation
Run the script/setup script to automatically create a virtual environment and install the requirements.
Running
python3 -m hassil <yaml_file_or_directory> [<yaml_file_or_directory> ...]
Once loaded, you may type in a sentence and see what intent it matches. For example:
python3 -m hassil examples/en.yaml --areas 'living room'
what is the temperature in the living room
{'intent': 'HassClimateGetTemperature', 'area': 'living room', 'domain': 'climate'}
Make sure to provide area names with --areas. Device or entity names can be provided with --names.
python3 -m hassil examples/en.yaml --areas office --names trapdoor
open the trapdoor in the office
{'intent': 'HassOpenCover', 'name': 'trapdoor', 'area': 'office'}
Sampling Sentences
Sentences for each intent can be sampled from the intent YAML files:
python3 -m hassil.sample examples/en.yaml -n 1
{"intent": "HassTurnOn", "text": "turn on the entity"}
{"intent": "HassTurnOff", "text": "turn off the entity"}
{"intent": "HassOpenCover", "text": "open the entity in the area"}
{"intent": "HassCloseCover", "text": "close the entity in the area"}
{"intent": "HassLightsSet", "text": "set the entity color to red"}
{"intent": "HassClimateSetTemperature", "text": "set temperature to 0 degrees in the area"}
{"intent": "HassClimateGetTemperature", "text": "what is the temperature in the area"}
The --areas and --names arguments are the same from python3 -m hassil, but default to generic "area" and "entity" terms.
Exclude the -n argument to sample all possible sentences.
Sentence Templates
Parsed using a custom ANTLR grammar (see HassILGrammar.g4).
- Alternative words or phrases
(red | green | blue)turn(s | ed | ing)
- Optional words or phrases
[the][this | that]light[s]
- Slot Lists
{list_name}{list_name:slot_name}- Refers to a pre-defined list of values in YAML (
lists)
- Expansion Rules
<rule_name>- Refers to a pre-defined expansion rule in YAML (
expansion_rules)
YAML Format
language: "<language code>"
intents:
<intent name>:
data:
# List of sentences/slots/etc.
- sentences:
- "<sentence template>"
- "<sentence template>"
# Optional
slots:
# Fixed slots for the recognized intent
<name>: <value>
requires_context:
# Must be present in match context
<name>: # Any provided value is good
excludes_context:
# Must NOT be present in match context
<name>: <value or list>
# Optional lists of items that become alternatives in sentence templates
lists:
# Referenced as {list_name} or {list_name:slot_name}
<list name>:
values:
- "items"
- "in list"
- in: "text in"
out: <value for slot>
# Optional
context:
<name>: <value>
<range_name>
range:
type: "number"
from: 0
to: 100 # inclusive
# Optional rules that are expanded in sentence templates
expansion_rules:
# Referenced as <rule_name>
<rule_name>: "<sentence template>"
# Optional words that the intent recognizer can skip during recognition
skip_words:
- "<word>"
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file hassil-0.2.6.tar.gz.
File metadata
- Download URL: hassil-0.2.6.tar.gz
- Upload date:
- Size: 32.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 29bcc664b5be1eb1b899e39ad265538778e6b78de047197dc8df5ab16303c626 |
|
| MD5 | 543f5d3de8c8bf56748392a97d48355e |
|
| BLAKE2b-256 | 8218269c1026cd45b37af38d734eb16da73760f523768b6a8a3d2b13e29ea3ac |
