Merge pull request #495 from pipecat-ai/mb/improve-user-stop-timeout-example

Improve user stop timeout example

Author: markbackman

getting-started/quickstart.mdx

@@ -268,7 +268,7 @@ The context aggregator automatically collects user messages (after speech-to-tex
 When building web or mobile clients, you can use [Pipecat's client SDKs](/client/introduction) that communicate with your bot via the [RTVI (Real-Time Voice Interaction) protocol](/client/rtvi-standard). In our quickstart example, we initialize the RTVI processor to handle client-server messaging and events:
 
 ```python
-rtvi = RTVIProcessor(config=RTVIConfig(config=[]))
+rtvi = RTVIProcessor()
 ```
 
 See below for how we incorporate the RTVI processor into the pipeline.

guides/fundamentals/custom-frame-processor.mdx

@@ -34,6 +34,7 @@ class MetricsFrameLogger(FrameProcessor):
 This frame processor looks for `MetricsFrames`. When it sees one, it formats the data and logs it.
 
 It uses this `format_metrics` function:
+
 ```python
 def format_metrics(metrics, indent=0):
     lines = []
@@ -78,6 +79,7 @@ pipeline = Pipeline(
         metrics_frame_processor,  # Our custom FrameProcessor that pretty prints metrics frames
     ]
 )
+```
 
 With this positioning, the `MetricsFrameLogger` FrameProcessor will receive every MetericsFrame in the pipeline.
 

guides/fundamentals/user-input-muting.mdx

@@ -38,7 +38,11 @@ This prevents user speech from being processed during muted periods.
 Pipecat provides several built-in strategies for determining when to mute user input:
 
 <CardGroup cols={2}>
-  <Card title="FirstSpeechUserMuteStrategy" icon="microphone-slash" iconType="duotone">
+  <Card
+    title="FirstSpeechUserMuteStrategy"
+    icon="microphone-slash"
+    iconType="duotone"
+  >
     Mute only during the bot's first speech utterance. Useful for introductions
     when you want the bot to complete its greeting before the user can speak.
   </Card>
@@ -61,8 +65,9 @@ Pipecat provides several built-in strategies for determining when to mute user i
 </CardGroup>
 
 <Warning>
-  The `FirstSpeechUserMuteStrategy` and `MuteUntilFirstBotCompleteUserMuteStrategy` strategies should not
-  be used together as they handle the first bot speech differently.
+  The `FirstSpeechUserMuteStrategy` and
+  `MuteUntilFirstBotCompleteUserMuteStrategy` strategies should not be used
+  together as they handle the first bot speech differently.
 </Warning>
 
 ## Basic Implementation

guides/learn/context-management.mdx

@@ -68,7 +68,10 @@ user_aggregator, assistant_aggregator = LLMContextAggregatorPair(context)
 ```
 
 <Note>
-The context aggregator also supports configuring [user turn strategies](/server/utilities/user-turn-strategies) and [user mute strategies](/server/utilities/user-mute-strategies) via `LLMUserAggregatorParams`.
+  The context aggregator also supports configuring [user turn
+  strategies](/server/utilities/user-turn-strategies) and [user mute
+  strategies](/server/utilities/user-mute-strategies) via
+  `LLMUserAggregatorParams`.
 </Note>
 
 **About LLMContext:**

guides/learn/pipeline.mdx

@@ -160,8 +160,8 @@ Understanding data flow is crucial for building effective pipelines:
 4. `tts` converts text frames to `TTSAudioRawFrame`s, `AggregatedTextFrame`s, and `TTSTextFrame`s
 5. `transport.output()` creates `OutputAudioRawFrame`s and sends audio back to user
 
-* Note: An `LLMTextProcessor` can sit between the `llm` and `tts` to pre-aggregate `LLMTextFrame`s into `AggregatedTextFrame`s. This simply moves the aggregation step
-out of the TTS.
+- Note: An `LLMTextProcessor` can sit between the `llm` and `tts` to pre-aggregate `LLMTextFrame`s into `AggregatedTextFrame`s. This simply moves the aggregation step
+  out of the TTS.
 
 ### Frame Propagation
 

guides/learn/speech-input.mdx

@@ -10,11 +10,13 @@ A key to natural conversations is properly detecting when the user starts and st
 Pipecat uses [user turn strategies](/server/utilities/user-turn-strategies) to determine when user turns start and end. These strategies can use different techniques:
 
 **For detecting turn start:**
+
 - Voice Activity Detection (VAD): triggers when speech is detected
 - Transcription-based (fallback): triggers when transcription is received but VAD didn't detect speech
 - Minimum words: waits for a minimum number of spoken words before triggering
 
 **For detecting turn end:**
+
 - Transcription-based: analyzes transcription to determine when the user is done
 - Turn detection model: uses AI to understand if the user has finished their thought
 
@@ -90,7 +92,9 @@ While VAD detects speech vs. silence, it can't understand linguistic context. A
 2. **Turn End**: When the stop strategy determines the user is done, it emits `UserStoppedSpeakingFrame`
 
 <Note>
-VAD also emits its own frames (`VADUserStartedSpeakingFrame`, `VADUserStoppedSpeakingFrame`) which indicate raw speech/silence detection. These are inputs to the turn strategies, not the final turn decisions.
+  VAD also emits its own frames (`VADUserStartedSpeakingFrame`,
+  `VADUserStoppedSpeakingFrame`) which indicate raw speech/silence detection.
+  These are inputs to the turn strategies, not the final turn decisions.
 </Note>
 
 ### Detecting Turn End
@@ -141,6 +145,7 @@ When using Smart Turn, configure VAD with a low `stop_secs` (0.2) so the model c
 Interruptions stop the bot when the user starts speaking. This is controlled by the `enable_interruptions` parameter on start strategies (enabled by default).
 
 When a user turn starts with interruptions enabled:
+
 1. Bot immediately stops speaking
 2. Pending audio and text is cleared
 3. Pipeline ready for new user input
@@ -154,7 +159,8 @@ start_strategy = VADUserTurnStartStrategy(enable_interruptions=False)
 ```
 
 <Note>
-Keep interruptions enabled (default) for natural conversations. This enables users to interrupt the bot mid-sentence, just like human conversations.
+  Keep interruptions enabled (default) for natural conversations. This enables
+  users to interrupt the bot mid-sentence, just like human conversations.
 </Note>
 
 ## Best Practices

guides/learn/text-to-speech.mdx

@@ -181,7 +181,11 @@ For TTS-specific text preprocessing, you can provide custom text transforms that
 Text transforms are registered directly on the TTS service instance via the `add_text_transformer()` method or during initialization using the `text_transforms` parameter.
 
 <Note>
-  The intentions of text transforms are meant to be TTS-specific modifications that do not affect the underlying LLM text or context. That said, since the context aggregator attempts to base its context on what was actually spoken, for services that support word timestamps, like Cartesia, ElevenLabs, and Rime,these transforms will modify the context as they modify what is spoken.
+  The intentions of text transforms are meant to be TTS-specific modifications
+  that do not affect the underlying LLM text or context. That said, since the
+  context aggregator attempts to base its context on what was actually spoken,
+  for services that support word timestamps, like Cartesia, ElevenLabs, and
+  Rime,these transforms will modify the context as they modify what is spoken.
 </Note>
 
 ```python
@@ -227,7 +231,11 @@ tts.add_text_transformer(replace_acronyms, "*")  # Apply to all text
 
 ### Text Filters
 
-<Warning>Text filters are no longer the preferred method for text preprocessing and will be deprecated in future releases. Instead, you should use one of the methods described above.</Warning>
+<Warning>
+  Text filters are no longer the preferred method for text preprocessing and
+  will be deprecated in future releases. Instead, you should use one of the
+  methods described above.
+</Warning>
 
 Apply preprocessing to text before synthesis:
 

guides/learn/transports.mdx

@@ -131,7 +131,9 @@ params = TransportParams(
 </Note>
 
 <Tip>
-  For advanced turn detection (like Smart Turn), configure [User Turn Strategies](/server/utilities/user-turn-strategies) on the context aggregator instead of using the transport's turn_analyzer parameter.
+  For advanced turn detection (like Smart Turn), configure [User Turn
+  Strategies](/server/utilities/user-turn-strategies) on the context aggregator
+  instead of using the transport's turn_analyzer parameter.
 </Tip>
 
 <Card

server/pipeline/pipeline-params.mdx

@@ -30,10 +30,12 @@ task = PipelineTask(pipeline, params=params)
 
 <ParamField path="allow_interruptions" type="bool" default="False">
   <Warning>
-    DEPRECATED: This parameter is deprecated. Configure interruption behavior via [User Turn Strategies](/server/utilities/user-turn-strategies) instead. See the `enable_interruptions` parameter on start strategies.
+    DEPRECATED: This parameter is deprecated. Configure interruption behavior
+    via [User Turn Strategies](/server/utilities/user-turn-strategies) instead.
+    See the `enable_interruptions` parameter on start strategies.
   </Warning>
-  Whether to allow pipeline interruptions. When enabled, a user's speech will
-  immediately interrupt the bot's response.
+  Whether to allow pipeline interruptions. When enabled, a user's speech will immediately
+  interrupt the bot's response.
 </ParamField>
 
 <ParamField path="audio_in_sample_rate" type="int" default="16000">

server/pipeline/pipeline-task.mdx

@@ -80,19 +80,27 @@ await runner.run(task)
 </ParamField>
 
 <ParamField path="enable_tracing" type="bool" default="False">
-  Whether to enable OpenTelemetry tracing. See [The OpenTelemetry guide](/server/utilities/opentelemetry) for details.
+  Whether to enable OpenTelemetry tracing. See [The OpenTelemetry
+  guide](/server/utilities/opentelemetry) for details.
 </ParamField>
 
 <ParamField path="enable_turn_tracking" type="bool" default="False">
-  Whether to enable turn tracking. See [The OpenTelemetry guide](/server/utilities/opentelemetry) for details.
+  Whether to enable turn tracking. See [The OpenTelemetry
+  guide](/server/utilities/opentelemetry) for details.
 </ParamField>
 
 <ParamField path="conversation_id" type="Optional[str]" default="None">
-  Custom ID for the conversation. If not provided, a UUID will be generated. See [The OpenTelemetry guide](/server/utilities/opentelemetry) for details.
+  Custom ID for the conversation. If not provided, a UUID will be generated. See
+  [The OpenTelemetry guide](/server/utilities/opentelemetry) for details.
 </ParamField>
 
-<ParamField path="additional_span_attributes" type="Optional[dict]" default="None">
-  Any additional attributes to add to top-level OpenTelemetry conversation span. See [The OpenTelemetry guide](/server/utilities/opentelemetry) for details.
+<ParamField
+  path="additional_span_attributes"
+  type="Optional[dict]"
+  default="None"
+>
+  Any additional attributes to add to top-level OpenTelemetry conversation span.
+  See [The OpenTelemetry guide](/server/utilities/opentelemetry) for details.
 </ParamField>
 
 ## Methods