Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/home-assistant/intents
Intents to be used with Home Assistant
https://github.com/home-assistant/intents
hacktoberfest
Last synced: about 1 month ago
JSON representation
Intents to be used with Home Assistant
- Host: GitHub
- URL: https://github.com/home-assistant/intents
- Owner: home-assistant
- License: cc-by-4.0
- Created: 2022-12-10T01:34:19.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T20:48:33.000Z (7 months ago)
- Last Synced: 2024-04-14T01:16:22.563Z (7 months ago)
- Topics: hacktoberfest
- Language: Python
- Homepage: https://developers.home-assistant.io/docs/voice/overview/
- Size: 5.46 MB
- Stars: 411
- Watchers: 34
- Forks: 464
- Open Issues: 122
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Intents for Home Assistant
This repository contains training data for Home Assistant's local voice control.
- [Progress per language and intent](https://home-assistant.github.io/intents/)
- [How to contribute](https://developers.home-assistant.io/docs/voice/intent-recognition/contributing/)
- [Language leaders](https://developers.home-assistant.io/docs/voice/language-leaders/)
- [Supported intents](https://developers.home-assistant.io/docs/intent_builtin/)
- [Supported languages](https://developers.home-assistant.io/docs/voice/intent-recognition/supported-languages/)
Repository layout:
- [`languages.yaml`](languages.yaml)
- Supported languages and their language leader.
- [`intents.yaml`](intents.yaml)
- Supported intents
- `sentences/`
- Intent matching sentences in YAML files for `` with the name `_.yaml`.
- [File format](https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax/)
- `responses/`
- YAML files for `` with responses for intents.
- [File format](https://developers.home-assistant.io/docs/voice/intent-recognition/test-syntax/)
- `tests/`
- YAML files for `` with test sentences and corresponding intents.
- [File format](https://developers.home-assistant.io/docs/voice/intent-recognition/test-syntax/)
See the [documentation](docs/README.md) for more information.
# Development
Checkout the repository and get a development environment with `script/setup`. This will create a new virtual environment in the `venv` directory of the repository, and install all necessary requirements.
Before developing, always activate your virtual environment with `source venv/bin/activate`.
## Run tests
Validate that the data is correctly formatted:
```sh
python3 -m script.intentfest validate --language nl
```
Run the tests. This will parse the sentences and verifies them with the test sentences.
```sh
pytest tests --language nl -k fan_HassTurnOn
```
Leave off `--language` to test all languages. Leave off `-k` to test all files. Add `-n auto` to use test parallelization.
## Test parsing sentences
You can try parsing sentences for a specific language with:
```sh
python3 -m script.intentfest parse --language en --sentence 'turn on the lights in the kitchen'
```
This will print a line of JSON for each `--sentence`:
```json
{
"text": "turn on the lights in the kitchen",
"match": true,
"intent": "HassTurnOn",
"slots": {
"area": "kitchen",
"domain": "light"
}
}
```
## Test sampling sentences
You can sample the possible sentences for a specific language with:
```sh
python3 -m script.intentfest sample --language en -n 1
```
This will print a line of JSON for each possible sentence:
```sh
python3 -m script.intentfest sample --language en -n 1
{"intent": "HassTurnOff", "text": "turn off all the fan in the kitchen"}
{"intent": "HassTurnOn", "text": "turn on the light in the kitchen"}
{"intent": "HassCloseCover", "text": "close the bedroom lamp"}
{"intent": "HassClimateSetTemperature", "text": "set the temp to 0 degrees celsius"}
{"intent": "HassLightSet", "text": "set the bedroom lamp brightness to 0 percent"}
{"intent": "HassOpenCover", "text": "open the bedroom lamp"}
{"intent": "HassClimateGetTemperature", "text": "what's the temp "}
```
You can filter for specific intents by adding `--intents HassTurnOn HassTurnOff`.
Leave off `-n` to generate all possible sentences.
## Test sampling template
To quickly test a sentence template, use:
```sh
python3 -m script.intentfest sample_template
```
For example:
```sh
python3 -m script.intentfest sample_template 'open [the] door'
open the door
open door
```
You can add lists, ranges, and expansion rules as well:
```sh
python3 -m script.intentfest sample_template 'set color to and brightness to {brightness}' --values color red green --range brightness 1 2 --rule color '[the] {color}'
```
## Add new language
```sh
python3 -m script.intentfest add_language
```
`` should be something like `en` or `pl` according to [ISO 639](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
Language name should be the name of the language in its own language.