diff --git a/docs/voice/pipelines/index.md b/docs/voice/pipelines/index.md index cdd5fcb8..f3251900 100644 --- a/docs/voice/pipelines/index.md +++ b/docs/voice/pipelines/index.md @@ -37,17 +37,19 @@ The following input fields are available: 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 the pipeline
`language` - Language used for pipeline
`runner_data` - Extra WebSocket data: | -| `run-end` | End of pipeline run | always | | -| `stt-start` | Start of speech to text | audio only | `engine`: STT engine used
`metadata`: incoming audio metadata -| `stt-end` | 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
`language`: Processing language.
`intent_input` - Input text to agent | -| `intent-end` | End of intent recognition | always | `intent_output` - [conversation response](/docs/intent_conversation_api#conversation-response) | -| `tts-start` | Start of text to speech | audio only | `engine` - TTS engine used
`language`: Output language.
`voice`: Output voice.
`tts_input`: Text to speak. | -| `tts-end` | End of text to speech | audio only | `media_id` - Media Source ID of the generated audio
`url` - URL to the generated audio
`mime_type` - MIME type of the generated audio
| -| `error` | Error in pipeline | On error | `code` - Error code
`message` - Error message | +| 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: | +| `run-end` | End of pipeline run | always | | +| `stt-start` | Start of speech to text | audio only | `engine`: STT engine used
`metadata`: incoming audio metadata | +| `stt-vad-start` | Start of voice command | audio only | `timestamp`: milliseconds after the start of the audio stream | +| `stt-vad-end` | End of voice command | audio only | `timestamp`: milliseconds after the start of the audio stream | +| `stt-end` | 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
`language`: Processing language.
`intent_input` - Input text to agent | +| `intent-end` | End of intent recognition | always | `intent_output` - [conversation response](/docs/intent_conversation_api#conversation-response) | +| `tts-start` | Start of text to speech | audio only | `engine` - TTS engine used
`language`: Output language.
`voice`: Output voice.
`tts_input`: Text to speak. | +| `tts-end` | End of text to speech | audio only | `media_id` - Media Source ID of the generated audio
`url` - URL to the generated audio
`mime_type` - MIME type of the generated audio
| +| `error` | Error in pipeline | On error | `code` - Error code
`message` - Error message | ## Sending speech data