Update TTSSettings docstrings with the corresponding class name(s)

This commit is contained in:
Mark Backman
2026-03-06 16:40:38 -05:00
parent d59c0ea6c1
commit 4ed3480e4b
25 changed files with 29 additions and 29 deletions

View File

@@ -74,7 +74,7 @@ def language_to_async_language(language: Language) -> Optional[str]:
@dataclass @dataclass
class AsyncAITTSSettings(TTSSettings): class AsyncAITTSSettings(TTSSettings):
"""Settings for Async AI TTS services.""" """Settings for AsyncAITTSService and AsyncAIHttpTTSService."""
pass pass

View File

@@ -123,7 +123,7 @@ def language_to_aws_language(language: Language) -> Optional[str]:
@dataclass @dataclass
class AWSPollyTTSSettings(TTSSettings): class AWSPollyTTSSettings(TTSSettings):
"""Settings for AWS Polly TTS service. """Settings for AWSPollyTTSService.
Parameters: Parameters:
engine: TTS engine to use ('standard', 'neural', etc.). engine: TTS engine to use ('standard', 'neural', etc.).

View File

@@ -68,7 +68,7 @@ def sample_rate_to_output_format(sample_rate: int) -> SpeechSynthesisOutputForma
@dataclass @dataclass
class AzureTTSSettings(TTSSettings): class AzureTTSSettings(TTSSettings):
"""Settings for Azure TTS services. """Settings for AzureTTSService and AzureHttpTTSService.
Parameters: Parameters:
emphasis: Emphasis level for speech ("strong", "moderate", "reduced"). emphasis: Emphasis level for speech ("strong", "moderate", "reduced").

View File

@@ -135,7 +135,7 @@ def _get_aligned_audio(buffer: bytes) -> tuple[bytes, bytes]:
@dataclass @dataclass
class CambTTSSettings(TTSSettings): class CambTTSSettings(TTSSettings):
"""Settings for Camb.ai TTS service. """Settings for CambTTSService.
Parameters: Parameters:
user_instructions: Custom instructions for mars-instruct model only. user_instructions: Custom instructions for mars-instruct model only.

View File

@@ -188,7 +188,7 @@ class CartesiaEmotion(str, Enum):
@dataclass @dataclass
class CartesiaTTSSettings(TTSSettings): class CartesiaTTSSettings(TTSSettings):
"""Settings for Cartesia TTS services. """Settings for CartesiaTTSService and CartesiaHttpTTSService.
Parameters: Parameters:
generation_config: Generation configuration for Sonic-3 models. Includes volume, generation_config: Generation configuration for Sonic-3 models. Includes volume,

View File

@@ -40,7 +40,7 @@ from pipecat.utils.tracing.service_decorators import traced_tts
@dataclass @dataclass
class DeepgramSageMakerTTSSettings(TTSSettings): class DeepgramSageMakerTTSSettings(TTSSettings):
"""Settings for Deepgram SageMaker TTS service.""" """Settings for DeepgramSageMakerTTSService."""
pass pass

View File

@@ -45,7 +45,7 @@ except ModuleNotFoundError as e:
@dataclass @dataclass
class DeepgramTTSSettings(TTSSettings): class DeepgramTTSSettings(TTSSettings):
"""Settings for Deepgram TTS service.""" """Settings for DeepgramTTSService and DeepgramHttpTTSService."""
pass pass

View File

@@ -187,7 +187,7 @@ class PronunciationDictionaryLocator(BaseModel):
@dataclass @dataclass
class ElevenLabsTTSSettings(TTSSettings): class ElevenLabsTTSSettings(TTSSettings):
"""Settings for the ElevenLabs WebSocket TTS service. """Settings for ElevenLabsTTSService.
Fields that appear in the WebSocket URL (``voice``, ``model``, Fields that appear in the WebSocket URL (``voice``, ``model``,
``language``) require a full reconnect when changed. Fields that ``language``) require a full reconnect when changed. Fields that
@@ -225,7 +225,7 @@ class ElevenLabsTTSSettings(TTSSettings):
@dataclass @dataclass
class ElevenLabsHttpTTSSettings(TTSSettings): class ElevenLabsHttpTTSSettings(TTSSettings):
"""Settings for the ElevenLabs HTTP TTS service. """Settings for ElevenLabsHttpTTSService.
Parameters: Parameters:
optimize_streaming_latency: Latency optimization level (0-4). optimize_streaming_latency: Latency optimization level (0-4).

