Skip to content

Commit 73840dd

Browse files
docs: update for pipecat PR #4232 (remove deprecated parameters)
- Removed `vad_events` and `should_interrupt` parameters from DeepgramSTTService - Removed `on_speech_started` and `on_utterance_end` event handlers from Deepgram docs - Removed deprecated `vad_events` note (feature fully removed) - Added **kwargs parameter to OpenAI Realtime docs for completeness These parameters and features were removed in pipecat PR #4232 as part of deprecation cleanup.
1 parent 6882bc2 commit 73840dd

2 files changed

Lines changed: 5 additions & 23 deletions

File tree

server/services/s2s/openai.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,10 @@ _Deprecated in v0.0.105. Use `settings=OpenAIRealtimeLLMService.Settings(session
126126
`"high"` provides more detail.
127127
</ParamField>
128128

129+
<ParamField path="**kwargs" type="Any">
130+
Additional arguments passed to parent LLMService.
131+
</ParamField>
132+
129133
### Settings
130134

131135
Runtime-configurable settings passed via the `settings` constructor argument using `OpenAIRealtimeLLMService.Settings(...)`. These can be updated mid-conversation with `LLMUpdateSettingsFrame`. See [Service Settings](/guides/fundamentals/service-settings) for details.

server/services/stt/deepgram.mdx

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -168,11 +168,6 @@ Before using `DeepgramSageMakerSTTService` or `DeepgramFluxSageMakerSTTService`,
168168
Additional Deepgram features to enable.
169169
</ParamField>
170170

171-
<ParamField path="should_interrupt" type="bool" default="True" deprecated>
172-
Whether to interrupt the bot when Deepgram VAD detects user speech.
173-
*Deprecated in v0.0.99. Will be removed along with `vad_events` support.*
174-
</ParamField>
175-
176171
<ParamField path="ttfs_p99_latency" type="float" default="DEEPGRAM_TTFS_P99">
177172
P99 latency from speech end to final transcript in seconds. Override for your
178173
deployment.
@@ -201,7 +196,6 @@ Runtime-configurable settings passed via the `settings` constructor argument usi
201196
| `search` | `str \| list` | `None` | Search terms to highlight. |
202197
| `smart_format` | `bool` | `False` | Apply smart formatting to transcripts. |
203198
| `utterance_end_ms` | `int` | `None` | Silence duration in ms before an utterance-end event. |
204-
| `vad_events` | `bool` | `False` | Enable Deepgram's built-in VAD events (deprecated). |
205199

206200
### Usage
207201

@@ -232,27 +226,11 @@ stt = DeepgramSTTService(
232226
### Notes
233227

234228
- **Finalize on VAD stop**: When the pipeline's VAD detects the user has stopped speaking, the service sends a [finalize](https://developers.deepgram.com/docs/finalize) request to Deepgram for faster final transcript delivery.
235-
- **Deprecated vad_events**: The `vad_events` setting is deprecated. Use Silero VAD instead.
236229
- **Multilingual support**: Deepgram Nova models support many languages. The default is `Language.EN` (English). Set `language="multi"` in settings to enable multilingual transcription, which will detect and transcribe multiple languages within the same audio stream.
237230

238231
### Event Handlers
239232

240-
Supports the standard [service connection events](/server/events/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`), plus:
241-
242-
| Event | Description |
243-
| ------------------- | ------------------------------------- |
244-
| `on_speech_started` | Speech detected in the audio stream |
245-
| `on_utterance_end` | End of utterance detected by Deepgram |
246-
247-
```python
248-
@stt.event_handler("on_speech_started")
249-
async def on_speech_started(service):
250-
print("User started speaking")
251-
252-
@stt.event_handler("on_utterance_end")
253-
async def on_utterance_end(service):
254-
print("Utterance ended")
255-
```
233+
Supports the standard [service connection events](/server/events/service-events) (`on_connected`, `on_disconnected`, `on_connection_error`).
256234

257235
## DeepgramFluxSTTService
258236

0 commit comments

Comments
 (0)