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-14 21:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document start_conversation action for Assist satellite (#37219)

Browse Source
This commit is contained in:
Michael Hansen 2025-01-30 15:20:49 -06:00 committed by Franck Nijhof
parent 04160f98a1
commit b17504f851
No known key found for this signature in database
GPG Key ID: D62583BA8AB11CA3
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
source/_integrations/assist_satellite.markdown
View File

@ -43,3 +43,30 @@ target:
entity_id: assist_satellite.my_entity
media_id: ITEM_ID
```
### Action `assist_satellite.start_conversation`
The {% my developer_call_service service="assist_satellite.start_conversation" %} action first announces a message or media id on the satellite and then listens for one or more voice commands. The satellite's configured [pipeline](/voice_control/voice_remote_local_assistant/) must use a supported [conversation agent](/integrations/conversation), such as [OpenAI](/integrations/openai_conversation) or [Ollama](/integrations/ollama). The builtin Assist conversation agent does not support conversations yet.
If a message is to be announced, it will first be converted to a media id using the [text-to-speech](/integrations/tts) system of the satellite's configured [pipeline](/voice_control/voice_remote_local_assistant/).
The `extra_system_prompt` is passed to the [conversation agent](/integrations/conversation) of the satellite's configured [pipeline](/voice_control/voice_remote_local_assistant/). For large language models (LLMs) this will be appended to the prompt given to the model, allowing the LLM to understand the context of a response like "yes" or "no".
{% my developer_call_service badge service="assist_satellite.start_conversation" %}
Examples in YAML:
```yaml
action: assist_satellite.start_conversation
target:
entity_id: assist_satellite.my_entity
start_message: "You left the lights on in the living room. Turn them off?"
extra_system_prompt: "The user has left the lights on in the living room and is being asked if they'd like to turn them off."
```
```yaml
action: assist_satellite.start_conversation
target:
entity_id: assist_satellite.my_entity
start_media_id: ITEM_ID
```