Merge pull request #3446 from pipecat-ai/mb/add-3392-changelog

Add PR 3392 to changelog, linting cleanup

CHANGELOG.md

@@ -25,12 +25,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   evaluated in order until one evaluates to true.
 
   Available user turn start strategies:
+
   - VADUserTurnStartStrategy
   - TranscriptionUserTurnStartStrategy
   - MinWordsUserTurnStartStrategy
   - ExternalUserTurnStartStrategy
 
   Available user turn stop strategies:
+
   - TranscriptionUserTurnStopStrategy
   - TurnAnalyzerUserTurnStopStrategy
   - ExternalUserTurnStopStrategy
@@ -40,7 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - start: [VADUserTurnStartStrategy, TranscriptionUserTurnStartStrategy]
   - stop: [TranscriptionUserTurnStopStrategy]
 
-  urn strategies are configured when setting up `LLMContextAggregatorPair`.
+  Turn strategies are configured when setting up `LLMContextAggregatorPair`.
   For example:
 
   ```python
@@ -49,8 +51,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
       user_params=LLMUserAggregatorParams(
           user_turn_strategies=UserTurnStrategies(
               stop=[
-                    TurnAnalyzerUserTurnStopStrategy(
+                  TurnAnalyzerUserTurnStopStrategy(turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
-turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
                   )
               ],
           )
@@ -86,6 +87,7 @@ turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
   (PR [#3289](https://github.com/pipecat-ai/pipecat/pull/3289))
 
 - `LLMUserAggregator` now exposes the following events:
+
   - `on_user_turn_started`: triggered when a user turn starts
   - `on_user_turn_stopped`: triggered when a user turn ends
   - `on_user_turn_stop_timeout`: triggered when a user turn does not stop
@@ -106,10 +108,10 @@ turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
 
   Available user mute strategies:
 
-    * `FirstSpeechUserMuteStrategy`
+  - `FirstSpeechUserMuteStrategy`
-    * `MuteUntilFirstBotCompleteUserMuteStrategy`
+  - `MuteUntilFirstBotCompleteUserMuteStrategy`
-    * `AlwaysUserMuteStrategy`
+  - `AlwaysUserMuteStrategy`
-    * `FunctionCallUserMuteStrategy`
+  - `FunctionCallUserMuteStrategy`
 
   User mute strategies replace the legacy `STTMuteFilter` and provide a more
   flexible and composable approach to muting user input.
@@ -159,6 +161,7 @@ turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
   (PR [#3357](https://github.com/pipecat-ai/pipecat/pull/3357))
 
 - Added image support to `OpenAIRealtimeLLMService` via `InputImageRawFrame`:
+
   - New `start_video_paused` parameter to control initial video input state
   - New `video_frame_detail` parameter to set image processing quality
     ("auto",
@@ -188,6 +191,7 @@ turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
   (PR [#3374](https://github.com/pipecat-ai/pipecat/pull/3374))
 
 - `LLMAssistantAggregator` now exposes the following events:
+
   - `on_assistant_turn_started`: triggered when the assistant turn starts
   - `on_assistant_turn_stopped`: triggered when the assistant turn ends
   - `on_assistant_thought`: triggered when there's an assistant thought
@@ -202,13 +206,14 @@ turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
   register custom pipeline task setup files by setting the
   `PIPECAT_SETUP_FILES` environment variable. This variable should contain a
   colon-separated list of Python files (e.g. `export
-  PIPECAT_SETUP_FILES="setup1.py:setup.py:..."`). Each file must define a
+PIPECAT_SETUP_FILES="setup1.py:setup.py:..."`). Each file must define a
   function with the following signature:
 
   ```python
   async def setup_pipeline_task(task: PipelineTask):
       ...
   ```
