Skip to content

Commit 07e8691

Browse files
github-actions[bot]markbackman
authored andcommitted
docs: update for pipecat PR #4228 - remove deprecated interruption params
Remove deprecated parameters that were deleted in pipecat PR #4228: - Remove allow_interruptions from PipelineParams and StartFrame - Remove interruption_strategies from StartFrame - Update Google STT note to remove STTMuteFilter reference These parameters were deprecated in v0.0.99 and have been replaced by user_turn_strategies and user_mute_strategies on LLMUserAggregator.
1 parent e9b7189 commit 07e8691

3 files changed

Lines changed: 1 addition & 25 deletions

File tree

api-reference/server/frames/system-frames.mdx

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,6 @@ The first frame pushed into a pipeline, initializing all processors. Every proce
1919
Output audio sample rate in Hz.
2020
</ParamField>
2121

22-
<ParamField path="allow_interruptions" type="bool" default="False">
23-
Whether user interruptions are allowed. Deprecated since 0.0.99: use
24-
interruption strategies instead.
25-
</ParamField>
26-
2722
<ParamField path="enable_metrics" type="bool" default="False">
2823
Enable performance metrics collection from processors.
2924
</ParamField>
@@ -36,14 +31,6 @@ The first frame pushed into a pipeline, initializing all processors. Every proce
3631
Enable usage metrics (token counts, API calls) from services.
3732
</ParamField>
3833

39-
<ParamField
40-
path="interruption_strategies"
41-
type="List[BaseInterruptionStrategy]"
42-
default="[]"
43-
>
44-
List of interruption strategies for the pipeline. Deprecated since 0.0.99.
45-
</ParamField>
46-
4734
<ParamField path="report_only_initial_ttfb" type="bool" default="False">
4835
When `True`, only report time-to-first-byte for the initial response rather
4936
than every response.

api-reference/server/pipeline/pipeline-params.mdx

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,6 @@ task = PipelineTask(pipeline, params=params)
2828

2929
## Available Parameters
3030

31-
<ParamField path="allow_interruptions" type="bool" default="True" deprecated>
32-
<Warning>
33-
DEPRECATED: This parameter is deprecated. Configure interruption behavior
34-
via [User Turn
35-
Strategies](/api-reference/server/utilities/turn-management/user-turn-strategies) instead.
36-
See the `enable_interruptions` parameter on start strategies.
37-
</Warning>
38-
Whether to allow pipeline interruptions. When enabled, a user's speech will
39-
immediately interrupt the bot's response.
40-
</ParamField>
41-
4231
<ParamField path="audio_in_sample_rate" type="int" default="16000">
4332
Input audio sample rate in Hz.
4433

api-reference/server/services/stt/google.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ await task.queue_frame(
195195
- **Streaming time limit**: Google Cloud STT has a 5-minute streaming limit per connection. The service automatically handles stream reconnection at 4 minutes to provide seamless transcription without interruption.
196196
- **Multi-language support**: Pass a list of `Language` values to `languages` for multi-language recognition. The first language is the primary language.
197197
- **Regional endpoints**: Use the `location` parameter to route requests through regional endpoints (e.g., `"us-central1"`, `"europe-west1"`) for data residency requirements. The default `"global"` endpoint works for most use cases.
198-
- **Stream abort on inactivity**: If no audio is sent for ~10 seconds (e.g., when audio frames are blocked by an `STTMuteFilter`), Google automatically closes the stream. The service recovers by automatically reconnecting.
198+
- **Stream abort on inactivity**: If no audio is sent for ~10 seconds (e.g., when audio frames are blocked), Google automatically closes the stream. The service recovers by automatically reconnecting.
199199
- **Authentication priority**: The service checks for credentials in this order: `credentials` (JSON string), `credentials_path` (file), then Application Default Credentials.
200200

201201
<Tip>

0 commit comments

Comments
 (0)