From cdfd10e807062c8077a206d1ad8b9841aadb05bf Mon Sep 17 00:00:00 2001 From: Michael Hansen Date: Fri, 28 Apr 2023 13:09:46 -0500 Subject: [PATCH] Clean up and small fixes for assist pipeline docs (#1761) --- docs/voice/pipelines/index.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/voice/pipelines/index.md b/docs/voice/pipelines/index.md index 43446890..8858841a 100644 --- a/docs/voice/pipelines/index.md +++ b/docs/voice/pipelines/index.md @@ -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
`language` - Language used for pipeline
`runner_data` - Extra WebSocket data:
  • `stt_binary_handler_id` is the prefix to send speech data over.
  • `timeout` is the max run time for the whole pipeline.
    • | +| `run-start` | Start of pipeline run | always | `pipeline` - ID of the pipeline
    `language` - Language used for pipeline
    `runner_data` - Extra WebSocket data: | | `run-finish` | End of pipeline run | always | | | `stt-start` | Start of speech to text | audio only | `engine`: STT engine used
    `metadata`: incoming audio metadata | `stt-finish` | End of speech to text | audio only | `stt_output` - Object with `text`, the detected text.