From 45ec1f49253bf7b5c163bdf05d05fa237193b5c1 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Tue, 23 Apr 2024 08:13:47 +0200 Subject: [PATCH] Voice control: move related topics to meta data (#32421) --- source/voice_control/about_wake_word.markdown | 16 +++++++------ source/voice_control/aliases.markdown | 13 +++++----- source/voice_control/android.markdown | 13 +++++----- ...assist_create_open_ai_personality.markdown | 13 +++++----- .../assist_daily_summary.markdown | 19 ++++++++------- .../voice_control/builtin_sentences.markdown | 24 ++++++++++++------- 6 files changed, 56 insertions(+), 42 deletions(-) diff --git a/source/voice_control/about_wake_word.markdown b/source/voice_control/about_wake_word.markdown index 4a15afc9816..dc5a5a0961b 100644 --- a/source/voice_control/about_wake_word.markdown +++ b/source/voice_control/about_wake_word.markdown @@ -1,5 +1,14 @@ --- title: "About wake words" +related: +- docs: /voice_control/thirteen-usd-voice-remote/ + title: Create a $13 voice assistant +- docs: /voice_control/install_wake_word_add_on/ + title: Enable wake words +- docs: /voice_control/create_wake_word/ + title: Create your own wake words +- docs: /voice_control/voice_remote_cloud_assistant/) + title: Create a cloud assistant --- Wake words are special words or phrases that tell a voice assistant that a command is about to be spoken. The device then switches from passive to active listening. Examples are: *Hey Google*, *Hey Siri*, or *Alexa*. Home Assistant supports its own wake words, such as *Hey Nabu*. @@ -101,13 +110,6 @@ Right now, there are two easy options to get started with wake words: - Follow the guide to the [$13 voice assistant][13-tutorial]. This tutorial is using the tiny ATOM Echo, detecting wake words with openWakeWord. - Follow the guide to set up an [ESP32-S3-BOX-3 voice assistant](/voice_control/s3_box_voice_assistant/). This tutorial is using the bigger S3-BOX-3 device which features a display. It can detect wake words using openWakeWord. But it can also do on-device wake word detection using microWakeWord. -## Related topics - -- [Create a $13 voice assistant](/voice_control/thirteen-usd-voice-remote/) -- [Enable wake words](/voice_control/install_wake_word_add_on/) -- [Create your own wake words](/voice_control/create_wake_word/) -- [Create a cloud assistant](/voice_control/voice_remote_cloud_assistant/) - [13-tutorial]: /voice_control/thirteen-usd-voice-remote/ [openWakeWord]: https://github.com/dscripka/openWakeWord [own-wake-word]: /voice_control/create_wake_word/ diff --git a/source/voice_control/aliases.markdown b/source/voice_control/aliases.markdown index d564bf23869..7c74cb5804d 100644 --- a/source/voice_control/aliases.markdown +++ b/source/voice_control/aliases.markdown @@ -1,5 +1,12 @@ --- title: "Assist - entity, area, and floor aliases" +related: +- docs: /docs/organizing/areas/ + title: Areas +- docs: /docs/organizing/floors/ + title: Floors +- docs: /voice_control/custom_sentences/ + title: Assist - custom sentences --- Assist will use the names of your entities, areas and floors, as well as any aliases you've configured. The configured aliases are not only used by Assist, but can also be used by Google Assistant, if you have set that up. @@ -29,9 +36,3 @@ There are multliple ways to add an alias of an entity: 2. Next to the floor of interest, select the three-dot menu, then select **Edit floor**. 3. Select **Add alias** and enter the alias you want to use for that floor. 4. **Save** your changes. - -## Related topics - -- [Areas](/docs/organizing/areas/) -- [Floors](/docs/organizing/floors/) -- [Assist - custom sentences](/voice_control/custom_sentences/) diff --git a/source/voice_control/android.markdown b/source/voice_control/android.markdown index 5bf8e675397..667903f732a 100644 --- a/source/voice_control/android.markdown +++ b/source/voice_control/android.markdown @@ -1,5 +1,12 @@ --- title: "Assist on Android" +related: +- docs: /voice_control/voice_remote_expose_devices/ + title: Exposing devices to Assist +- docs: /voice_control/start_assist_from_dashboard/ + title: Starting Assist from your dashboard +- url: https://companion.home-assistant.io/docs/getting_started/ + title: Home Assistant Companion App --- ## Assist on Android phones @@ -134,9 +141,3 @@ Depending on your watch, you can assign Assist to a button so that you can start ![List of assistants](/images/assist/android_watch_7.png) 3. Now, use your key and speak a command. - -## Related topics - -- [Home Assistant Companion App](https://companion.home-assistant.io/docs/getting_started/) -- [Exposing devices to Assist](/voice_control/voice_remote_expose_devices/) -- [Starting Assist from your dashboard](/voice_control/start_assist_from_dashboard/) diff --git a/source/voice_control/assist_create_open_ai_personality.markdown b/source/voice_control/assist_create_open_ai_personality.markdown index 685e06f084b..f10b0bb5a6a 100644 --- a/source/voice_control/assist_create_open_ai_personality.markdown +++ b/source/voice_control/assist_create_open_ai_personality.markdown @@ -1,5 +1,12 @@ --- title: "Create a personality with OpenAI" +related: +- docs: /voice_control/voice_remote_cloud_assistant/ + title: Cloud assistant pipeline +- docs: /voice_control/voice_remote_local_assistant/ + title: Local assistant pipeline +- url: https://www.nabucasa.com + title: Home Assistant Cloud --- You can give your voice assistant personality by using OpenAI. This requires an OpenAI account. For what we do in this tutorial, the free trial option is sufficient. No need to leave your credit card information. @@ -36,9 +43,3 @@ Using OpenAI requires an OpenAI account. For this tutorial, the free trial optio - Leave the other settings unchanged and select **Create**. 4. You can repeat this with other OpenAI personalities. You can add as many OpenAI Conversation integrations as you would like. - To add a new personality, you need to create a new API key. Then, add a new OpenAI Conversation integration with that API key. - -## Related topics - -- [Home Assistant Cloud](https://www.nabucasa.com) -- [Cloud assistant pipeline](/voice_control/voice_remote_cloud_assistant/) -- [Local assistant pipeline](/voice_control/voice_remote_local_assistant/) diff --git a/source/voice_control/assist_daily_summary.markdown b/source/voice_control/assist_daily_summary.markdown index 6a11c203669..9c25e48469f 100644 --- a/source/voice_control/assist_daily_summary.markdown +++ b/source/voice_control/assist_daily_summary.markdown @@ -1,5 +1,16 @@ --- title: "Daily summary by Assist" +related: +- docs: /voice_control/voice_remote_local_assistant/ + title: Local assistant pipeline +- docs: /integrations/local_calendar/ + title: Local calendar +- docs: /integrations/telegram/#setup-example + title: Telegram notification +- docs: /voice_control/assist_create_open_ai_personality/ + title: Telegram notification +- url: https://www.nabucasa.com + title: Home Assistant Cloud --- In this tutorial, we are creating an automation that has Assist send you a daily summary. Assist will tell you about the weather and your calendar events today. It will also send you the summary to your messenger. @@ -84,11 +95,3 @@ We are using a blueprint (courtesy of [@allenporter]) that polls calendar events - You should now receive a notification from Assist in your messenger app. [@allenporter]: https://github.com/allenporter - -## Related topics - -- [Home Assistant Cloud](https://www.nabucasa.com) -- [Local assistant pipeline](/voice_control/voice_remote_local_assistant/) -- [Local calendar](/integrations/local_calendar/) -- [Telegram notification](/integrations/telegram/#setup-example) -- [Create a Mario personality](/voice_control/assist_create_open_ai_personality/) \ No newline at end of file diff --git a/source/voice_control/builtin_sentences.markdown b/source/voice_control/builtin_sentences.markdown index 695115b9fad..29dca680f35 100644 --- a/source/voice_control/builtin_sentences.markdown +++ b/source/voice_control/builtin_sentences.markdown @@ -1,5 +1,20 @@ --- title: "Assist - default sentences" +related: +- docs: /voice_control/aliases/ + title: Create aliases +- docs: /voice_control/custom_sentences/ + title: Create your own sentences +- docs: /voice_control/troubleshooting/ + title: Sentence troubleshooting +- url: https://github.com/home-assistant/intents/tree/main/sentences + title: Built-in sentence definitions +- url: https://github.com/home-assistant/intents/tree/main/responses + title: Built-in response definitions +- url: https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax/ + title: Template sentence syntax documentation +- url: https://github.com/home-assistant/intents/tree/main/sentences + title: Sentence test cases --- Home Assistant comes with [built-in sentences](https://github.com/home-assistant/intents/tree/main/sentences) contributed by the community for [dozens of languages](https://developers.home-assistant.io/docs/voice/intent-recognition/supported-languages). @@ -103,12 +118,3 @@ The list of supported sentences is constantly being updated for each language. T 3. View the [sentence definition](https://github.com/home-assistant/intents/tree/main/sentences) for your language. 4. View the [response definition](https://github.com/home-assistant/intents/tree/main/responses) -## Related topics - -- [Create aliases](/voice_control/aliases/) -- [Create your own sentences](/voice_control/custom_sentences/) -- [Built-in sentence definitions](https://github.com/home-assistant/intents/tree/main/sentences) -- [Built-in response definitions](https://github.com/home-assistant/intents/tree/main/responses) -- [Template sentence syntax documentation](https://developers.home-assistant.io/docs/voice/intent-recognition/template-sentence-syntax/) -- [Sentence test cases](https://github.com/home-assistant/intents/tree/main/sentences) -- [Sentence troubleshooting](/voice_control/troubleshooting/)