jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-28 19:57:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add tutorial on daily summary by assist (#28364)

Browse Source 
* Add tutorial on daily summary by assist

- Move procedure on creating a voice assistant to separate section
  - this allows referencing it in other procedures
- reference blueprint on daily summary by allenporter
- remove OpenAI procedure from World's most private voice assistant task and add a reference instead

* Apply suggestions from code review
This commit is contained in:
c0ffeeca7 2023-08-08 08:31:25 +02:00 committed by GitHub
parent 010a9c7587
commit babaeea969
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 126 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_includes/asides/voice_navigation.html
View File

@ -18,6 +18,7 @@
<li>{% active_link /voice_control/builtin_sentences/ Built-in sentences %}</li>
<li>{% active_link /voice_control/custom_sentences/ Custom sentences %}</li>
<li>{% active_link /voice_control/using_tts_in_automation/ Using Piper TTS in automations %}</li>
<li>{% active_link /voice_control/assist_create_open_ai_personality/ Creating a personality with OpenAI %}</li>
<li>{% active_link /voice_control/start_assist_from_dashboard/ Starting Assist from your dashboard %}</li>
<li>{% active_link /voice_control/troubleshooting/ Troubleshooting Assist %}</li>
</ul>
@ -28,6 +29,7 @@
<ul class="divided sidebar-menu">
<li>{% active_link /voice_control/worlds-most-private-voice-assistant/ Tutorial: World's most private voice assistant %}</li>
<li>{% active_link /voice_control/thirteen-usd-voice-remote/ Tutorial: $13 voice remote %}</li>
<li>{% active_link /voice_control/assist_daily_summary/ Tutorial: Your daily summary by Assist %}</li>
</ul>
</div>
</section>

BIN
source/images/assist/blueprint_daily_summary_notification_01.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 121 KiB

BIN
source/images/assist/calendar_01.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 5.1 KiB

36
source/voice_control/assist_create_open_ai_personality.markdown Normal file
View File

@ -0,0 +1,36 @@
---
title: "Create a personality with OpenAI"
---
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.
## Prerequisites
This tutorial assumes you have a few things set up already:
- [Home Assistant Cloud](https://www.nabucasa.com) or a manually configured [Assist Pipeline](/integrations/assist_pipeline)
### Creating an OpenAI voice assistant personality
Using OpenAI requires an OpenAI account. For this tutorial, the free trial option is sufficient. No need to leave your credit card information.
1. [Set up an OpenAI account and install the OpenAI conversation](/integrations/openai_conversation/) integration.
2. Create a Mario personality.
- Once you installed the OpenAI Conversation integration, go to {% my integrations title="**Settings** > **Devices & Services**" %}. In the OpenAI Conversation integration, select **Configure**.
![Configure the OpenAI integration](/images/assist/assistant-openai-mario-config.png)
- In the **Prompt template** field, enter the following text:
`You are Super Mario from Mario Bros. Be funny.` and select **Submit**.
![Add prompt for Mario personality](/images/assist/assistant-openai-mario-02.png)
- Give your personality a name. Select the three-dots menu, select **Rename** and change the name to `OpenAI Mario`.
3. Create a Mario assistant:
- Under {% my voice_assistants title="**Settings** > **Voice assistants**" %}, select **Add assistant**.
- Give it a name, select a language, and under **Conversation agent**, select the Mario OpenAI Conversation integration.
![Add a new assistant](/images/assist/assistant-openai-mario-04.png)
- 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.

83
source/voice_control/assist_daily_summary.markdown Normal file
View File

@ -0,0 +1,83 @@
---
title: "Daily summary by Assist"
---
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.
We will be using OpenAI, which 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.
## Prerequisites
This tutorial assumes you have a few things set up already:
- [Home Assistant Cloud](https://www.nabucasa.com) or a manually configured [Assist Pipeline](/integrations/assist_pipeline)
This tutorial was done using the **Local calendar**, the **Meteorologisk institutt**, and the **Telegram** integrations. It has not been tested with other integrations of the notifications or calendar category.
### Adding a calendar
Skip this if you're already using a calendar.
1. Go to the [integrations page](/integrations/) and select the calendar **Calendar** filter.
2. Pick a calendar you like and install it as described in the documentation.
3. If you just want to follow along with this tutorial, install the [local calendar](/integrations/local_calendar/) integration.
- When prompted for a name, call it `Local calendar`.
- In the navigation bar on the left, you should now see a new entry for the calendar. Open it.
![Calendar](/images/assist/calendar_01.png)
- Add a few events for today and the next few days.
### Adding a weather integration
Skip this if you're already using a weather integration.
1. Go to the [integrations page](/integrations/) and select the **Weather** filter.
2. Pick a calendar you like and install it as described in the documentation.
3. If unsure, select **Meteorologisk institutt** and add the integration.
- When prompted, enter the latitude and longitude of your home.
- The coordinates allow the integration to show the weather forecast for your location.
### Connect Home Assistant to a messenger service
Skip this if you're already using a notification integration.
1. Go to the [integrations page](/integrations/) and select the **Notifications** filter.
2. Pick a messenger service you like and install it as described in the documentation.
3. If unsure, select **Telegram** and add the integration.
4. If you don't have it already, install Telegram on your phone.
5. To get started with Telegram on Home Assistant, follow the [set up instruction](/integrations/telegram/#setup-example) step by step.
- Make sure not to copy and paste the following values from the example. Enter the real values:
- `api_key`
- `allowed_chat_ids`
- `name`
- `chat_id`
- `service`
6. You now have a working **Notification** integration. Home Assistant can now send messages to you.
### Creating an OpenAI voice assistant personality
The OpenAI personality gives the messages a special touch.
Using OpenAI requires an OpenAI account. For this tutorial, the free trial option is sufficient. No need to leave your credit card information.
- [Create a Mario personality](/voice_control/assist_create_open_ai_personality/).
### Creating an automation from a blueprint
We are using a blueprint (courtesy of [@allenporter]) that polls calendar events and collects weather information. It then asks ChatGPT to summarize it and ships that response to your phone.
1. To import the blueprint, select the button below:
{% my blueprint_import badge blueprint_url="https://www.home-assistant.io/blueprints/blog/2023-07/notify_agent_agenda.yaml" %}
2. Select **Preview**, then select **Import blueprint**.
3. Select the blueprint **Conversation agent agenda notification** from the list.
4. Enter the values for each category.
![Add prompt for Mario personality](/images/assist/blueprint_daily_summary_notification_01.png)
- Under **Notify service name**, make sure not to leave the default but to use the one you set up previously. For example `notify.nina`.
- **Save** your changes.
- In the dialog, enter a name for your new automation. For example, `Daily summary by Mario`.
5. To view the automation, go to {% my automations title="**Settings** > **Automations & Scenes**" %}.
6. To test the automation, select the three dots on your automation, and select **Run**.
- You should now receive a notification from Assist in your messenger app.
[@allenporter]: https://github.com/allenporter

27
source/voice_control/worlds-most-private-voice-assistant.markdown
View File

@ -75,29 +75,12 @@ To reproduce this example, follow these steps:
Note: this procedure requires an OpenAI account. To just run the example, the free trial option is sufficient. No need to leave your credit card information.
1. [Set up an OpenAI account and install the OpenAI conversation](/integrations/openai_conversation/) integration.
2. Create a Mario personality.
- Once you installed the OpenAI Conversation integration, go to {% my integrations title="**Settings** > **Devices & Services**" %} and in OpenAI Conversation integration, the select **Configure**.
![Configure the OpenAI integration](/images/assist/assistant-openai-mario-config.png)
- In the **Prompt template** field, enter the following text:
`You are Super Mario from Mario Bros. Be funny.` and select **Submit**.
![Add prompt for Mario personality](/images/assist/assistant-openai-mario-02.png)
1. [Create a Mario personality](/voice_control/assist_create_open_ai_personality/).
2. In the **Voice over IP** integration, under **Configuration**, select the Mario assistant you just created.
- Give your personality a name. Select the three-dots menu, select **Rename** and change the name to `OpenAI Mario`.
3. Create a Mario assistant:
- Under {% my voice_assistants title="**Settings** > **Voice assistants**" %}, select **Add assistant**.
- Give it a name, select a language and under **Conversation agent**, select the Mario OpenAI Conversation integration.
![Add a new assistant](/images/assist/assistant-openai-mario-04.png)
- Leave the other settings unchanged and select **Create**.
4. In the **Voice over IP** integration, under **Configuration**, select the Mario assistant you just created.
![VoIP: select OpenAI](/images/assist/assistant-openai-mario-03.png)
5. That's it! Pick up your phone and ask Mario a question.
6. You can repeat this with other OpenAI personalities. You can add as many OpenAI Conversation integrations as you would like.
![VoIP: select OpenAI](/images/assist/assistant-openai-mario-03.png)
3. That's it! Pick up your phone and ask Mario a question.
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.
## Troubleshoot Grandstream