+
   (PR [#3397](https://github.com/pipecat-ai/pipecat/pull/3397))
 
 - Added a keepalive task for `InworldTTSService` to keep the service connected
@@ -238,12 +243,14 @@ turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
 
 - Updated `ElevenLabsRealtimeSTTService` to accept the
   `include_language_detection` parameter to detect language.
+
   ```python
     stt = ElevenLabsRealtimeSTTService(
         api_key=os.getenv("ELEVENLABS_API_KEY"),
         include_language_detection=True
     )
   ```
+
   (PR [#3216](https://github.com/pipecat-ai/pipecat/pull/3216))
 
 - Updated `SpeechmaticsSTTService` to use new Python Voice SDK with improved
@@ -251,16 +258,18 @@ turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
   without any impact on accuracy. Use the `turn_detection_mode` parameter to control
   the endpointing of speech, with `TurnDetectionMode.EXTERNAL` (default),
   `TurnDetectionMode.ADAPTIVE`, or `TurnDetectionMode.SMART_TURN`.
+
   ```python
       stt = SpeechmaticsSTTService(
           api_key=os.getenv("SPEECHMATICS_API_KEY"),
           params=SpeechmaticsSTTService.InputParams(
               language=Language.EN,
-turn_detection_mode=SpeechmaticsSTTService.TurnDetectionMode.ADAPTIVE,
+              turn_detection_mode=SpeechmaticsSTTService.TurnDetectionMode.ADAPTIVE,
               speaker_active_format="<{speaker_id}>{text}</{speaker_id}>",
           ),
       )
   ```
+
   (PR [#3225](https://github.com/pipecat-ai/pipecat/pull/3225))
 
 - `daily-python` updated to 0.23.0.
@@ -278,6 +287,11 @@ turn_detection_mode=SpeechmaticsSTTService.TurnDetectionMode.ADAPTIVE,
   - Improved docstrings for `InworldTTSService` and `InworldHttpTTSService`.
     (PR [#3288](https://github.com/pipecat-ai/pipecat/pull/3288))
 
+- Improved the error handling and reconnection logic for `WebsocketServer` by
+  distinguishing between errors when disconnecting and websocket communication
+  errors.
+  (PR [#3392](https://github.com/pipecat-ai/pipecat/pull/3392))
+
 - Updated `DeepgramSTTService` to push user started/stopped speaking and
   interruption frames when `vad_enabled` is set to true. This centralizes the
   frames into the service, removing the need to have your application code
@@ -308,7 +322,8 @@ turn_detection_mode=SpeechmaticsSTTService.TurnDetectionMode.ADAPTIVE,
 - Smart Turn now takes into account `vad_start_seconds` when buffering audio,
   meaning that the start of the turn audio is not cut off. This improves
   accuracy for short utterances.
-    - The default value of `pre_speech_ms` is now set to 500ms for Smart Turn.
+
+- The default value of `pre_speech_ms` is now set to 500ms for Smart Turn.
   (PR [#3377](https://github.com/pipecat-ai/pipecat/pull/3377))
 
 - Improved Krisp SDK management to allow `KrispVivaTurn` and `KrispVivaFilter`
@@ -387,6 +402,7 @@ turn_detection_mode=SpeechmaticsSTTService.TurnDetectionMode.ADAPTIVE,
   context = LLMContext(messages, tools)
   context_aggregator = LLMContextAggregatorPair(context)
   ```
+
   (PR [#3263](https://github.com/pipecat-ai/pipecat/pull/3263))
 
 - `STTMuteFilter` is deprecated and will be removed in a future version. Use
@@ -406,11 +422,12 @@ turn_detection_mode=SpeechmaticsSTTService.TurnDetectionMode.ADAPTIVE,
       context,
       user_params=LLMUserAggregatorParams(
           user_turn_strategies=UserTurnStrategies(
-start=[TranscriptionUserTurnStartStrategy(enable_interruptions=False)],
+              start=[TranscriptionUserTurnStartStrategy(enable_interruptions=False)],
           ),
       ),
   )
   ```
+
   (PR [#3297](https://github.com/pipecat-ai/pipecat/pull/3297))
 
 - `TranscriptProcessor` and related data classes and frames
@@ -433,7 +450,8 @@ start=[TranscriptionUserTurnStartStrategy(enable_interruptions=False)],
 ### Fixed
 
 - Improved error handling in `ElevenLabsRealtimeSTTService`
-  - Fixed an issue in `ElevenLabsRealtimeSTTService` causing an infinite loop
+
+- Fixed an issue in `ElevenLabsRealtimeSTTService` causing an infinite loop
   that blocks the process if the websocket disconnects due to an error
   (PR [#3233](https://github.com/pipecat-ai/pipecat/pull/3233))
 
@@ -446,6 +464,7 @@ start=[TranscriptionUserTurnStartStrategy(enable_interruptions=False)],
   (PR [#3322](https://github.com/pipecat-ai/pipecat/pull/3322))
 
 - Updated `SpeechmaticsSTTService` for version `0.0.99+`:
+
   - Fixed `SpeechmaticsSTTService` to listen for `VADUserStoppedSpeakingFrame`
     in order to finalize transcription.
   - Default to `TurnDetectionMode.FIXED` for Pipecat-controlled end of turn