diff --git a/src/pipecat/services/asyncai/tts.py b/src/pipecat/services/asyncai/tts.py index 56a7d0e82..7bcc1fdb1 100644 --- a/src/pipecat/services/asyncai/tts.py +++ b/src/pipecat/services/asyncai/tts.py @@ -74,7 +74,7 @@ def language_to_async_language(language: Language) -> Optional[str]: @dataclass class AsyncAITTSSettings(TTSSettings): - """Settings for Async AI TTS services.""" + """Settings for AsyncAITTSService and AsyncAIHttpTTSService.""" pass diff --git a/src/pipecat/services/aws/tts.py b/src/pipecat/services/aws/tts.py index 285026bca..12eab245c 100644 --- a/src/pipecat/services/aws/tts.py +++ b/src/pipecat/services/aws/tts.py @@ -123,7 +123,7 @@ def language_to_aws_language(language: Language) -> Optional[str]: @dataclass class AWSPollyTTSSettings(TTSSettings): - """Settings for AWS Polly TTS service. + """Settings for AWSPollyTTSService. Parameters: engine: TTS engine to use ('standard', 'neural', etc.). diff --git a/src/pipecat/services/azure/tts.py b/src/pipecat/services/azure/tts.py index f710482e9..c2884b860 100644 --- a/src/pipecat/services/azure/tts.py +++ b/src/pipecat/services/azure/tts.py @@ -68,7 +68,7 @@ def sample_rate_to_output_format(sample_rate: int) -> SpeechSynthesisOutputForma @dataclass class AzureTTSSettings(TTSSettings): - """Settings for Azure TTS services. + """Settings for AzureTTSService and AzureHttpTTSService. Parameters: emphasis: Emphasis level for speech ("strong", "moderate", "reduced"). diff --git a/src/pipecat/services/camb/tts.py b/src/pipecat/services/camb/tts.py index b30726fda..12b33974e 100644 --- a/src/pipecat/services/camb/tts.py +++ b/src/pipecat/services/camb/tts.py @@ -135,7 +135,7 @@ def _get_aligned_audio(buffer: bytes) -> tuple[bytes, bytes]: @dataclass class CambTTSSettings(TTSSettings): - """Settings for Camb.ai TTS service. + """Settings for CambTTSService. Parameters: user_instructions: Custom instructions for mars-instruct model only. diff --git a/src/pipecat/services/cartesia/tts.py b/src/pipecat/services/cartesia/tts.py index 3f708d06f..e5135aacb 100644 --- a/src/pipecat/services/cartesia/tts.py +++ b/src/pipecat/services/cartesia/tts.py @@ -188,7 +188,7 @@ class CartesiaEmotion(str, Enum): @dataclass class CartesiaTTSSettings(TTSSettings): - """Settings for Cartesia TTS services. + """Settings for CartesiaTTSService and CartesiaHttpTTSService. Parameters: generation_config: Generation configuration for Sonic-3 models. Includes volume, diff --git a/src/pipecat/services/deepgram/sagemaker/tts.py b/src/pipecat/services/deepgram/sagemaker/tts.py index 9e8c30ad7..fa5b1cebd 100644 --- a/src/pipecat/services/deepgram/sagemaker/tts.py +++ b/src/pipecat/services/deepgram/sagemaker/tts.py @@ -40,7 +40,7 @@ from pipecat.utils.tracing.service_decorators import traced_tts @dataclass class DeepgramSageMakerTTSSettings(TTSSettings): - """Settings for Deepgram SageMaker TTS service.""" + """Settings for DeepgramSageMakerTTSService.""" pass diff --git a/src/pipecat/services/deepgram/tts.py b/src/pipecat/services/deepgram/tts.py index 6c8685bee..7749fc370 100644 --- a/src/pipecat/services/deepgram/tts.py +++ b/src/pipecat/services/deepgram/tts.py @@ -45,7 +45,7 @@ except ModuleNotFoundError as e: @dataclass class DeepgramTTSSettings(TTSSettings): - """Settings for Deepgram TTS service.""" + """Settings for DeepgramTTSService and DeepgramHttpTTSService.""" pass diff --git a/src/pipecat/services/elevenlabs/tts.py b/src/pipecat/services/elevenlabs/tts.py index de930d1f2..2d961258b 100644 --- a/src/pipecat/services/elevenlabs/tts.py +++ b/src/pipecat/services/elevenlabs/tts.py @@ -187,7 +187,7 @@ class PronunciationDictionaryLocator(BaseModel): @dataclass class ElevenLabsTTSSettings(TTSSettings): - """Settings for the ElevenLabs WebSocket TTS service. + """Settings for ElevenLabsTTSService. Fields that appear in the WebSocket URL (``voice``, ``model``, ``language``) require a full reconnect when changed. Fields that @@ -225,7 +225,7 @@ class ElevenLabsTTSSettings(TTSSettings): @dataclass class ElevenLabsHttpTTSSettings(TTSSettings): - """Settings for the ElevenLabs HTTP TTS service. + """Settings for ElevenLabsHttpTTSService. Parameters: optimize_streaming_latency: Latency optimization level (0-4). diff --git a/src/pipecat/services/fish/tts.py b/src/pipecat/services/fish/tts.py index 64c3bccd9..fce28c746 100644 --- a/src/pipecat/services/fish/tts.py +++ b/src/pipecat/services/fish/tts.py @@ -49,7 +49,7 @@ FishAudioOutputFormat = Literal["opus", "mp3", "pcm", "wav"] @dataclass class FishAudioTTSSettings(TTSSettings): - """Settings for Fish Audio TTS service. + """Settings for FishAudioTTSService. Parameters: latency: Latency mode ("normal" or "balanced"). Defaults to "normal". diff --git a/src/pipecat/services/gradium/tts.py b/src/pipecat/services/gradium/tts.py index 745a77f56..3dd663185 100644 --- a/src/pipecat/services/gradium/tts.py +++ b/src/pipecat/services/gradium/tts.py @@ -39,7 +39,7 @@ SAMPLE_RATE = 48000 @dataclass class GradiumTTSSettings(TTSSettings): - """Settings for the Gradium TTS service.""" + """Settings for GradiumTTSService.""" pass diff --git a/src/pipecat/services/groq/tts.py b/src/pipecat/services/groq/tts.py index 139816834..4e56312e5 100644 --- a/src/pipecat/services/groq/tts.py +++ b/src/pipecat/services/groq/tts.py @@ -34,7 +34,7 @@ except ModuleNotFoundError as e: @dataclass class GroqTTSSettings(TTSSettings): - """Settings for the Groq TTS service. + """Settings for GroqTTSService. Parameters: speed: Speech speed multiplier. Defaults to 1.0. diff --git a/src/pipecat/services/hume/tts.py b/src/pipecat/services/hume/tts.py index ff5eb7522..135806da7 100644 --- a/src/pipecat/services/hume/tts.py +++ b/src/pipecat/services/hume/tts.py @@ -50,7 +50,7 @@ DEFAULT_HEADERS = { @dataclass class HumeTTSSettings(TTSSettings): - """Settings for Hume TTS service. + """Settings for HumeTTSService. Parameters: description: Natural-language acting directions (up to 100 characters). diff --git a/src/pipecat/services/inworld/tts.py b/src/pipecat/services/inworld/tts.py index d602efb52..8c89b200f 100644 --- a/src/pipecat/services/inworld/tts.py +++ b/src/pipecat/services/inworld/tts.py @@ -68,7 +68,7 @@ from pipecat.utils.tracing.service_decorators import traced_tts @dataclass class InworldTTSSettings(TTSSettings): - """Settings for Inworld TTS services. + """Settings for InworldTTSService and InworldHttpTTSService. Parameters: speaking_rate: Speaking rate for speech synthesis. diff --git a/src/pipecat/services/kokoro/tts.py b/src/pipecat/services/kokoro/tts.py index e69ef7a67..bfc39daed 100644 --- a/src/pipecat/services/kokoro/tts.py +++ b/src/pipecat/services/kokoro/tts.py @@ -89,7 +89,7 @@ def language_to_kokoro_language(language: Language) -> str: @dataclass class KokoroTTSSettings(TTSSettings): - """Settings for the Kokoro TTS service.""" + """Settings for KokoroTTSService.""" pass diff --git a/src/pipecat/services/lmnt/tts.py b/src/pipecat/services/lmnt/tts.py index c8bfcaf55..e9362c4d8 100644 --- a/src/pipecat/services/lmnt/tts.py +++ b/src/pipecat/services/lmnt/tts.py @@ -74,7 +74,7 @@ def language_to_lmnt_language(language: Language) -> Optional[str]: @dataclass class LmntTTSSettings(TTSSettings): - """Settings for LMNT TTS service.""" + """Settings for LmntTTSService.""" pass diff --git a/src/pipecat/services/minimax/tts.py b/src/pipecat/services/minimax/tts.py index 33e0669e1..768e877b9 100644 --- a/src/pipecat/services/minimax/tts.py +++ b/src/pipecat/services/minimax/tts.py @@ -87,7 +87,7 @@ def language_to_minimax_language(language: Language) -> Optional[str]: @dataclass class MiniMaxTTSSettings(TTSSettings): - """Settings for MiniMax TTS service. + """Settings for MiniMaxHttpTTSService. Parameters: stream: Whether to use streaming mode. diff --git a/src/pipecat/services/neuphonic/tts.py b/src/pipecat/services/neuphonic/tts.py index c1916414e..202262355 100644 --- a/src/pipecat/services/neuphonic/tts.py +++ b/src/pipecat/services/neuphonic/tts.py @@ -76,7 +76,7 @@ def language_to_neuphonic_lang_code(language: Language) -> Optional[str]: @dataclass class NeuphonicTTSSettings(TTSSettings): - """Settings for Neuphonic TTS service. + """Settings for NeuphonicTTSService and NeuphonicHttpTTSService. Parameters: speed: Speech speed multiplier. Defaults to 1.0. diff --git a/src/pipecat/services/nvidia/tts.py b/src/pipecat/services/nvidia/tts.py index 7f7638f5f..fb701185c 100644 --- a/src/pipecat/services/nvidia/tts.py +++ b/src/pipecat/services/nvidia/tts.py @@ -44,7 +44,7 @@ except ModuleNotFoundError as e: @dataclass class NvidiaTTSSettings(TTSSettings): - """Settings for NVIDIA Riva TTS service. + """Settings for NvidiaTTSService. Parameters: quality: Audio quality setting (0-100). diff --git a/src/pipecat/services/openai/tts.py b/src/pipecat/services/openai/tts.py index a50129349..71c04c59f 100644 --- a/src/pipecat/services/openai/tts.py +++ b/src/pipecat/services/openai/tts.py @@ -62,7 +62,7 @@ VALID_VOICES: Dict[str, ValidVoice] = { @dataclass class OpenAITTSSettings(TTSSettings): - """Settings for OpenAI TTS service. + """Settings for OpenAITTSService. Parameters: instructions: Instructions to guide voice synthesis behavior. diff --git a/src/pipecat/services/piper/tts.py b/src/pipecat/services/piper/tts.py index f0343947b..337dcd00c 100644 --- a/src/pipecat/services/piper/tts.py +++ b/src/pipecat/services/piper/tts.py @@ -33,7 +33,7 @@ except ModuleNotFoundError as e: @dataclass class PiperTTSSettings(TTSSettings): - """Settings for Piper TTS service.""" + """Settings for PiperTTSService.""" pass @@ -186,7 +186,7 @@ class PiperTTSService(TTSService): # @dataclass class PiperHttpTTSSettings(TTSSettings): - """Settings for Piper HTTP TTS service.""" + """Settings for PiperHttpTTSService.""" pass diff --git a/src/pipecat/services/resembleai/tts.py b/src/pipecat/services/resembleai/tts.py index 45f8fc229..f0a93a182 100644 --- a/src/pipecat/services/resembleai/tts.py +++ b/src/pipecat/services/resembleai/tts.py @@ -38,7 +38,7 @@ except ModuleNotFoundError as e: @dataclass class ResembleAITTSSettings(TTSSettings): - """Settings for Resemble AI TTS service.""" + """Settings for ResembleAITTSService.""" pass diff --git a/src/pipecat/services/rime/tts.py b/src/pipecat/services/rime/tts.py index 27580504b..8a9186c59 100644 --- a/src/pipecat/services/rime/tts.py +++ b/src/pipecat/services/rime/tts.py @@ -73,7 +73,7 @@ def language_to_rime_language(language: Language) -> str: @dataclass class RimeTTSSettings(TTSSettings): - """Settings for Rime WS JSON and HTTP TTS services. + """Settings for RimeTTSService and RimeHttpTTSService. Parameters: segment: Text segmentation mode ("immediate", "bySentence", "never"). @@ -106,7 +106,7 @@ class RimeTTSSettings(TTSSettings): @dataclass class RimeNonJsonTTSSettings(TTSSettings): - """Settings for Rime non-JSON WS TTS service. + """Settings for RimeNonJsonTTSService. Parameters: segment: Text segmentation mode ("immediate", "bySentence", "never"). diff --git a/src/pipecat/services/sarvam/tts.py b/src/pipecat/services/sarvam/tts.py index 6bf38bb24..008c53be1 100644 --- a/src/pipecat/services/sarvam/tts.py +++ b/src/pipecat/services/sarvam/tts.py @@ -247,7 +247,7 @@ def language_to_sarvam_language(language: Language) -> Optional[str]: @dataclass class SarvamHttpTTSSettings(TTSSettings): - """Settings for Sarvam HTTP TTS service. + """Settings for SarvamHttpTTSService. Parameters: enable_preprocessing: Whether to enable text preprocessing. Defaults to False. @@ -273,7 +273,7 @@ class SarvamHttpTTSSettings(TTSSettings): @dataclass class SarvamTTSSettings(SarvamHttpTTSSettings): - """Settings for Sarvam WebSocket TTS service. + """Settings for SarvamTTSService. Extends :class:`SarvamHttpTTSSettings` with WebSocket-specific buffering parameters. diff --git a/src/pipecat/services/speechmatics/tts.py b/src/pipecat/services/speechmatics/tts.py index 22b47f3fc..a93d9c78a 100644 --- a/src/pipecat/services/speechmatics/tts.py +++ b/src/pipecat/services/speechmatics/tts.py @@ -37,7 +37,7 @@ except ModuleNotFoundError as e: @dataclass class SpeechmaticsTTSSettings(TTSSettings): - """Settings for Speechmatics TTS service. + """Settings for SpeechmaticsTTSService. Parameters: max_retries: Maximum number of retries for HTTP requests. diff --git a/src/pipecat/services/xtts/tts.py b/src/pipecat/services/xtts/tts.py index 539ddc88c..42f13887c 100644 --- a/src/pipecat/services/xtts/tts.py +++ b/src/pipecat/services/xtts/tts.py @@ -70,7 +70,7 @@ def language_to_xtts_language(language: Language) -> Optional[str]: @dataclass class XTTSTTSSettings(TTSSettings): - """Settings for XTTS TTS service.""" + """Settings for XTTSTTSService.""" pass