wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add settings as canonical init arg for all AIService descendants, deprecate redundant model/voice/params args

Browse Source 
ServiceSettings types were introduced for runtime updates via ServiceUpdateSettingsFrame, but there was tension between init-time and runtime APIs: overlapping-but-different InputParams vs ServiceSettings classes, and runtime-updatable fields like `model` and `voice` scattered as direct init args rather than living in a settings object. This unifies them so developers use the same settings type at both init and runtime, improving ergonomics and consistency.

Every concrete AIService subclass (LLM, TTS, STT, ImageGen, Vision, Video) now accepts a `settings` parameter for runtime-updatable config. Old init args (`model`, `voice_id`, `params`/`InputParams`) still work but emit DeprecationWarnings pointing to the new API. When both are provided, `settings` takes precedence. Leaf classes emit warnings; base classes do not, avoiding double warnings in inheritance chains.
This commit is contained in:
Paul Kompfner
2026-02-27 21:46:03 -05:00
committed by Mark Backman
parent 3199168d3e
commit 5dc312ce0c
84 changed files with 3431 additions and 1182 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
src/pipecat/services/lmnt/tts.py
View File

@@ -24,7 +24,7 @@ from pipecat.frames.frames import (
TTSStoppedFrame,
)
from pipecat.processors.frame_processor import FrameDirection
from pipecat.services.settings import NOT_GIVEN, TTSSettings, _NotGiven
from pipecat.services.settings import NOT_GIVEN, TTSSettings, _NotGiven, _warn_deprecated_param
from pipecat.services.tts_service import InterruptibleTTSService
from pipecat.transcriptions.language import Language, resolve_language
from pipecat.utils.tracing.service_decorators import traced_tts
@@ -98,10 +98,11 @@ class LmntTTSService(InterruptibleTTSService):
self,
*,
api_key: str,
voice_id: str,
voice_id: Optional[str] = None,
sample_rate: Optional[int] = None,
language: Language = Language.EN,
model: str = "blizzard",
model: Optional[str] = None,
settings: Optional[LmntTTSSettings] = None,
**kwargs,
):
"""Initialize the LMNT TTS service.
@@ -109,21 +110,40 @@ class LmntTTSService(InterruptibleTTSService):
Args:
api_key: LMNT API key for authentication.
voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0
Use ``settings=LmntTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate. If None, uses default.
language: Language for synthesis. Defaults to English.
model: TTS model to use. Defaults to "blizzard".
model: TTS model to use.
.. deprecated:: 1.0
Use ``settings=LmntTTSSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated
parameters, ``settings`` values take precedence.
**kwargs: Additional arguments passed to parent InterruptibleTTSService.
"""
if voice_id is not None:
_warn_deprecated_param("voice_id", "LmntTTSSettings", "voice")
if model is not None:
_warn_deprecated_param("model", "LmntTTSSettings", "model")
default_settings = LmntTTSSettings(
model=model or "blizzard",
voice=voice_id,
language=self.language_to_service_language(language),
format="raw",
)
if settings is not None:
default_settings.apply_update(settings)
super().__init__(
push_stop_frames=True,
pause_frame_processing=True,
sample_rate=sample_rate,
settings=LmntTTSSettings(
model=model,
voice=voice_id,
language=self.language_to_service_language(language),
format="raw",
),
settings=default_settings,
**kwargs,
)