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-25 02:07:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document set_conversation_response script action (#31004)

Browse Source 
* Document `set_conversation_response` script action

* Update scripts.markdown

* Apply suggestions from code review

* close raw tag

* Add backticks

---------

Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Co-authored-by: c0ffeeca7 <k0ffeeka7@gmail.com>
This commit is contained in:
Erik Montnemery 2024-01-25 11:47:06 +01:00 committed by GitHub
parent b1b107e49f
commit 3728e81fe8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
source/_docs/scripts.markdown
View File

@ -914,6 +914,36 @@ script:
entity_id: light.ceiling
```
## Respond to a conversation
The `set_conversation_response` script action allows returning a custom response
when an automation is triggered by a conversation engine, for example a voice
assistant. The conversation response can be templated.
{% raw %}
```yaml
# Example of a templated conversation response resulting in "Testing 123"
- variables:
my_var: "123"
- set_conversation_response: "{{ 'Testing ' + my_var }}":
```
{% endraw %}
The response is handed to the conversation engine when the automation finishes. If
the `set_conversation_response` is executed multiple times, the most recent
response will be handed to the conversation engine. To clear the response, set it
to `None`:
```yaml
# Example of a clearing a conversation response
set_conversation_response: ~
```
If the automation was not triggered by a conversation engine, the response
will not be used by anything.
[Script integration]: /integrations/script/
[automations]: /docs/automation/action/
[Alexa/Amazon Echo]: /integrations/alexa/