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-06-03 16:56:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clean up and small fixes for assist pipeline docs (#1761)

Browse Source
This commit is contained in:
Michael Hansen 2023-04-28 13:09:46 -05:00 committed by GitHub
parent f83f534a27
commit cdfd10e807
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -12,8 +12,7 @@ Pipelines are run via a WebSocket API:
```json
{
"type": "assist_assistant/run",
"language": "en-US",
"type": "assist_pipeline/run",
"start_stage": "stt",
"end_stage": "tts",
"input": {
@ -29,6 +28,7 @@ The following input fields are available:
| `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.
| `pipeline` | string | Optional. ID of the pipeline (use `assist_pipeline/pipeline/list` to get names). |
| `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). |
@ -39,7 +39,7 @@ The following events can be emitted:
| Name | Description | Emitted | Attributes |
|-----------------|-----------------------------|------------|---------------------------------------------------------------------------------------------------------|
| `run-start` | Start of pipeline run | always | `pipeline` - 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-start` | Start of pipeline run | always | `pipeline` - ID of the pipeline<br />`language` - Language used for pipeline<br />`runner_data` - Extra WebSocket data: <ul><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></ul> |
| `run-finish` | End of pipeline run | always | |
| `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.