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

Expand language field docstrings to clarify storage invariant.

Browse Source 
The union type reflects the input side; after construction and `_update_settings`, the stored value is always a service-specific string.
This commit is contained in:
Paul Kompfner
2026-02-17 14:57:38 -05:00
parent 7dc16b1d92
commit 1cec8d119d
1 changed files with 16 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/pipecat/services/settings.py
View File

@@ -296,9 +296,14 @@ class TTSSettings(ServiceSettings):
Parameters:
model: TTS model identifier.
voice: Voice identifier or name.
language: Language for speech synthesis. Accepts a ``Language`` enum
(converted to a service-specific string) or a raw string (stored
as-is).
language: Language for speech synthesis. The union type reflects the
*input* side: callers may pass a ``Language`` enum or a raw string.
However, the **stored** value is always a service-specific string
— ``TTSService._update_settings`` converts ``Language`` enums via
``language_to_service_language()`` before writing, and ``__init__``
methods do the same at construction time. Code that reads
``self._settings.language`` after initialisation can treat it as
``str``.
"""
voice: str | _NotGiven = field(default_factory=lambda: NOT_GIVEN)
@@ -313,9 +318,14 @@ class STTSettings(ServiceSettings):
Parameters:
model: STT model identifier.
language: Language for speech recognition. Accepts a ``Language`` enum
(converted to a service-specific string) or a raw string (stored
as-is).
language: Language for speech recognition. The union type reflects the
*input* side: callers may pass a ``Language`` enum or a raw string.
However, the **stored** value is always a service-specific string
— ``STTService._update_settings`` converts ``Language`` enums via
``language_to_service_language()`` before writing, and ``__init__``
methods do the same at construction time. Code that reads
``self._settings.language`` after initialisation can treat it as
``str``.
"""
language: Language | str | _NotGiven = field(default_factory=lambda: NOT_GIVEN)