assist: move related topics to meta data (#32425)

This commit is contained in:
c0ffeeca7 2024-04-23 09:59:35 +02:00 committed by GitHub
parent 17f39b267a
commit 3e7c04e1eb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 94 additions and 58 deletions

View File

@ -1,5 +1,16 @@
---
title: "Create your own wake word"
related:
- docs: /voice_control/thirteen-usd-voice-remote/
title: $13 voice assistant for Home Assistant
- docs: /voice_control/custom_sentences/
title: Installing the Samba add-on
- docs: /voice_control/about_wake_word/
title: About wake words
- url: https://colab.research.google.com/drive/1q1oe2zOyZp7UsB3jJiQ1IFn8z5YfjwEb?usp=sharing#scrollTo=1cbqBebHXjFD
title: Wake word training environment
- url: https://github.com/dscripka/openWakeWord
title: Wake word training environment
---
You can now create your own wake word to use with Home Assistant. The procedure below will guide you to train a model. The model is trained using voice clips generated by our local neural text-to-speech system [Piper](https://github.com/rhasspy/piper).
@ -93,11 +104,3 @@ Things you can try if the execution is very slow:
- Select the link to **Upgrade to Colab Pro**.
- Select your price plan and follow the instructions on screen.
![Connect to hosted runtime](/images/assist/wake_word_upgrade_to_colab.png)
## Related topics
- [$13 voice assistant for Home Assistant](/voice_control/thirteen-usd-voice-remote/)
- [Wake word training environment](https://colab.research.google.com/drive/1q1oe2zOyZp7UsB3jJiQ1IFn8z5YfjwEb?usp=sharing#scrollTo=1cbqBebHXjFD)
- [Installing the Samba add-on](/common-tasks/os/#configuring-access-to-files)
- [openWakeWord add-on](https://github.com/dscripka/openWakeWord)
- [About wake words](/voice_control/about_wake_word/)

View File

@ -1,5 +1,16 @@
---
title: "Assist - custom sentences"
related:
- docs: /voice_control/aliases/
title: Create aliases
- docs: /docs/scripts/#respond-to-a-conversation/
title: Conversation response script action
- docs: /docs/automation/trigger/#sentence-trigger
title: Sentence triggers
- docs: /docs/automation/trigger/#sentence-wildcards
title: Sentence wildcards
- url: https://developers.home-assistant.io/docs/intent_builtin/
title: View existing intents
---
You may add your own sentences to the intent recognizer by either extending an [existing intent](https://developers.home-assistant.io/docs/intent_builtin/) or creating a new one. You may also [customize responses](#customizing-responses) for existing intents.
@ -165,15 +176,7 @@ responses:
{% endraw %}
## Related topics
- [View existing intents](https://developers.home-assistant.io/docs/intent_builtin/)
- [Create aliases](/voice_control/aliases/)
- [Conversation response script action](/docs/scripts/#respond-to-a-conversation)
- [Sentence triggers](/docs/automation/trigger/#sentence-trigger)
- [Sentence wildcards](/docs/automation/trigger/#sentence-wildcards)
### Related devices and installation tutorials
## Related devices and installation tutorials
- [$13 voice assistant for Home Assistant](/voice_control/thirteen-usd-voice-remote/)
- [S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/)

View File

@ -1,5 +1,24 @@
---
title: Assist - Talking to Home Assistant
related:
- docs: /voice_control/android
title: Assist on Android
- docs: /voice_control/android/#assist-on-wear-os
title: Assist on Wear OS
- docs: /voice_control/apple
title: Siri and Assist shortcuts
- docs: /voice_control/start_assist_from_dashboard/
title: Assist dashboard button
- docs: /voice_control/thirteen-usd-voice-remote/
title: Build a 13$ voice remote using an ESPHome device
- docs: /voice_control/install_wake_word_add_on
title: Enable a wake word
- docs: /voice_control/create_wake_word/
title: Create your own wake words
- docs: /voice_control/builtin_sentences
title: Built-in sentences
- url: https://www.nabucasa.com/config/
title: Home Assistant Cloud
---
<img src='/images/assist/assist-logo.png' class='no-shadow' alt='Assist logo' style='width: 150px; float: right'>
@ -62,15 +81,3 @@ Use the [built-in sentences](/voice_control/builtin_sentences) to control entiti
Did Assist not understand your sentence? [Contribute them](https://developers.home-assistant.io/docs/voice/intent-recognition/).
_Assist was introduced in Home Assistant 2023.2._
## Related topics
- [Home Assistant Cloud](https://www.nabucasa.com/config/)
- [Assist on Android](/voice_control/android)
- [Assist on Wear OS](/voice_control/android/#assist-on-wear-os)
- [Siri and Assist shortcuts](/voice_control/apple)
- [Assist dashboard button](/voice_control/start_assist_from_dashboard/)
- [Build a 13$ voice remote using an ESPHome device](/voice_control/thirteen-usd-voice-remote/)
- [Enable a wake word](/voice_control/install_wake_word_add_on)
- [Create your own wake words](/voice_control/create_wake_word/)
- [Built-in sentences](/voice_control/builtin_sentences)

View File

@ -2,6 +2,23 @@
title: "Customize the S3-BOX-3"
product_name: ESP32-S3-BOX-3
device_name_entry: ESP32-S3-BOX-3
related:
- docs: /voice_control/voice_remote_cloud_assistant/
title: Home Assistant Cloud
- docs: /voice_control/voice_remote_local_assistant
title: Assist Pipeline
- docs: /voice_control/s3_box_voice_assistant/
title: ESP32-S3-BOX-3 voice assistant
- docs: /voice_control/troubleshooting/
title: General troubleshooting section for Assist
- docs: /voice_control/troubleshooting_the_s3_box/
title: Troubleshooting the ESP32-S3-BOX-3
- docs: /common-tasks/os/#configuring-access-to-files
title: Access to your configuration files
- url: https://github.com/jlpouffier/home-assistant-s3-box-community-illustrations/tree/main
title: Community image repository
- url: https://github.com/kahrendt/microWakeWord
title: microWakeWord
---
## Customize the S3-BOX-3 with your own illustrations
@ -222,16 +239,5 @@ You can change the on-device wake word (microWakeWord) that is used on your S3-B
7. Now, speak a command to test the new setting. For example, *Hey Jarvis, turn on the light*.
## Related topics
- [Community image repository](https://github.com/jlpouffier/home-assistant-s3-box-community-illustrations/tree/main)
- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/)
- [Assist Pipeline](/voice_control/voice_remote_local_assistant)
- [ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/)
- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
- [Troubleshooting the ESP32-S3-BOX-3](/voice_control/troubleshooting_the_s3_box/)
- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
- [microWakeWord](https://github.com/kahrendt/microWakeWord)
[microWakeWord]: https://github.com/kahrendt/microWakeWord
[Kevin Ahrendt]: https://www.kevinahrendt.com/

View File

@ -3,6 +3,17 @@ title: "ESP32-S3-BOX voice assistant"
product_name: ESP32-S3-BOX
device_name_entry: ESP32-S3-BOX
config_link: /voice_control/s3_box_voice_assistant/#to-delete-the-configuration-from-esphome
related:
- docs: /voice_control/troubleshooting/
title: General troubleshooting section for Assist
- docs: /voice_control/troubleshooting_the_s3_box/
title: Troubleshooting the ESP32-S3-BOX-3
- docs: /common-tasks/os/#configuring-access-to-files
title: Access to your configuration files
- docs: /voice_control/s3-box-customize/#customizing-on-device-wake-words-microwakeword
title: Customizing the S3-BOX with on-device wake words
- url: https://esphome.io/projects/index.html
title: ESPHome projects page
---
This tutorial will guide you to turn an ESP32-S3-BOX, ESP32-S3-BOX-3, or an ESP32-S3-BOX-Light into a Home Assistant voice assistant. Note, the term ESP32-S3-BOX is used to refer to any of the 3 product variants.
@ -84,11 +95,3 @@ Before you can use this device with Home Assistant, you need to install a bit of
- Disable **LCD Backlight**.
![Toggle to enable/disable wake word](/images/assist/s3-box-disable-screen.png)
## Related topics
- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
- [Troubleshooting the ESP32-S3-BOX-3](/voice_control/troubleshooting_the_s3_box/)
- [ESPHome projects page](https://esphome.io/projects/index.html)
- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
- [Customizing the S3-BOX with on-device wake words](/voice_control/s3-box-customize/#customizing-on-device-wake-words-microwakeword)

View File

@ -1,5 +1,14 @@
---
title: "Starting Assist from your dashboard"
related:
- docs: /voice_control/android/
title: Assist for Android
- docs: /voice_control/voice_remote_local_assistant/
title: Creating a local assistant
- docs: /voice_control/voice_remote_cloud_assistant/
title: Creating a Cloud assistant
- docs: /voice_control/voice_remote_expose_devices/
title: Exposing devices to Assist
---
If you are using Home Assistant in kiosk mode, for example if you have a tablet mounted on the wall, the Assist icon in the top right corner is not accessible. In this case, use a dashboard button to start Assist.

View File

@ -3,6 +3,21 @@ title: "$13 voice assistant for Home Assistant"
product_name: ATOM Echo
device_name_entry: M5Stack Atom Echo a61920
config_link: /voice_control/thirteen-usd-voice-remote/#to-delete-the-atom-echo-configuration-from-esphome
related:
- docs: /voice_control/install_wake_word_add_on/
title: Enable a wake word
- docs: /voice_control/create_wake_word/
title: Create your own wake words
- docs: /voice_control/voice_remote_cloud_assistant/
title: Creating a Cloud assistant
- docs: /voice_control/troubleshooting/
title: General troubleshooting section for Assist
- docs: /voice_control/voice_remote_local_assistant
title: Manually configured Assist pipeline
- docs: /voice_control/custom_sentences/
title: Using a sentence trigger
- docs: /common-tasks/os/#configuring-access-to-files
title: Access to your configuration files
---
This tutorial will guide you to turn an ATOM Echo into the
@ -76,13 +91,3 @@ Before you can use this device with Home Assistant, you need to install a bit of
Are things not working as expected?
- Checkout the [general troubleshooting section for Assist](/voice_control/troubleshooting/).
## Related topics
- [Enable a wake word](/voice_control/install_wake_word_add_on/)
- [Create your own wake words](/voice_control/create_wake_word/)
- [General troubleshooting section for Assist](/voice_control/troubleshooting/)
- [Access to your configuration files](/common-tasks/os/#configuring-access-to-files)
- [Using a sentence trigger](/voice_control/custom_sentences/)
- [Home Assistant Cloud](/voice_control/voice_remote_cloud_assistant/)
- [Manually configured Assist pipeline](/voice_control/voice_remote_local_assistant)