View File

@@ -49,7 +49,7 @@ FishAudioOutputFormat = Literal["opus", "mp3", "pcm", "wav"]
@dataclass @dataclass
class FishAudioTTSSettings(TTSSettings): class FishAudioTTSSettings(TTSSettings):
"""Settings for Fish Audio TTS service. """Settings for FishAudioTTSService.
Parameters: Parameters:
latency: Latency mode ("normal" or "balanced"). Defaults to "normal". latency: Latency mode ("normal" or "balanced"). Defaults to "normal".

View File

@@ -39,7 +39,7 @@ SAMPLE_RATE = 48000
@dataclass @dataclass
class GradiumTTSSettings(TTSSettings): class GradiumTTSSettings(TTSSettings):
"""Settings for the Gradium TTS service.""" """Settings for GradiumTTSService."""
pass pass

View File

@@ -34,7 +34,7 @@ except ModuleNotFoundError as e:
@dataclass @dataclass
class GroqTTSSettings(TTSSettings): class GroqTTSSettings(TTSSettings):
"""Settings for the Groq TTS service. """Settings for GroqTTSService.
Parameters: Parameters:
speed: Speech speed multiplier. Defaults to 1.0. speed: Speech speed multiplier. Defaults to 1.0.

View File

@@ -50,7 +50,7 @@ DEFAULT_HEADERS = {
@dataclass @dataclass
class HumeTTSSettings(TTSSettings): class HumeTTSSettings(TTSSettings):
"""Settings for Hume TTS service. """Settings for HumeTTSService.
Parameters: Parameters:
description: Natural-language acting directions (up to 100 characters). description: Natural-language acting directions (up to 100 characters).

View File

@@ -68,7 +68,7 @@ from pipecat.utils.tracing.service_decorators import traced_tts
@dataclass @dataclass
class InworldTTSSettings(TTSSettings): class InworldTTSSettings(TTSSettings):
"""Settings for Inworld TTS services. """Settings for InworldTTSService and InworldHttpTTSService.
Parameters: Parameters:
speaking_rate: Speaking rate for speech synthesis. speaking_rate: Speaking rate for speech synthesis.

View File

@@ -89,7 +89,7 @@ def language_to_kokoro_language(language: Language) -> str:
@dataclass @dataclass
class KokoroTTSSettings(TTSSettings): class KokoroTTSSettings(TTSSettings):
"""Settings for the Kokoro TTS service.""" """Settings for KokoroTTSService."""
pass pass

View File

@@ -74,7 +74,7 @@ def language_to_lmnt_language(language: Language) -> Optional[str]:
@dataclass @dataclass
class LmntTTSSettings(TTSSettings): class LmntTTSSettings(TTSSettings):
"""Settings for LMNT TTS service.""" """Settings for LmntTTSService."""
pass pass

View File

@@ -87,7 +87,7 @@ def language_to_minimax_language(language: Language) -> Optional[str]:
@dataclass @dataclass
class MiniMaxTTSSettings(TTSSettings): class MiniMaxTTSSettings(TTSSettings):
"""Settings for MiniMax TTS service. """Settings for MiniMaxHttpTTSService.
Parameters: Parameters:
stream: Whether to use streaming mode. stream: Whether to use streaming mode.

View File

@@ -76,7 +76,7 @@ def language_to_neuphonic_lang_code(language: Language) -> Optional[str]:
@dataclass @dataclass
class NeuphonicTTSSettings(TTSSettings): class NeuphonicTTSSettings(TTSSettings):
"""Settings for Neuphonic TTS service. """Settings for NeuphonicTTSService and NeuphonicHttpTTSService.
Parameters: Parameters:
speed: Speech speed multiplier. Defaults to 1.0. speed: Speech speed multiplier. Defaults to 1.0.

View File

@@ -44,7 +44,7 @@ except ModuleNotFoundError as e:
@dataclass @dataclass
class NvidiaTTSSettings(TTSSettings): class NvidiaTTSSettings(TTSSettings):
"""Settings for NVIDIA Riva TTS service. """Settings for NvidiaTTSService.
Parameters: Parameters:
quality: Audio quality setting (0-100). quality: Audio quality setting (0-100).

View File

@@ -62,7 +62,7 @@ VALID_VOICES: Dict[str, ValidVoice] = {
@dataclass @dataclass
class OpenAITTSSettings(TTSSettings): class OpenAITTSSettings(TTSSettings):
"""Settings for OpenAI TTS service. """Settings for OpenAITTSService.
Parameters: Parameters:
instructions: Instructions to guide voice synthesis behavior. instructions: Instructions to guide voice synthesis behavior.

View File

@@ -33,7 +33,7 @@ except ModuleNotFoundError as e:
@dataclass @dataclass
class PiperTTSSettings(TTSSettings): class PiperTTSSettings(TTSSettings):
"""Settings for Piper TTS service.""" """Settings for PiperTTSService."""
pass pass
@@ -186,7 +186,7 @@ class PiperTTSService(TTSService):
# #
@dataclass @dataclass
class PiperHttpTTSSettings(TTSSettings): class PiperHttpTTSSettings(TTSSettings):
"""Settings for Piper HTTP TTS service.""" """Settings for PiperHttpTTSService."""
pass pass

View File

@@ -38,7 +38,7 @@ except ModuleNotFoundError as e:
@dataclass @dataclass
class ResembleAITTSSettings(TTSSettings): class ResembleAITTSSettings(TTSSettings):
"""Settings for Resemble AI TTS service.""" """Settings for ResembleAITTSService."""
pass pass

View File

@@ -73,7 +73,7 @@ def language_to_rime_language(language: Language) -> str:
@dataclass @dataclass
class RimeTTSSettings(TTSSettings): class RimeTTSSettings(TTSSettings):
"""Settings for Rime WS JSON and HTTP TTS services. """Settings for RimeTTSService and RimeHttpTTSService.
Parameters: Parameters:
segment: Text segmentation mode ("immediate", "bySentence", "never"). segment: Text segmentation mode ("immediate", "bySentence", "never").
@@ -106,7 +106,7 @@ class RimeTTSSettings(TTSSettings):
@dataclass @dataclass
class RimeNonJsonTTSSettings(TTSSettings): class RimeNonJsonTTSSettings(TTSSettings):
"""Settings for Rime non-JSON WS TTS service. """Settings for RimeNonJsonTTSService.
Parameters: Parameters:
segment: Text segmentation mode ("immediate", "bySentence", "never"). segment: Text segmentation mode ("immediate", "bySentence", "never").

View File

@@ -247,7 +247,7 @@ def language_to_sarvam_language(language: Language) -> Optional[str]:
@dataclass @dataclass
class SarvamHttpTTSSettings(TTSSettings): class SarvamHttpTTSSettings(TTSSettings):
"""Settings for Sarvam HTTP TTS service. """Settings for SarvamHttpTTSService.
Parameters: Parameters:
enable_preprocessing: Whether to enable text preprocessing. Defaults to False. enable_preprocessing: Whether to enable text preprocessing. Defaults to False.
@@ -273,7 +273,7 @@ class SarvamHttpTTSSettings(TTSSettings):
@dataclass @dataclass
class SarvamTTSSettings(SarvamHttpTTSSettings): class SarvamTTSSettings(SarvamHttpTTSSettings):
"""Settings for Sarvam WebSocket TTS service. """Settings for SarvamTTSService.
Extends :class:`SarvamHttpTTSSettings` with WebSocket-specific buffering parameters. Extends :class:`SarvamHttpTTSSettings` with WebSocket-specific buffering parameters.

View File

@@ -37,7 +37,7 @@ except ModuleNotFoundError as e:
@dataclass @dataclass
class SpeechmaticsTTSSettings(TTSSettings): class SpeechmaticsTTSSettings(TTSSettings):
"""Settings for Speechmatics TTS service. """Settings for SpeechmaticsTTSService.
Parameters: Parameters:
max_retries: Maximum number of retries for HTTP requests. max_retries: Maximum number of retries for HTTP requests.

View File

@@ -70,7 +70,7 @@ def language_to_xtts_language(language: Language) -> Optional[str]:
@dataclass @dataclass
class XTTSTTSSettings(TTSSettings): class XTTSTTSSettings(TTSSettings):
"""Settings for XTTS TTS service.""" """Settings for XTTSTTSService."""
pass pass