Assist: adding assist_pipeline to config file (#27329)

* Assist: adding assist_pipeline to config file

For users who do not use the default configuration

- add info on how to add assist_pipeline
- add troubleshooting item

* fix markdown list numbering

* Tiny tweak

---------

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
c0ffeeca7 2023-05-09 01:34:48 +02:00 committed by GitHub
parent 638bbf5083
commit 618f94ae5b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 31 additions and 2 deletions

View File

@ -17,6 +17,12 @@ ha_platforms:
The Assist pipeline integration provides the foundation for the [Assist](/docs/assist/) voice assistant in Home Assistant.
There is no need to manually install this integration. The Assist pipeline integration is part of the default configuration and set up automatically if needed by other integrations.
For most users, there is no need to install this integration manually. The Assist pipeline integration is part of the default configuration and is set up automatically if needed by other integrations.
If you are not using the default integration, you need to add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
assist_pipeline:
```
For more information, refer to the procedure on [configuring a pipeline](/docs/assist/voice_remote_local_assistant/).

View File

@ -28,3 +28,18 @@ This section lists a few steps that may help you troubleshoot issues with Assist
* If the phrase does not work, try a variant. For example, if *Turn off the light* doesn't work, try: *Turn off the lights in the kitchen*.
* Check if your phrase is [supported](/docs/assist/builtin_sentences/).
* Make sure you are using the name of the area as it is defined in Home Assistant. If you have a room called *bathroom*, the phrase *Turning on the lights in the bath* wont work.
## I do not see any assistant
If under {% my voice_assistants title="**Settings** > **Voice assistants**" %} you do not see any assistants, you are not using the default configuration. The image below shows the **Assist** section.
![Open the pipeline debug dialog](/images/assist/assist-assistants-page.png)
If the **Assist** section is missing entirely, you need to add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
assist_pipeline:
```

View File

@ -28,8 +28,16 @@ For the quickest way to get your local Assist pipeline started, follow these ste
* **Piper** converts text into speech.
* **Wyoming** is the protocol they are both using to communicate.
1. Setup your assistant.
* Go to **Settings** > **Voice assistants** and select **Add assistant**.
* Go to {% my voice_assistants title="**Settings** > **Voice assistants**" %} and select **Add assistant**.
![Enter a name for your voice assistant](/images/assist/piper-whisper-install-05.png)
* **Troubleshooting**: If you do not see any assistants here, you are not using the default configuration. In this case, you need to add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
assist_pipeline:
```
* Enter a name. You can pick any name that is meaningful to you.
* Select the language that you want to speak.
* Under **Conversation agent**, select **Home Assistant**.

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB