jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-24 17:56:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for pipeline WebSocket API (#1722)

Browse Source 
* Add docs for pipelines

* Minor changes

* Fix parameter

* Fix other parameter
This commit is contained in:
Michael Hansen 2023-03-20 22:59:32 -05:00 committed by GitHub
parent 6589dea2ae
commit 93139737ff
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
docs/voice/pipelines/index.md Normal file
View File

@ -0,0 +1,43 @@
---
title: "Pipelines"
---
A pipeline runs the common steps of a [voice assistant](https://next.home-assistant.io/integrations/voice_assistant):
1. Speech to text
2. Intent recognition
3. Text to speech
Pipelines are run via a WebSocket API:
```json
{
"type": "voice_assistant/run",
"language": "en-US"
}
```
The following input fields are available:
| Name | Type | Description |
|-------------------|--------|---------------------------------------------------------------------------------------------|
| `intent_input` | string | Required. Input text to process. |
| `language` | string | Optional. Language of pipeline to run (default: configured language in HA). |
| `pipeline` | string | Optional. Id of a pipeline to run (default: use first one that matches specified language). |
| `conversation_id` | string | Optional. [Unique id for conversation](/docs/intent_conversation_api#conversation-id). |
| `timeout` | number | Optional. Number of seconds before pipeline times out (default: 30). |
## Events
As the pipeline runs, it emits events back over the WebSocket connection.
The following events can be emitted:
| Name | Description | Emitted | Attributes |
|-----------------|-----------------------------|------------|---------------------------------------------------------------------------------------------------------|
| `run-start` | Start of pipeline run | always | `pipeline` - Id of pipeline<br />`language` - Language used for pipeline<br /> |
| `run-finish` | End of pipeline run | always | |
| `intent-start` | Start of intent recognition | always | `engine` - [Agent](/docs/intent_conversation_api) engine used<br />`intent_input` - Input text to agent |
| `intent-finish` | End of intent recognition | always | `intent_output` - [conversation response](/docs/intent_conversation_api#conversation-response) |
| `tts-start` | Start of text to speech | audio only | `tts_input` - text to speak |
| `tts-finish` | End of text to speech | audio only | `tts_otuput` - URL of spoken audio |

1
sidebars.js
View File

@ -248,6 +248,7 @@ module.exports = {
],
},
"voice/pipelines/index",
"voice/language-leaders",
"voice/contributing-your-voice",
],