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-15 05:16:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update pipeline docs (#1757)

Browse Source
This commit is contained in:
Paulus Schoutsen 2023-04-26 21:34:27 -04:00 committed by GitHub
parent 94150fc27d
commit 4fb513e327
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/voice/pipelines/index.md
View File

@ -1,8 +1,8 @@
---
title: "Pipelines"
title: "Assist Pipelines"
---
A pipeline runs the common steps of a [voice assistant](https://next.home-assistant.io/integrations/voice_assistant):
The [Assist pipeline](https://next.home-assistant.io/integrations/assit_pipeline) integration runs the common steps of a voice assistant:
1. Speech to text
2. Intent recognition
@ -12,8 +12,13 @@ Pipelines are run via a WebSocket API:
```json
{
"type": "voice_assistant/run",
"language": "en-US"
"type": "assist_assistant/run",
"language": "en-US",
"start_stage": "stt",
"end_stage": "tts",
"input": {
"sample_rate": 16000,
}
}
```
@ -21,9 +26,9 @@ 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). |
| `start_stage` | enum | Required. The first stage to run. One of `stt`, `intent`, `tts`. |
| `end_stage` | enum | Required. The last stage to run. One of `stt`, `intent`, `tts`. |
| `input` | dict | Depends on `start_stage`. For STT, the dictionary should contain a key `sample_rate` with an integer value. For intent and TTS, the key `text` should contain the input text.
| `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). |
@ -34,10 +39,13 @@ 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-start` | Start of pipeline run | always | `pipeline` - Name of pipeline<br />`pipeline_id` - ID of the pipeline<br />`language` - Language used for pipeline<br />`runner_data` - Extra WebSocket data: <li>`stt_binary_handler_id` is the prefix to send speech data over.</li><li>`timeout` is the max run time for the whole pipeline.</li> |
| `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 |
| `stt-start` | Start of speech to text | audio only | `engine`: STT engine used<br />`metadata`: incoming audio metadata
| `stt-finish` | End of speech to text | audio only | `stt_output` - Object with `text`, the detected text.
| `intent-start` | Start of intent recognition | always | `engine` - [Agent](/docs/intent_conversation_api) engine used<br />`language`: Processing language. <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 |
| `tts-start` | Start of text to speech | audio only | `engine` - TTS engine used<br />`language`: Output language.<br />`voice`: Output voice. <br />`tts_input`: Text to speak. |
| `tts-finish` | End of text to speech | audio only | `media_id` - Media Source ID of the generated audio<br />`url` - URL to the generated audio<br />`mime_type` - MIME type of the generated audio<br /> |
| `error` | Error in pipeline | On error | `code` - Error code<br />`message` - Error message |