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

Update deprecation version to 0.0.105

Browse Source
This commit is contained in:
Mark Backman
2026-03-03 20:31:08 -05:00
parent d5b89242f5
commit 630d7bd7ab
66 changed files with 199 additions and 200 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
examples/foundational/07-interruptible.py
View File

@@ -21,7 +21,7 @@ from pipecat.processors.aggregators.llm_response_universal import (
) )
from pipecat.runner.types import RunnerArguments from pipecat.runner.types import RunnerArguments
from pipecat.runner.utils import create_transport from pipecat.runner.utils import create_transport
from pipecat.services.cartesia.tts import CartesiaTTSService from pipecat.services.cartesia.tts import CartesiaTTSService, CartesiaTTSSettings
from pipecat.services.deepgram.stt import DeepgramSTTService from pipecat.services.deepgram.stt import DeepgramSTTService
from pipecat.services.openai.llm import OpenAILLMService from pipecat.services.openai.llm import OpenAILLMService
from pipecat.services.tts_service import TextAggregationMode from pipecat.services.tts_service import TextAggregationMode
@@ -56,10 +56,9 @@ async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
tts = CartesiaTTSService( tts = CartesiaTTSService(
api_key=os.getenv("CARTESIA_API_KEY"), api_key=os.getenv("CARTESIA_API_KEY"),
voice_id="71a7ad14-091c-4e8e-a314-022ece01c121", # British Reading Lady settings=CartesiaTTSSettings(
# Alternatively, you can use TextAggregationMode.TOKEN to stream tokens instead of voice="71a7ad14-091c-4e8e-a314-022ece01c121", # British Reading Lady
# sentencesfor faster response times. ),
# text_aggregation_mode=TextAggregationMode.TOKEN,
) )
llm = OpenAILLMService( llm = OpenAILLMService(

16
src/pipecat/services/asyncai/tts.py
View File

@@ -110,7 +110,7 @@ class AsyncAITTSService(AudioContextTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Async TTS configuration. """Input parameters for Async TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``AsyncAITTSSettings`` directly via the ``settings`` parameter instead. Use ``AsyncAITTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -143,14 +143,14 @@ class AsyncAITTSService(AudioContextTTSService):
voice_id: UUID of the voice to use for synthesis. See docs for a full list: voice_id: UUID of the voice to use for synthesis. See docs for a full list:
https://docs.async.com/list-voices-16699698e0 https://docs.async.com/list-voices-16699698e0
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AsyncAITTSSettings(voice=...)`` instead. Use ``settings=AsyncAITTSSettings(voice=...)`` instead.
version: Async API version. version: Async API version.
url: WebSocket URL for Async TTS API. url: WebSocket URL for Async TTS API.
model: TTS model to use (e.g., "async_flash_v1.0"). model: TTS model to use (e.g., "async_flash_v1.0").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AsyncAITTSSettings(model=...)`` instead. Use ``settings=AsyncAITTSSettings(model=...)`` instead.
sample_rate: Audio sample rate. sample_rate: Audio sample rate.
@@ -158,7 +158,7 @@ class AsyncAITTSService(AudioContextTTSService):
container: Audio container format. container: Audio container format.
params: Additional input parameters for voice customization. params: Additional input parameters for voice customization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AsyncAITTSSettings(...)`` instead. Use ``settings=AsyncAITTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -508,7 +508,7 @@ class AsyncAIHttpTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Async API. """Input parameters for Async API.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``AsyncAITTSSettings`` directly via the ``settings`` parameter instead. Use ``AsyncAITTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -539,13 +539,13 @@ class AsyncAIHttpTTSService(TTSService):
api_key: Async API key. api_key: Async API key.
voice_id: ID of the voice to use for synthesis. voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AsyncAITTSSettings(voice=...)`` instead. Use ``settings=AsyncAITTSSettings(voice=...)`` instead.
aiohttp_session: An aiohttp session for making HTTP requests. aiohttp_session: An aiohttp session for making HTTP requests.
model: TTS model to use (e.g., "async_flash_v1.0"). model: TTS model to use (e.g., "async_flash_v1.0").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AsyncAITTSSettings(model=...)`` instead. Use ``settings=AsyncAITTSSettings(model=...)`` instead.
url: Base URL for Async API. url: Base URL for Async API.
@@ -555,7 +555,7 @@ class AsyncAIHttpTTSService(TTSService):
container: Audio container format. container: Audio container format.
params: Additional input parameters for voice customization. params: Additional input parameters for voice customization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AsyncAITTSSettings(...)`` instead. Use ``settings=AsyncAITTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

4
src/pipecat/services/aws/stt.py
View File

@@ -96,12 +96,12 @@ class AWSTranscribeSTTService(WebsocketSTTService):
region: AWS region for the service. region: AWS region for the service.
sample_rate: Audio sample rate in Hz. Must be 8000 or 16000. sample_rate: Audio sample rate in Hz. Must be 8000 or 16000.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AWSTranscribeSTTSettings(sample_rate=...)`` instead. Use ``settings=AWSTranscribeSTTSettings(sample_rate=...)`` instead.
language: Language for transcription. language: Language for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AWSTranscribeSTTSettings(language=...)`` instead. Use ``settings=AWSTranscribeSTTSettings(language=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

6
src/pipecat/services/aws/tts.py
View File

@@ -155,7 +155,7 @@ class AWSPollyTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for AWS Polly TTS configuration. """Input parameters for AWS Polly TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``AWSPollyTTSSettings`` directly via the ``settings`` parameter instead. Use ``AWSPollyTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -196,13 +196,13 @@ class AWSPollyTTSService(TTSService):
region: AWS region for Polly service. Defaults to 'us-east-1'. region: AWS region for Polly service. Defaults to 'us-east-1'.
voice_id: Voice ID to use for synthesis. Defaults to 'Joanna'. voice_id: Voice ID to use for synthesis. Defaults to 'Joanna'.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AWSPollyTTSSettings(voice=...)`` instead. Use ``settings=AWSPollyTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate. If None, uses service default. sample_rate: Audio sample rate. If None, uses service default.
params: Additional input parameters for voice customization. params: Additional input parameters for voice customization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AWSPollyTTSSettings(...)`` instead. Use ``settings=AWSPollyTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/azure/image.py
View File

@@ -59,7 +59,7 @@ class AzureImageGenServiceREST(ImageGenService):
endpoint: Azure OpenAI endpoint URL. endpoint: Azure OpenAI endpoint URL.
model: The image generation model to use. model: The image generation model to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AzureImageGenSettings(model=...)`` instead. Use ``settings=AzureImageGenSettings(model=...)`` instead.
aiohttp_session: Shared aiohttp session for HTTP requests. aiohttp_session: Shared aiohttp session for HTTP requests.

2
src/pipecat/services/azure/llm.py
View File

@@ -40,7 +40,7 @@ class AzureLLMService(OpenAILLMService):
endpoint: The Azure endpoint URL. endpoint: The Azure endpoint URL.
model: The model identifier to use. Defaults to "gpt-4o". model: The model identifier to use. Defaults to "gpt-4o".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
api_version: Azure API version. Defaults to "2024-09-01-preview". api_version: Azure API version. Defaults to "2024-09-01-preview".

2
src/pipecat/services/azure/stt.py
View File

@@ -94,7 +94,7 @@ class AzureSTTService(STTService):
region: Azure region for the Speech service (e.g., 'eastus'). region: Azure region for the Speech service (e.g., 'eastus').
language: Language for speech recognition. Defaults to English (US). language: Language for speech recognition. Defaults to English (US).
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AzureSTTSettings(language=...)`` instead. Use ``settings=AzureSTTSettings(language=...)`` instead.
sample_rate: Audio sample rate in Hz. If None, uses service default. sample_rate: Audio sample rate in Hz. If None, uses service default.

10
src/pipecat/services/azure/tts.py
View File

@@ -115,7 +115,7 @@ class AzureBaseTTSService:
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Azure TTS voice configuration. """Input parameters for Azure TTS voice configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AzureTTSSettings(...)`` instead. Use ``settings=AzureTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -271,13 +271,13 @@ class AzureTTSService(TTSService, AzureBaseTTSService):
region: Azure region identifier (e.g., "eastus", "westus2"). region: Azure region identifier (e.g., "eastus", "westus2").
voice: Voice name to use for synthesis. voice: Voice name to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AzureTTSSettings(voice=...)`` instead. Use ``settings=AzureTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate in Hz. If None, uses service default. sample_rate: Audio sample rate in Hz. If None, uses service default.
params: Voice and synthesis parameters configuration. params: Voice and synthesis parameters configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AzureTTSSettings(...)`` instead. Use ``settings=AzureTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -782,13 +782,13 @@ class AzureHttpTTSService(TTSService, AzureBaseTTSService):
region: Azure region identifier (e.g., "eastus", "westus2"). region: Azure region identifier (e.g., "eastus", "westus2").
voice: Voice name to use for synthesis. voice: Voice name to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AzureTTSSettings(voice=...)`` instead. Use ``settings=AzureTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate in Hz. If None, uses service default. sample_rate: Audio sample rate in Hz. If None, uses service default.
params: Voice and synthesis parameters configuration. params: Voice and synthesis parameters configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=AzureTTSSettings(...)`` instead. Use ``settings=AzureTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

8
src/pipecat/services/camb/tts.py
View File

@@ -175,7 +175,7 @@ class CambTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Camb.ai TTS configuration. """Input parameters for Camb.ai TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=CambTTSSettings(...)`` instead. Use ``settings=CambTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -210,12 +210,12 @@ class CambTTSService(TTSService):
api_key: Camb.ai API key for authentication. api_key: Camb.ai API key for authentication.
voice_id: Voice ID to use. voice_id: Voice ID to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=CambTTSSettings(voice=...)`` instead. Use ``settings=CambTTSSettings(voice=...)`` instead.
model: TTS model to use. Options: "mars-flash" (fast), "mars-pro" (high quality). model: TTS model to use. Options: "mars-flash" (fast), "mars-pro" (high quality).
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=CambTTSSettings(model=...)`` instead. Use ``settings=CambTTSSettings(model=...)`` instead.
timeout: Request timeout in seconds. Defaults to 60.0 (minimum recommended timeout: Request timeout in seconds. Defaults to 60.0 (minimum recommended
@@ -223,7 +223,7 @@ class CambTTSService(TTSService):
sample_rate: Audio sample rate in Hz. If None, uses model-specific default. sample_rate: Audio sample rate in Hz. If None, uses model-specific default.
params: Additional voice parameters. If None, uses defaults. params: Additional voice parameters. If None, uses defaults.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=CambTTSSettings(...)`` instead. Use ``settings=CambTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/cerebras/llm.py
View File

@@ -39,7 +39,7 @@ class CerebrasLLMService(OpenAILLMService):
base_url: The base URL for Cerebras API. Defaults to "https://api.cerebras.ai/v1". base_url: The base URL for Cerebras API. Defaults to "https://api.cerebras.ai/v1".
model: The model identifier to use. Defaults to "gpt-oss-120b". model: The model identifier to use. Defaults to "gpt-oss-120b".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

6
src/pipecat/services/deepgram/flux/stt.py
View File

@@ -124,7 +124,7 @@ class DeepgramFluxSTTService(WebsocketSTTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Deepgram Flux API. """Configuration parameters for Deepgram Flux API.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=DeepgramFluxSTTSettings(...)`` instead. Use ``settings=DeepgramFluxSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -173,14 +173,14 @@ class DeepgramFluxSTTService(WebsocketSTTService):
sample_rate: Audio sample rate in Hz. If None, uses the rate from params or 16000. sample_rate: Audio sample rate in Hz. If None, uses the rate from params or 16000.
model: Deepgram Flux model to use for transcription. model: Deepgram Flux model to use for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=DeepgramFluxSTTSettings(model=...)`` instead. Use ``settings=DeepgramFluxSTTSettings(model=...)`` instead.
flux_encoding: Audio encoding format required by Flux API. Must be "linear16". flux_encoding: Audio encoding format required by Flux API. Must be "linear16".
Raw signed little-endian 16-bit PCM encoding. Raw signed little-endian 16-bit PCM encoding.
params: InputParams instance containing detailed API configuration options. params: InputParams instance containing detailed API configuration options.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=DeepgramFluxSTTSettings(...)`` instead. Use ``settings=DeepgramFluxSTTSettings(...)`` instead.
should_interrupt: Determine whether the bot should be interrupted when Flux detects that the user is speaking. should_interrupt: Determine whether the bot should be interrupted when Flux detects that the user is speaking.

2
src/pipecat/services/deepgram/sagemaker/tts.py
View File

@@ -92,7 +92,7 @@ class DeepgramSageMakerTTSService(TTSService):
region: AWS region where the endpoint is deployed (e.g., "us-east-2"). region: AWS region where the endpoint is deployed (e.g., "us-east-2").
voice: Voice model to use for synthesis. Defaults to "aura-2-helena-en". voice: Voice model to use for synthesis. Defaults to "aura-2-helena-en".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=DeepgramSageMakerTTSSettings(voice=...)`` instead. Use ``settings=DeepgramSageMakerTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate in Hz. If None, uses the value from StartFrame. sample_rate: Audio sample rate in Hz. If None, uses the value from StartFrame.

4
src/pipecat/services/deepgram/tts.py
View File

@@ -85,7 +85,7 @@ class DeepgramTTSService(WebsocketTTSService):
api_key: Deepgram API key for authentication. api_key: Deepgram API key for authentication.
voice: Voice model to use for synthesis. voice: Voice model to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=DeepgramTTSSettings(voice=...)`` instead. Use ``settings=DeepgramTTSSettings(voice=...)`` instead.
base_url: WebSocket base URL for Deepgram API. Defaults to "wss://api.deepgram.com". base_url: WebSocket base URL for Deepgram API. Defaults to "wss://api.deepgram.com".
@@ -409,7 +409,7 @@ class DeepgramHttpTTSService(TTSService):
api_key: Deepgram API key for authentication. api_key: Deepgram API key for authentication.
voice: Voice model to use for synthesis. voice: Voice model to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=DeepgramTTSSettings(voice=...)`` instead. Use ``settings=DeepgramTTSSettings(voice=...)`` instead.
aiohttp_session: Shared aiohttp session for HTTP requests with connection pooling. aiohttp_session: Shared aiohttp session for HTTP requests with connection pooling.

2
src/pipecat/services/deepseek/llm.py
View File

@@ -39,7 +39,7 @@ class DeepSeekLLMService(OpenAILLMService):
base_url: The base URL for DeepSeek API. Defaults to "https://api.deepseek.com/v1". base_url: The base URL for DeepSeek API. Defaults to "https://api.deepseek.com/v1".
model: The model identifier to use. Defaults to "deepseek-chat". model: The model identifier to use. Defaults to "deepseek-chat".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

12
src/pipecat/services/elevenlabs/stt.py
View File

@@ -228,7 +228,7 @@ class ElevenLabsSTTService(SegmentedSTTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for ElevenLabs STT API. """Configuration parameters for ElevenLabs STT API.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsSTTSettings(...)`` instead. Use ``settings=ElevenLabsSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -260,13 +260,13 @@ class ElevenLabsSTTService(SegmentedSTTService):
base_url: Base URL for ElevenLabs API. base_url: Base URL for ElevenLabs API.
model: Model ID for transcription. model: Model ID for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsSTTSettings(model=...)`` instead. Use ``settings=ElevenLabsSTTSettings(model=...)`` instead.
sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate. sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate.
params: Configuration parameters for the STT service. params: Configuration parameters for the STT service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsSTTSettings(...)`` instead. Use ``settings=ElevenLabsSTTSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -461,7 +461,7 @@ class ElevenLabsRealtimeSTTService(WebsocketSTTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for ElevenLabs Realtime STT API. """Configuration parameters for ElevenLabs Realtime STT API.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsRealtimeSTTSettings(...)`` instead. Use ``settings=ElevenLabsRealtimeSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -509,13 +509,13 @@ class ElevenLabsRealtimeSTTService(WebsocketSTTService):
base_url: Base URL for ElevenLabs WebSocket API. base_url: Base URL for ElevenLabs WebSocket API.
model: Model ID for transcription. model: Model ID for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsRealtimeSTTSettings(model=...)`` instead. Use ``settings=ElevenLabsRealtimeSTTSettings(model=...)`` instead.
sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate. sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate.
params: Configuration parameters for the STT service. params: Configuration parameters for the STT service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsRealtimeSTTSettings(...)`` instead. Use ``settings=ElevenLabsRealtimeSTTSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

16
src/pipecat/services/elevenlabs/tts.py
View File

@@ -331,7 +331,7 @@ class ElevenLabsTTSService(AudioContextTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for ElevenLabs TTS configuration. """Input parameters for ElevenLabs TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsTTSSettings(...)`` instead. Use ``settings=ElevenLabsTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -381,12 +381,12 @@ class ElevenLabsTTSService(AudioContextTTSService):
api_key: ElevenLabs API key for authentication. api_key: ElevenLabs API key for authentication.
voice_id: ID of the voice to use for synthesis. voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsTTSSettings(voice=...)`` instead. Use ``settings=ElevenLabsTTSSettings(voice=...)`` instead.
model: TTS model to use (e.g., "eleven_turbo_v2_5"). model: TTS model to use (e.g., "eleven_turbo_v2_5").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsTTSSettings(model=...)`` instead. Use ``settings=ElevenLabsTTSSettings(model=...)`` instead.
url: WebSocket URL for ElevenLabs TTS API. url: WebSocket URL for ElevenLabs TTS API.
@@ -395,7 +395,7 @@ class ElevenLabsTTSService(AudioContextTTSService):
locators to use. locators to use.
params: Additional input parameters for voice customization. params: Additional input parameters for voice customization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsTTSSettings(...)`` instead. Use ``settings=ElevenLabsTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -921,7 +921,7 @@ class ElevenLabsHttpTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for ElevenLabs HTTP TTS configuration. """Input parameters for ElevenLabs HTTP TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsHttpTTSSettings(...)`` instead. Use ``settings=ElevenLabsHttpTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -968,13 +968,13 @@ class ElevenLabsHttpTTSService(TTSService):
api_key: ElevenLabs API key for authentication. api_key: ElevenLabs API key for authentication.
voice_id: ID of the voice to use for synthesis. voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsHttpTTSSettings(voice=...)`` instead. Use ``settings=ElevenLabsHttpTTSSettings(voice=...)`` instead.
aiohttp_session: aiohttp ClientSession for HTTP requests. aiohttp_session: aiohttp ClientSession for HTTP requests.
model: TTS model to use (e.g., "eleven_turbo_v2_5"). model: TTS model to use (e.g., "eleven_turbo_v2_5").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsHttpTTSSettings(model=...)`` instead. Use ``settings=ElevenLabsHttpTTSSettings(model=...)`` instead.
base_url: Base URL for ElevenLabs HTTP API. base_url: Base URL for ElevenLabs HTTP API.
@@ -983,7 +983,7 @@ class ElevenLabsHttpTTSService(TTSService):
locators to use. locators to use.
params: Additional input parameters for voice customization. params: Additional input parameters for voice customization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ElevenLabsHttpTTSSettings(...)`` instead. Use ``settings=ElevenLabsHttpTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/fal/image.py
View File

@@ -87,7 +87,7 @@ class FalImageGenService(ImageGenService):
aiohttp_session: HTTP client session for downloading generated images. aiohttp_session: HTTP client session for downloading generated images.
model: The Fal.ai model to use for generation. Defaults to "fal-ai/fast-sdxl". model: The Fal.ai model to use for generation. Defaults to "fal-ai/fast-sdxl".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=FalImageGenSettings(model=...)`` instead. Use ``settings=FalImageGenSettings(model=...)`` instead.
key: Optional API key for Fal.ai. If provided, sets FAL_KEY environment variable. key: Optional API key for Fal.ai. If provided, sets FAL_KEY environment variable.

4
src/pipecat/services/fal/stt.py
View File

@@ -176,7 +176,7 @@ class FalSTTService(SegmentedSTTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Fal's Wizper API. """Configuration parameters for Fal's Wizper API.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=FalSTTSettings(...)`` instead. Use ``settings=FalSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -208,7 +208,7 @@ class FalSTTService(SegmentedSTTService):
sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate. sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate.
params: Configuration parameters for the Wizper API. params: Configuration parameters for the Wizper API.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=FalSTTSettings(...)`` instead. Use ``settings=FalSTTSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/fireworks/llm.py
View File

@@ -38,7 +38,7 @@ class FireworksLLMService(OpenAILLMService):
api_key: The API key for accessing Fireworks AI. api_key: The API key for accessing Fireworks AI.
model: The model identifier to use. Defaults to "accounts/fireworks/models/firefunction-v2". model: The model identifier to use. Defaults to "accounts/fireworks/models/firefunction-v2".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
base_url: The base URL for Fireworks API. Defaults to "https://api.fireworks.ai/inference/v1". base_url: The base URL for Fireworks API. Defaults to "https://api.fireworks.ai/inference/v1".

8
src/pipecat/services/fish/tts.py
View File

@@ -95,7 +95,7 @@ class FishAudioTTSService(InterruptibleTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Fish Audio TTS configuration. """Input parameters for Fish Audio TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=FishAudioTTSSettings(...)`` instead. Use ``settings=FishAudioTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -131,7 +131,7 @@ class FishAudioTTSService(InterruptibleTTSService):
api_key: Fish Audio API key for authentication. api_key: Fish Audio API key for authentication.
reference_id: Reference ID of the voice model to use for synthesis. reference_id: Reference ID of the voice model to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=FishAudioTTSSettings(voice=...)`` instead. Use ``settings=FishAudioTTSSettings(voice=...)`` instead.
model: Deprecated. Reference ID of the voice model to use for synthesis. model: Deprecated. Reference ID of the voice model to use for synthesis.
@@ -142,14 +142,14 @@ class FishAudioTTSService(InterruptibleTTSService):
model_id: Specify which Fish Audio TTS model to use (e.g. "s1"). model_id: Specify which Fish Audio TTS model to use (e.g. "s1").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=FishAudioTTSSettings(model=...)`` instead. Use ``settings=FishAudioTTSSettings(model=...)`` instead.
output_format: Audio output format. Defaults to "pcm". output_format: Audio output format. Defaults to "pcm".
sample_rate: Audio sample rate. If None, uses default. sample_rate: Audio sample rate. If None, uses default.
params: Additional input parameters for voice customization. params: Additional input parameters for voice customization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=FishAudioTTSSettings(...)`` instead. Use ``settings=FishAudioTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

4
src/pipecat/services/gladia/stt.py
View File

@@ -272,12 +272,12 @@ class GladiaSTTService(WebsocketSTTService):
sample_rate: Audio sample rate in Hz. If None, uses service default. sample_rate: Audio sample rate in Hz. If None, uses service default.
model: Model to use for transcription. model: Model to use for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GladiaSTTSettings(model=...)`` instead. Use ``settings=GladiaSTTSettings(model=...)`` instead.
params: Additional configuration parameters for Gladia service. params: Additional configuration parameters for Gladia service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GladiaSTTSettings(...)`` instead. Use ``settings=GladiaSTTSettings(...)`` instead.
max_buffer_size: Maximum size of audio buffer in bytes. Defaults to 20MB. max_buffer_size: Maximum size of audio buffer in bytes. Defaults to 20MB.

2
src/pipecat/services/google/image.py
View File

@@ -82,7 +82,7 @@ class GoogleImageGenService(ImageGenService):
api_key: Google AI API key for authentication. api_key: Google AI API key for authentication.
params: Configuration parameters for image generation. params: Configuration parameters for image generation.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GoogleImageGenSettings(model=...)`` instead. Use ``settings=GoogleImageGenSettings(model=...)`` instead.
http_options: HTTP options for the client. http_options: HTTP options for the client.

2
src/pipecat/services/google/llm_openai.py
View File

@@ -66,7 +66,7 @@ class GoogleLLMOpenAIBetaService(OpenAILLMService):
base_url: Base URL for Google's OpenAI-compatible API. base_url: Base URL for Google's OpenAI-compatible API.
model: Google model name to use (e.g., "gemini-2.0-flash"). model: Google model name to use (e.g., "gemini-2.0-flash").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

4
src/pipecat/services/google/stt.py
View File

@@ -425,7 +425,7 @@ class GoogleSTTService(STTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Google Speech-to-Text. """Configuration parameters for Google Speech-to-Text.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GoogleSTTSettings(...)`` instead. Use ``settings=GoogleSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -500,7 +500,7 @@ class GoogleSTTService(STTService):
sample_rate: Audio sample rate in Hertz. sample_rate: Audio sample rate in Hertz.
params: Configuration parameters for the service. params: Configuration parameters for the service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GoogleSTTSettings(...)`` instead. Use ``settings=GoogleSTTSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

20
src/pipecat/services/google/tts.py
View File

@@ -566,7 +566,7 @@ class GoogleHttpTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Google HTTP TTS voice customization. """Input parameters for Google HTTP TTS voice customization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``GoogleHttpTTSSettings`` directly via the ``settings`` parameter instead. Use ``GoogleHttpTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -609,13 +609,13 @@ class GoogleHttpTTSService(TTSService):
location: Google Cloud location for regional endpoint (e.g., "us-central1"). location: Google Cloud location for regional endpoint (e.g., "us-central1").
voice_id: Google TTS voice identifier (e.g., "en-US-Standard-A"). voice_id: Google TTS voice identifier (e.g., "en-US-Standard-A").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GoogleHttpTTSSettings(voice=...)`` instead. Use ``settings=GoogleHttpTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate in Hz. If None, uses default. sample_rate: Audio sample rate in Hz. If None, uses default.
params: Voice customization parameters including pitch, rate, volume, etc. params: Voice customization parameters including pitch, rate, volume, etc.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GoogleHttpTTSSettings(...)`` instead. Use ``settings=GoogleHttpTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -1029,7 +1029,7 @@ class GoogleTTSService(GoogleBaseTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Google streaming TTS configuration. """Input parameters for Google streaming TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``GoogleStreamTTSSettings`` directly via the ``settings`` parameter instead. Use ``GoogleStreamTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -1061,14 +1061,14 @@ class GoogleTTSService(GoogleBaseTTSService):
location: Google Cloud location for regional endpoint (e.g., "us-central1"). location: Google Cloud location for regional endpoint (e.g., "us-central1").
voice_id: Google TTS voice identifier (e.g., "en-US-Chirp3-HD-Charon"). voice_id: Google TTS voice identifier (e.g., "en-US-Chirp3-HD-Charon").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GoogleStreamTTSSettings(voice=...)`` instead. Use ``settings=GoogleStreamTTSSettings(voice=...)`` instead.
voice_cloning_key: The voice cloning key for Chirp 3 custom voices. voice_cloning_key: The voice cloning key for Chirp 3 custom voices.
sample_rate: Audio sample rate in Hz. If None, uses default. sample_rate: Audio sample rate in Hz. If None, uses default.
params: Language configuration parameters. params: Language configuration parameters.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GoogleStreamTTSSettings(...)`` instead. Use ``settings=GoogleStreamTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -1242,7 +1242,7 @@ class GeminiTTSService(GoogleBaseTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Gemini TTS configuration. """Input parameters for Gemini TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``GeminiTTSSettings`` directly via the ``settings`` parameter instead. Use ``GeminiTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -1283,7 +1283,7 @@ class GeminiTTSService(GoogleBaseTTSService):
model: Gemini TTS model to use. Must be a TTS model like model: Gemini TTS model to use. Must be a TTS model like
"gemini-2.5-flash-tts" or "gemini-2.5-pro-tts". "gemini-2.5-flash-tts" or "gemini-2.5-pro-tts".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GeminiTTSSettings(model=...)`` instead. Use ``settings=GeminiTTSSettings(model=...)`` instead.
credentials: JSON string containing Google Cloud service account credentials. credentials: JSON string containing Google Cloud service account credentials.
@@ -1291,13 +1291,13 @@ class GeminiTTSService(GoogleBaseTTSService):
location: Google Cloud location for regional endpoint (e.g., "us-central1"). location: Google Cloud location for regional endpoint (e.g., "us-central1").
voice_id: Voice name from the available Gemini voices. voice_id: Voice name from the available Gemini voices.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GeminiTTSSettings(voice=...)`` instead. Use ``settings=GeminiTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate in Hz. If None, uses Google's default 24kHz. sample_rate: Audio sample rate in Hz. If None, uses Google's default 24kHz.
params: TTS configuration parameters. params: TTS configuration parameters.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GeminiTTSSettings(...)`` instead. Use ``settings=GeminiTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

4
src/pipecat/services/gradium/stt.py
View File

@@ -91,7 +91,7 @@ class GradiumSTTService(WebsocketSTTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Gradium STT API. """Configuration parameters for Gradium STT API.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GradiumSTTSettings(...)`` instead. Use ``settings=GradiumSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -125,7 +125,7 @@ class GradiumSTTService(WebsocketSTTService):
api_endpoint_base_url: WebSocket endpoint URL. Defaults to Gradium's streaming endpoint. api_endpoint_base_url: WebSocket endpoint URL. Defaults to Gradium's streaming endpoint.
params: Configuration parameters for language and delay settings. params: Configuration parameters for language and delay settings.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GradiumSTTSettings(...)`` instead. Use ``settings=GradiumSTTSettings(...)`` instead.
json_config: Optional JSON configuration string for additional model settings. json_config: Optional JSON configuration string for additional model settings.

8
src/pipecat/services/gradium/tts.py
View File

@@ -57,7 +57,7 @@ class GradiumTTSService(AudioContextTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Gradium TTS service. """Configuration parameters for Gradium TTS service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``GradiumTTSSettings`` directly via the ``settings`` parameter instead. Use ``GradiumTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -84,19 +84,19 @@ class GradiumTTSService(AudioContextTTSService):
api_key: Gradium API key for authentication. api_key: Gradium API key for authentication.
voice_id: the voice identifier. voice_id: the voice identifier.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GradiumTTSSettings(voice=...)`` instead. Use ``settings=GradiumTTSSettings(voice=...)`` instead.
url: Gradium websocket API endpoint. url: Gradium websocket API endpoint.
model: Model ID to use for synthesis. model: Model ID to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GradiumTTSSettings(model=...)`` instead. Use ``settings=GradiumTTSSettings(model=...)`` instead.
json_config: Optional JSON configuration string for additional model settings. json_config: Optional JSON configuration string for additional model settings.
params: Additional configuration parameters. params: Additional configuration parameters.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GradiumTTSSettings(...)`` instead. Use ``settings=GradiumTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/grok/llm.py
View File

@@ -95,7 +95,7 @@ class GrokLLMService(OpenAILLMService):
base_url: The base URL for Grok API. Defaults to "https://api.x.ai/v1". base_url: The base URL for Grok API. Defaults to "https://api.x.ai/v1".
model: The model identifier to use. Defaults to "grok-3-beta". model: The model identifier to use. Defaults to "grok-3-beta".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/groq/llm.py
View File

@@ -38,7 +38,7 @@ class GroqLLMService(OpenAILLMService):
base_url: The base URL for Groq API. Defaults to "https://api.groq.com/openai/v1". base_url: The base URL for Groq API. Defaults to "https://api.groq.com/openai/v1".
model: The model identifier to use. Defaults to "llama-3.3-70b-versatile". model: The model identifier to use. Defaults to "llama-3.3-70b-versatile".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

8
src/pipecat/services/groq/stt.py
View File

@@ -43,24 +43,24 @@ class GroqSTTService(BaseWhisperSTTService):
Args: Args:
model: Whisper model to use. model: Whisper model to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(model=...)`` instead. Use ``settings=BaseWhisperSTTSettings(model=...)`` instead.
api_key: Groq API key. Defaults to None. api_key: Groq API key. Defaults to None.
base_url: API base URL. Defaults to "https://api.groq.com/openai/v1". base_url: API base URL. Defaults to "https://api.groq.com/openai/v1".
language: Language of the audio input. language: Language of the audio input.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(language=...)`` instead. Use ``settings=BaseWhisperSTTSettings(language=...)`` instead.
prompt: Optional text to guide the model's style or continue a previous segment. prompt: Optional text to guide the model's style or continue a previous segment.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(prompt=...)`` instead. Use ``settings=BaseWhisperSTTSettings(prompt=...)`` instead.
temperature: Optional sampling temperature between 0 and 1. temperature: Optional sampling temperature between 0 and 1.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(temperature=...)`` instead. Use ``settings=BaseWhisperSTTSettings(temperature=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

8
src/pipecat/services/groq/tts.py
View File

@@ -64,7 +64,7 @@ class GroqTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Groq TTS configuration. """Input parameters for Groq TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GroqTTSSettings(...)`` instead. Use ``settings=GroqTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -96,17 +96,17 @@ class GroqTTSService(TTSService):
output_format: Audio output format. Defaults to "wav". output_format: Audio output format. Defaults to "wav".
params: Additional input parameters for voice customization. params: Additional input parameters for voice customization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GroqTTSSettings(...)`` instead. Use ``settings=GroqTTSSettings(...)`` instead.
model_name: TTS model to use. model_name: TTS model to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GroqTTSSettings(model=...)`` instead. Use ``settings=GroqTTSSettings(model=...)`` instead.
voice_id: Voice identifier to use. voice_id: Voice identifier to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=GroqTTSSettings(voice=...)`` instead. Use ``settings=GroqTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate. Must be 48000 Hz for Groq TTS. sample_rate: Audio sample rate. Must be 48000 Hz for Groq TTS.

6
src/pipecat/services/hume/tts.py
View File

@@ -84,7 +84,7 @@ class HumeTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Optional synthesis parameters for Hume TTS. """Optional synthesis parameters for Hume TTS.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=HumeTTSSettings(...)`` instead. Use ``settings=HumeTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -113,12 +113,12 @@ class HumeTTSService(TTSService):
api_key: Hume API key. If omitted, reads the ``HUME_API_KEY`` environment variable. api_key: Hume API key. If omitted, reads the ``HUME_API_KEY`` environment variable.
voice_id: ID of the voice to use. Only voice IDs are supported; voice names are not. voice_id: ID of the voice to use. Only voice IDs are supported; voice names are not.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=HumeTTSSettings(voice=...)`` instead. Use ``settings=HumeTTSSettings(voice=...)`` instead.
params: Optional synthesis controls (acting instructions, speed, trailing silence). params: Optional synthesis controls (acting instructions, speed, trailing silence).
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=HumeTTSSettings(...)`` instead. Use ``settings=HumeTTSSettings(...)`` instead.
sample_rate: Output sample rate for emitted PCM frames. Defaults to 48_000 (Hume). sample_rate: Output sample rate for emitted PCM frames. Defaults to 48_000 (Hume).

16
src/pipecat/services/inworld/tts.py
View File

@@ -125,7 +125,7 @@ class InworldHttpTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Inworld TTS configuration. """Input parameters for Inworld TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``InworldTTSSettings`` directly via the ``settings`` parameter instead. Use ``InworldTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -159,12 +159,12 @@ class InworldHttpTTSService(TTSService):
aiohttp_session: aiohttp ClientSession for HTTP requests. aiohttp_session: aiohttp ClientSession for HTTP requests.
voice_id: ID of the voice to use for synthesis. voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=InworldTTSSettings(voice=...)`` instead. Use ``settings=InworldTTSSettings(voice=...)`` instead.
model: ID of the model to use for synthesis. model: ID of the model to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=InworldTTSSettings(model=...)`` instead. Use ``settings=InworldTTSSettings(model=...)`` instead.
streaming: Whether to use streaming mode. streaming: Whether to use streaming mode.
@@ -172,7 +172,7 @@ class InworldHttpTTSService(TTSService):
encoding: Audio encoding format. encoding: Audio encoding format.
params: Input parameters for Inworld TTS configuration. params: Input parameters for Inworld TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=InworldTTSSettings(...)`` instead. Use ``settings=InworldTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -532,7 +532,7 @@ class InworldTTSService(AudioContextTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Inworld WebSocket TTS configuration. """Input parameters for Inworld WebSocket TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``InworldTTSSettings`` directly via the ``settings`` parameter instead. Use ``InworldTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -579,12 +579,12 @@ class InworldTTSService(AudioContextTTSService):
api_key: Inworld API key. api_key: Inworld API key.
voice_id: ID of the voice to use for synthesis. voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=InworldTTSSettings(voice=...)`` instead. Use ``settings=InworldTTSSettings(voice=...)`` instead.
model: ID of the model to use for synthesis. model: ID of the model to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=InworldTTSSettings(model=...)`` instead. Use ``settings=InworldTTSSettings(model=...)`` instead.
url: URL of the Inworld WebSocket API. url: URL of the Inworld WebSocket API.
@@ -592,7 +592,7 @@ class InworldTTSService(AudioContextTTSService):
encoding: Audio encoding format. encoding: Audio encoding format.
params: Input parameters for Inworld WebSocket TTS configuration. params: Input parameters for Inworld WebSocket TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=InworldTTSSettings(...)`` instead. Use ``settings=InworldTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

6
src/pipecat/services/kokoro/tts.py
View File

@@ -112,7 +112,7 @@ class KokoroTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Kokoro TTS configuration. """Input parameters for Kokoro TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``KokoroTTSSettings`` directly via the ``settings`` parameter instead. Use ``KokoroTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -136,14 +136,14 @@ class KokoroTTSService(TTSService):
Args: Args:
voice_id: Voice identifier to use for synthesis. voice_id: Voice identifier to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=KokoroTTSSettings(voice=...)`` instead. Use ``settings=KokoroTTSSettings(voice=...)`` instead.
model_path: Path to the kokoro ONNX model file. Defaults to auto-downloaded file. model_path: Path to the kokoro ONNX model file. Defaults to auto-downloaded file.
voices_path: Path to the voices binary file. Defaults to auto-downloaded file. voices_path: Path to the voices binary file. Defaults to auto-downloaded file.
params: Configuration parameters for synthesis. params: Configuration parameters for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=KokoroTTSSettings(...)`` instead. Use ``settings=KokoroTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

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

@@ -111,14 +111,14 @@ class LmntTTSService(InterruptibleTTSService):
api_key: LMNT API key for authentication. api_key: LMNT API key for authentication.
voice_id: ID of the voice to use for synthesis. voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=LmntTTSSettings(voice=...)`` instead. Use ``settings=LmntTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate. If None, uses default. sample_rate: Audio sample rate. If None, uses default.
language: Language for synthesis. Defaults to English. language: Language for synthesis. Defaults to English.
model: TTS model to use. model: TTS model to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=LmntTTSSettings(model=...)`` instead. Use ``settings=LmntTTSSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

8
src/pipecat/services/minimax/tts.py
View File

@@ -166,7 +166,7 @@ class MiniMaxHttpTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for MiniMax TTS. """Configuration parameters for MiniMax TTS.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``MiniMaxTTSSettings`` directly via the ``settings`` parameter instead. Use ``MiniMaxTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -226,19 +226,19 @@ class MiniMaxHttpTTSService(TTSService):
"speech-02-hd", "speech-02-turbo", "speech-02-hd", "speech-02-turbo",
"speech-01-hd", "speech-01-turbo". "speech-01-hd", "speech-01-turbo".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=MiniMaxTTSSettings(model=...)`` instead. Use ``settings=MiniMaxTTSSettings(model=...)`` instead.
voice_id: Voice identifier. Defaults to "Calm_Woman". voice_id: Voice identifier. Defaults to "Calm_Woman".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=MiniMaxTTSSettings(voice=...)`` instead. Use ``settings=MiniMaxTTSSettings(voice=...)`` instead.
aiohttp_session: aiohttp.ClientSession for API communication. aiohttp_session: aiohttp.ClientSession for API communication.
sample_rate: Output audio sample rate in Hz. If None, uses pipeline default. sample_rate: Output audio sample rate in Hz. If None, uses pipeline default.
params: Additional configuration parameters. params: Additional configuration parameters.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=MiniMaxTTSSettings(...)`` instead. Use ``settings=MiniMaxTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/mistral/llm.py
View File

@@ -41,7 +41,7 @@ class MistralLLMService(OpenAILLMService):
base_url: The base URL for Mistral API. Defaults to "https://api.mistral.ai/v1". base_url: The base URL for Mistral API. Defaults to "https://api.mistral.ai/v1".
model: The model identifier to use. Defaults to "mistral-small-latest". model: The model identifier to use. Defaults to "mistral-small-latest".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/moondream/vision.py
View File

@@ -93,7 +93,7 @@ class MoondreamService(VisionService):
Args: Args:
model: Hugging Face model identifier for the Moondream model. model: Hugging Face model identifier for the Moondream model.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=MoondreamSettings(model=...)`` instead. Use ``settings=MoondreamSettings(model=...)`` instead.
revision: Specific model revision to use. revision: Specific model revision to use.

12
src/pipecat/services/neuphonic/tts.py
View File

@@ -102,7 +102,7 @@ class NeuphonicTTSService(InterruptibleTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Neuphonic TTS configuration. """Input parameters for Neuphonic TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NeuphonicTTSSettings(...)`` instead. Use ``settings=NeuphonicTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -133,7 +133,7 @@ class NeuphonicTTSService(InterruptibleTTSService):
api_key: Neuphonic API key for authentication. api_key: Neuphonic API key for authentication.
voice_id: ID of the voice to use for synthesis. voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NeuphonicTTSSettings(voice=...)`` instead. Use ``settings=NeuphonicTTSSettings(voice=...)`` instead.
url: WebSocket URL for the Neuphonic API. url: WebSocket URL for the Neuphonic API.
@@ -141,7 +141,7 @@ class NeuphonicTTSService(InterruptibleTTSService):
encoding: Audio encoding format. Defaults to "pcm_linear". encoding: Audio encoding format. Defaults to "pcm_linear".
params: Additional input parameters for TTS configuration. params: Additional input parameters for TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NeuphonicTTSSettings(...)`` instead. Use ``settings=NeuphonicTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -451,7 +451,7 @@ class NeuphonicHttpTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Neuphonic HTTP TTS configuration. """Input parameters for Neuphonic HTTP TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NeuphonicTTSSettings(...)`` instead. Use ``settings=NeuphonicTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -481,7 +481,7 @@ class NeuphonicHttpTTSService(TTSService):
api_key: Neuphonic API key for authentication. api_key: Neuphonic API key for authentication.
voice_id: ID of the voice to use for synthesis. voice_id: ID of the voice to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NeuphonicTTSSettings(voice=...)`` instead. Use ``settings=NeuphonicTTSSettings(voice=...)`` instead.
aiohttp_session: Shared aiohttp session for HTTP requests. aiohttp_session: Shared aiohttp session for HTTP requests.
@@ -490,7 +490,7 @@ class NeuphonicHttpTTSService(TTSService):
encoding: Audio encoding format. Defaults to "pcm_linear". encoding: Audio encoding format. Defaults to "pcm_linear".
params: Additional input parameters for TTS configuration. params: Additional input parameters for TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NeuphonicTTSSettings(...)`` instead. Use ``settings=NeuphonicTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/nvidia/llm.py
View File

@@ -45,7 +45,7 @@ class NvidiaLLMService(OpenAILLMService):
model: The model identifier to use. Defaults to model: The model identifier to use. Defaults to
"nvidia/llama-3.1-nemotron-70b-instruct". "nvidia/llama-3.1-nemotron-70b-instruct".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

8
src/pipecat/services/nvidia/stt.py
View File

@@ -130,7 +130,7 @@ class NvidiaSTTService(STTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for NVIDIA Riva STT service. """Configuration parameters for NVIDIA Riva STT service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NvidiaSTTSettings(...)`` instead. Use ``settings=NvidiaSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -164,7 +164,7 @@ class NvidiaSTTService(STTService):
sample_rate: Audio sample rate in Hz. If None, uses pipeline default. sample_rate: Audio sample rate in Hz. If None, uses pipeline default.
params: Additional configuration parameters for NVIDIA Riva. params: Additional configuration parameters for NVIDIA Riva.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NvidiaSTTSettings(...)`` instead. Use ``settings=NvidiaSTTSettings(...)`` instead.
use_ssl: Whether to use SSL for the NVIDIA Riva server. Defaults to True. use_ssl: Whether to use SSL for the NVIDIA Riva server. Defaults to True.
@@ -444,7 +444,7 @@ class NvidiaSegmentedSTTService(SegmentedSTTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for NVIDIA Riva segmented STT service. """Configuration parameters for NVIDIA Riva segmented STT service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NvidiaSegmentedSTTSettings(...)`` instead. Use ``settings=NvidiaSegmentedSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -488,7 +488,7 @@ class NvidiaSegmentedSTTService(SegmentedSTTService):
sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate sample_rate: Audio sample rate in Hz. If not provided, uses the pipeline's rate
params: Additional configuration parameters for NVIDIA Riva params: Additional configuration parameters for NVIDIA Riva
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NvidiaSegmentedSTTSettings(...)`` instead. Use ``settings=NvidiaSegmentedSTTSettings(...)`` instead.
use_ssl: Whether to use SSL for the NVIDIA Riva server. Defaults to True. use_ssl: Whether to use SSL for the NVIDIA Riva server. Defaults to True.

6
src/pipecat/services/nvidia/tts.py
View File

@@ -68,7 +68,7 @@ class NvidiaTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Riva TTS configuration. """Input parameters for Riva TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``NvidiaTTSSettings`` directly via the ``settings`` parameter instead. Use ``NvidiaTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -102,14 +102,14 @@ class NvidiaTTSService(TTSService):
server: gRPC server endpoint. Defaults to NVIDIA's cloud endpoint. server: gRPC server endpoint. Defaults to NVIDIA's cloud endpoint.
voice_id: Voice model identifier. Defaults to multilingual Aria voice. voice_id: Voice model identifier. Defaults to multilingual Aria voice.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NvidiaTTSSettings(voice=...)`` instead. Use ``settings=NvidiaTTSSettings(voice=...)`` instead.
sample_rate: Audio sample rate. If None, uses service default. sample_rate: Audio sample rate. If None, uses service default.
model_function_map: Dictionary containing function_id and model_name for the TTS model. model_function_map: Dictionary containing function_id and model_name for the TTS model.
params: Additional configuration parameters for TTS synthesis. params: Additional configuration parameters for TTS synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=NvidiaTTSSettings(...)`` instead. Use ``settings=NvidiaTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/ollama/llm.py
View File

@@ -35,7 +35,7 @@ class OLLamaLLMService(OpenAILLMService):
Args: Args:
model: The OLLama model to use. Defaults to "llama2". model: The OLLama model to use. Defaults to "llama2".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
base_url: The base URL for the OLLama API endpoint. base_url: The base URL for the OLLama API endpoint.

6
src/pipecat/services/openai/base_llm.py
View File

@@ -75,7 +75,7 @@ class BaseOpenAILLMService(LLMService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for OpenAI model configuration. """Input parameters for OpenAI model configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(...)`` instead of Use ``settings=OpenAILLMSettings(...)`` instead of
``params=InputParams(...)``. ``params=InputParams(...)``.
@@ -130,7 +130,7 @@ class BaseOpenAILLMService(LLMService):
Args: Args:
model: The OpenAI model name to use (e.g., "gpt-4.1", "gpt-4o"). model: The OpenAI model name to use (e.g., "gpt-4.1", "gpt-4o").
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
api_key: OpenAI API key. If None, uses environment variable. api_key: OpenAI API key. If None, uses environment variable.
@@ -140,7 +140,7 @@ class BaseOpenAILLMService(LLMService):
default_headers: Additional HTTP headers to include in requests. default_headers: Additional HTTP headers to include in requests.
params: Input parameters for model configuration and behavior. params: Input parameters for model configuration and behavior.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(...)`` instead. Use ``settings=OpenAILLMSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/openai/image.py
View File

@@ -64,7 +64,7 @@ class OpenAIImageGenService(ImageGenService):
image_size: Target size for generated images. image_size: Target size for generated images.
model: DALL-E model to use for generation. Defaults to "dall-e-3". model: DALL-E model to use for generation. Defaults to "dall-e-3".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAIImageGenSettings(model=...)`` instead. Use ``settings=OpenAIImageGenSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

4
src/pipecat/services/openai/llm.py
View File

@@ -85,12 +85,12 @@ class OpenAILLMService(BaseOpenAILLMService):
Args: Args:
model: The OpenAI model name to use. Defaults to "gpt-4.1". model: The OpenAI model name to use. Defaults to "gpt-4.1".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
params: Input parameters for model configuration. params: Input parameters for model configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(...)`` instead. Use ``settings=OpenAILLMSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

4
src/pipecat/services/openai/stt.py
View File

@@ -80,7 +80,7 @@ class OpenAISTTService(BaseWhisperSTTService):
Args: Args:
model: Model to use — either gpt-4o or Whisper. model: Model to use — either gpt-4o or Whisper.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(model=...)`` instead. Use ``settings=BaseWhisperSTTSettings(model=...)`` instead.
api_key: OpenAI API key. Defaults to None. api_key: OpenAI API key. Defaults to None.
@@ -222,7 +222,7 @@ class OpenAIRealtimeSTTService(WebsocketSTTService):
model: Transcription model. Supported values are model: Transcription model. Supported values are
``"gpt-4o-transcribe"`` and ``"gpt-4o-mini-transcribe"``. ``"gpt-4o-transcribe"`` and ``"gpt-4o-mini-transcribe"``.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAIRealtimeSTTSettings(model=...)`` instead. Use ``settings=OpenAIRealtimeSTTSettings(model=...)`` instead.
base_url: WebSocket base URL for the Realtime API. base_url: WebSocket base URL for the Realtime API.

12
src/pipecat/services/openai/tts.py
View File

@@ -90,7 +90,7 @@ class OpenAITTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for OpenAI TTS configuration. """Input parameters for OpenAI TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAITTSSettings(...)`` instead. Use ``settings=OpenAITTSSettings(...)`` instead.
Parameters: Parameters:
@@ -122,28 +122,28 @@ class OpenAITTSService(TTSService):
base_url: Custom base URL for OpenAI API. If None, uses default. base_url: Custom base URL for OpenAI API. If None, uses default.
voice: Voice ID to use for synthesis. Defaults to "alloy". voice: Voice ID to use for synthesis. Defaults to "alloy".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAITTSSettings(voice=...)`` instead. Use ``settings=OpenAITTSSettings(voice=...)`` instead.
model: TTS model to use. Defaults to "gpt-4o-mini-tts". model: TTS model to use. Defaults to "gpt-4o-mini-tts".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAITTSSettings(model=...)`` instead. Use ``settings=OpenAITTSSettings(model=...)`` instead.
sample_rate: Output audio sample rate in Hz. If None, uses OpenAI's default 24kHz. sample_rate: Output audio sample rate in Hz. If None, uses OpenAI's default 24kHz.
instructions: Optional instructions to guide voice synthesis behavior. instructions: Optional instructions to guide voice synthesis behavior.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAITTSSettings(instructions=...)`` instead. Use ``settings=OpenAITTSSettings(instructions=...)`` instead.
speed: Voice speed control (0.25 to 4.0, default 1.0). speed: Voice speed control (0.25 to 4.0, default 1.0).
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAITTSSettings(speed=...)`` instead. Use ``settings=OpenAITTSSettings(speed=...)`` instead.
params: Optional synthesis controls (acting instructions, speed, ...). params: Optional synthesis controls (acting instructions, speed, ...).
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAITTSSettings(...)`` instead. Use ``settings=OpenAITTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/openpipe/llm.py
View File

@@ -52,7 +52,7 @@ class OpenPipeLLMService(OpenAILLMService):
Args: Args:
model: The model name to use. Defaults to "gpt-4.1". model: The model name to use. Defaults to "gpt-4.1".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
api_key: OpenAI API key for authentication. If None, reads from environment. api_key: OpenAI API key for authentication. If None, reads from environment.

2
src/pipecat/services/openrouter/llm.py
View File

@@ -42,7 +42,7 @@ class OpenRouterLLMService(OpenAILLMService):
to read from environment variables. to read from environment variables.
model: The model identifier to use. Defaults to "openai/gpt-4o-2024-11-20". model: The model identifier to use. Defaults to "openai/gpt-4o-2024-11-20".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
base_url: The base URL for OpenRouter API. Defaults to "https://openrouter.ai/api/v1". base_url: The base URL for OpenRouter API. Defaults to "https://openrouter.ai/api/v1".

2
src/pipecat/services/perplexity/llm.py
View File

@@ -46,7 +46,7 @@ class PerplexityLLMService(OpenAILLMService):
base_url: The base URL for Perplexity's API. Defaults to "https://api.perplexity.ai". base_url: The base URL for Perplexity's API. Defaults to "https://api.perplexity.ai".
model: The model identifier to use. Defaults to "sonar". model: The model identifier to use. Defaults to "sonar".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

4
src/pipecat/services/piper/tts.py
View File

@@ -65,7 +65,7 @@ class PiperTTSService(TTSService):
Args: Args:
voice_id: Piper voice model identifier (e.g. `en_US-ryan-high`). voice_id: Piper voice model identifier (e.g. `en_US-ryan-high`).
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=PiperTTSSettings(voice=...)`` instead. Use ``settings=PiperTTSSettings(voice=...)`` instead.
download_dir: Directory for storing voice model files. Defaults to download_dir: Directory for storing voice model files. Defaults to
@@ -222,7 +222,7 @@ class PiperHttpTTSService(TTSService):
aiohttp_session: aiohttp ClientSession for making HTTP requests. aiohttp_session: aiohttp ClientSession for making HTTP requests.
voice_id: Piper voice model identifier (e.g. `en_US-ryan-high`). voice_id: Piper voice model identifier (e.g. `en_US-ryan-high`).
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=PiperHttpTTSSettings(voice=...)`` instead. Use ``settings=PiperHttpTTSSettings(voice=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/qwen/llm.py
View File

@@ -38,7 +38,7 @@ class QwenLLMService(OpenAILLMService):
base_url: Base URL for Qwen API. Defaults to "https://dashscope-intl.aliyuncs.com/compatible-mode/v1". base_url: Base URL for Qwen API. Defaults to "https://dashscope-intl.aliyuncs.com/compatible-mode/v1".
model: The model identifier to use. Defaults to "qwen-plus". model: The model identifier to use. Defaults to "qwen-plus".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/resembleai/tts.py
View File

@@ -84,7 +84,7 @@ class ResembleAITTSService(AudioContextTTSService):
api_key: Resemble AI API key for authentication. api_key: Resemble AI API key for authentication.
voice_id: Voice UUID to use for synthesis. voice_id: Voice UUID to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=ResembleAITTSSettings(voice=...)`` instead. Use ``settings=ResembleAITTSSettings(voice=...)`` instead.
url: WebSocket URL for Resemble AI TTS API. url: WebSocket URL for Resemble AI TTS API.

24
src/pipecat/services/rime/tts.py
View File

@@ -144,7 +144,7 @@ class RimeTTSService(AudioContextTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Rime TTS service. """Configuration parameters for Rime TTS service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeTTSSettings(...)`` instead. Use ``settings=RimeTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -196,19 +196,19 @@ class RimeTTSService(AudioContextTTSService):
api_key: Rime API key for authentication. api_key: Rime API key for authentication.
voice_id: ID of the voice to use. voice_id: ID of the voice to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeTTSSettings(voice=...)`` instead. Use ``settings=RimeTTSSettings(voice=...)`` instead.
url: Rime websocket API endpoint. url: Rime websocket API endpoint.
model: Model ID to use for synthesis. model: Model ID to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeTTSSettings(model=...)`` instead. Use ``settings=RimeTTSSettings(model=...)`` instead.
sample_rate: Audio sample rate in Hz. sample_rate: Audio sample rate in Hz.
params: Additional configuration parameters. params: Additional configuration parameters.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeTTSSettings(...)`` instead. Use ``settings=RimeTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -676,7 +676,7 @@ class RimeHttpTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Rime HTTP TTS service. """Configuration parameters for Rime HTTP TTS service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeTTSSettings(...)`` instead. Use ``settings=RimeTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -713,19 +713,19 @@ class RimeHttpTTSService(TTSService):
api_key: Rime API key for authentication. api_key: Rime API key for authentication.
voice_id: ID of the voice to use. voice_id: ID of the voice to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeTTSSettings(voice=...)`` instead. Use ``settings=RimeTTSSettings(voice=...)`` instead.
aiohttp_session: Shared aiohttp session for HTTP requests. aiohttp_session: Shared aiohttp session for HTTP requests.
model: Model ID to use for synthesis. model: Model ID to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeTTSSettings(model=...)`` instead. Use ``settings=RimeTTSSettings(model=...)`` instead.
sample_rate: Audio sample rate in Hz. sample_rate: Audio sample rate in Hz.
params: Additional configuration parameters. params: Additional configuration parameters.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeTTSSettings(...)`` instead. Use ``settings=RimeTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -902,7 +902,7 @@ class RimeNonJsonTTSService(InterruptibleTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Rime Non-JSON WebSocket TTS service. """Configuration parameters for Rime Non-JSON WebSocket TTS service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeNonJsonTTSSettings(...)`` instead. Use ``settings=RimeNonJsonTTSSettings(...)`` instead.
Args: Args:
@@ -942,20 +942,20 @@ class RimeNonJsonTTSService(InterruptibleTTSService):
api_key: Rime API key for authentication. api_key: Rime API key for authentication.
voice_id: ID of the voice to use. voice_id: ID of the voice to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeNonJsonTTSSettings(voice=...)`` instead. Use ``settings=RimeNonJsonTTSSettings(voice=...)`` instead.
url: Rime websocket API endpoint. url: Rime websocket API endpoint.
model: Model ID to use for synthesis. model: Model ID to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeNonJsonTTSSettings(model=...)`` instead. Use ``settings=RimeNonJsonTTSSettings(model=...)`` instead.
audio_format: Audio format to use. audio_format: Audio format to use.
sample_rate: Audio sample rate in Hz. sample_rate: Audio sample rate in Hz.
params: Additional configuration parameters. params: Additional configuration parameters.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=RimeNonJsonTTSSettings(...)`` instead. Use ``settings=RimeNonJsonTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/sambanova/llm.py
View File

@@ -49,7 +49,7 @@ class SambaNovaLLMService(OpenAILLMService): # type: ignore
api_key: The API key for accessing SambaNova API. api_key: The API key for accessing SambaNova API.
model: The model identifier to use. Defaults to "Llama-4-Maverick-17B-128E-Instruct". model: The model identifier to use. Defaults to "Llama-4-Maverick-17B-128E-Instruct".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
base_url: The base URL for SambaNova API. Defaults to "https://api.sambanova.ai/v1". base_url: The base URL for SambaNova API. Defaults to "https://api.sambanova.ai/v1".

8
src/pipecat/services/sambanova/stt.py
View File

@@ -45,24 +45,24 @@ class SambaNovaSTTService(BaseWhisperSTTService): # type: ignore
Args: Args:
model: Whisper model to use. model: Whisper model to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(model=...)`` instead. Use ``settings=BaseWhisperSTTSettings(model=...)`` instead.
api_key: SambaNova API key. Defaults to None. api_key: SambaNova API key. Defaults to None.
base_url: API base URL. Defaults to "https://api.sambanova.ai/v1". base_url: API base URL. Defaults to "https://api.sambanova.ai/v1".
language: Language of the audio input. language: Language of the audio input.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(language=...)`` instead. Use ``settings=BaseWhisperSTTSettings(language=...)`` instead.
prompt: Optional text to guide the model's style or continue a previous segment. prompt: Optional text to guide the model's style or continue a previous segment.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(prompt=...)`` instead. Use ``settings=BaseWhisperSTTSettings(prompt=...)`` instead.
temperature: Optional sampling temperature between 0 and 1. temperature: Optional sampling temperature between 0 and 1.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(temperature=...)`` instead. Use ``settings=BaseWhisperSTTSettings(temperature=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

6
src/pipecat/services/sarvam/stt.py
View File

@@ -177,7 +177,7 @@ class SarvamSTTService(STTService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Sarvam STT service. """Configuration parameters for Sarvam STT service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamSTTSettings(...)`` instead. Use ``settings=SarvamSTTSettings(...)`` instead.
Parameters: Parameters:
@@ -219,14 +219,14 @@ class SarvamSTTService(STTService):
api_key: Sarvam API key for authentication. api_key: Sarvam API key for authentication.
model: Sarvam model to use for transcription. model: Sarvam model to use for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamSTTSettings(model=...)`` instead. Use ``settings=SarvamSTTSettings(model=...)`` instead.
sample_rate: Audio sample rate. Defaults to 16000 if not specified. sample_rate: Audio sample rate. Defaults to 16000 if not specified.
input_audio_codec: Audio codec/format of the input file. Defaults to "wav". input_audio_codec: Audio codec/format of the input file. Defaults to "wav".
params: Configuration parameters for Sarvam STT service. params: Configuration parameters for Sarvam STT service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamSTTSettings(...)`` instead. Use ``settings=SarvamSTTSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

16
src/pipecat/services/sarvam/tts.py
View File

@@ -376,7 +376,7 @@ class SarvamHttpTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Input parameters for Sarvam TTS configuration. """Input parameters for Sarvam TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``SarvamHttpTTSSettings`` directly via the ``settings`` parameter instead. Use ``SarvamHttpTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -445,14 +445,14 @@ class SarvamHttpTTSService(TTSService):
aiohttp_session: Shared aiohttp session for making requests. aiohttp_session: Shared aiohttp session for making requests.
voice_id: Speaker voice ID. If None, uses model-appropriate default. voice_id: Speaker voice ID. If None, uses model-appropriate default.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamHttpTTSSettings(voice=...)`` instead. Use ``settings=SarvamHttpTTSSettings(voice=...)`` instead.
model: TTS model to use. Options: model: TTS model to use. Options:
- "bulbul:v2" (default): Standard model with pitch/loudness support - "bulbul:v2" (default): Standard model with pitch/loudness support
- "bulbul:v3-beta": Advanced model with temperature control - "bulbul:v3-beta": Advanced model with temperature control
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamHttpTTSSettings(model=...)`` instead. Use ``settings=SarvamHttpTTSSettings(model=...)`` instead.
base_url: Sarvam AI API base URL. Defaults to "https://api.sarvam.ai". base_url: Sarvam AI API base URL. Defaults to "https://api.sarvam.ai".
@@ -460,7 +460,7 @@ class SarvamHttpTTSService(TTSService):
If None, uses model-specific default. If None, uses model-specific default.
params: Additional voice and preprocessing parameters. If None, uses defaults. params: Additional voice and preprocessing parameters. If None, uses defaults.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamHttpTTSSettings(...)`` instead. Use ``settings=SarvamHttpTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -742,7 +742,7 @@ class SarvamTTSService(InterruptibleTTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Configuration parameters for Sarvam TTS WebSocket service. """Configuration parameters for Sarvam TTS WebSocket service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``SarvamTTSSettings`` directly via the ``settings`` parameter instead. Use ``SarvamTTSSettings`` directly via the ``settings`` parameter instead.
Parameters: Parameters:
@@ -848,12 +848,12 @@ class SarvamTTSService(InterruptibleTTSService):
- "bulbul:v2" (default): Standard model with pitch/loudness support - "bulbul:v2" (default): Standard model with pitch/loudness support
- "bulbul:v3-beta": Advanced model with temperature control - "bulbul:v3-beta": Advanced model with temperature control
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamTTSSettings(model=...)`` instead. Use ``settings=SarvamTTSSettings(model=...)`` instead.
voice_id: Speaker voice ID. If None, uses model-appropriate default. voice_id: Speaker voice ID. If None, uses model-appropriate default.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamTTSSettings(voice=...)`` instead. Use ``settings=SarvamTTSSettings(voice=...)`` instead.
url: WebSocket URL for the TTS backend (default production URL). url: WebSocket URL for the TTS backend (default production URL).
@@ -867,7 +867,7 @@ class SarvamTTSService(InterruptibleTTSService):
If None, uses model-specific default. If None, uses model-specific default.
params: Optional input parameters to override defaults. params: Optional input parameters to override defaults.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SarvamTTSSettings(...)`` instead. Use ``settings=SarvamTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

6
src/pipecat/services/soniox/stt.py
View File

@@ -79,7 +79,7 @@ class SonioxContextObject(BaseModel):
class SonioxInputParams(BaseModel): class SonioxInputParams(BaseModel):
"""Real-time transcription settings. """Real-time transcription settings.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SonioxSTTSettings(...)`` instead. Use ``settings=SonioxSTTSettings(...)`` instead.
See Soniox WebSocket API documentation for more details: See Soniox WebSocket API documentation for more details:
@@ -201,13 +201,13 @@ class SonioxSTTService(WebsocketSTTService):
sample_rate: Audio sample rate. sample_rate: Audio sample rate.
model: Soniox model to use for transcription. model: Soniox model to use for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SonioxSTTSettings(model=...)`` instead. Use ``settings=SonioxSTTSettings(model=...)`` instead.
params: Additional configuration parameters, such as language hints, context and params: Additional configuration parameters, such as language hints, context and
speaker diarization. speaker diarization.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SonioxSTTSettings(...)`` instead. Use ``settings=SonioxSTTSettings(...)`` instead.
vad_force_turn_endpoint: Listen to `VADUserStoppedSpeakingFrame` to send finalize message to Soniox. vad_force_turn_endpoint: Listen to `VADUserStoppedSpeakingFrame` to send finalize message to Soniox.

2
src/pipecat/services/speechmatics/stt.py
View File

@@ -395,7 +395,7 @@ class SpeechmaticsSTTService(STTService):
sample_rate: Optional audio sample rate in Hz. sample_rate: Optional audio sample rate in Hz.
params: Input parameters for the service. params: Input parameters for the service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SpeechmaticsSTTSettings(...)`` instead. Use ``settings=SpeechmaticsSTTSettings(...)`` instead.
should_interrupt: Determine whether the bot should be interrupted when Speechmatics turn_detection_mode is configured to detect user speech. should_interrupt: Determine whether the bot should be interrupted when Speechmatics turn_detection_mode is configured to detect user speech.

6
src/pipecat/services/speechmatics/tts.py
View File

@@ -62,7 +62,7 @@ class SpeechmaticsTTSService(TTSService):
class InputParams(BaseModel): class InputParams(BaseModel):
"""Optional input parameters for Speechmatics TTS configuration. """Optional input parameters for Speechmatics TTS configuration.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SpeechmaticsTTSSettings(...)`` instead. Use ``settings=SpeechmaticsTTSSettings(...)`` instead.
Parameters: Parameters:
@@ -90,14 +90,14 @@ class SpeechmaticsTTSService(TTSService):
base_url: Base URL for Speechmatics TTS API. base_url: Base URL for Speechmatics TTS API.
voice_id: Voice model to use for synthesis. voice_id: Voice model to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SpeechmaticsTTSSettings(voice=...)`` instead. Use ``settings=SpeechmaticsTTSSettings(voice=...)`` instead.
aiohttp_session: Shared aiohttp session for HTTP requests. aiohttp_session: Shared aiohttp session for HTTP requests.
sample_rate: Audio sample rate in Hz. sample_rate: Audio sample rate in Hz.
params: Input parameters for the service. params: Input parameters for the service.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=SpeechmaticsTTSSettings(...)`` instead. Use ``settings=SpeechmaticsTTSSettings(...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/together/llm.py
View File

@@ -38,7 +38,7 @@ class TogetherLLMService(OpenAILLMService):
base_url: The base URL for Together.ai API. Defaults to "https://api.together.xyz/v1". base_url: The base URL for Together.ai API. Defaults to "https://api.together.xyz/v1".
model: The model identifier to use. Defaults to "meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo". model: The model identifier to use. Defaults to "meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo".
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=OpenAILLMSettings(model=...)`` instead. Use ``settings=OpenAILLMSettings(model=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

8
src/pipecat/services/whisper/base_stt.py
View File

@@ -145,24 +145,24 @@ class BaseWhisperSTTService(SegmentedSTTService):
Args: Args:
model: Name of the Whisper model to use. model: Name of the Whisper model to use.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(model=...)`` instead. Use ``settings=BaseWhisperSTTSettings(model=...)`` instead.
api_key: Service API key. Defaults to None. api_key: Service API key. Defaults to None.
base_url: Service API base URL. Defaults to None. base_url: Service API base URL. Defaults to None.
language: Language of the audio input. language: Language of the audio input.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(language=...)`` instead. Use ``settings=BaseWhisperSTTSettings(language=...)`` instead.
prompt: Optional text to guide the model's style or continue a previous segment. prompt: Optional text to guide the model's style or continue a previous segment.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(prompt=...)`` instead. Use ``settings=BaseWhisperSTTSettings(prompt=...)`` instead.
temperature: Sampling temperature between 0 and 1. temperature: Sampling temperature between 0 and 1.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=BaseWhisperSTTSettings(temperature=...)`` instead. Use ``settings=BaseWhisperSTTSettings(temperature=...)`` instead.
include_prob_metrics: If True, enables probability metrics in API response. include_prob_metrics: If True, enables probability metrics in API response.

18
src/pipecat/services/whisper/stt.py
View File

@@ -229,27 +229,27 @@ class WhisperSTTService(SegmentedSTTService):
Args: Args:
model: The Whisper model to use for transcription. Can be a Model enum or string. model: The Whisper model to use for transcription. Can be a Model enum or string.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperSTTSettings(model=...)`` instead. Use ``settings=WhisperSTTSettings(model=...)`` instead.
device: The device to run inference on ('cpu', 'cuda', or 'auto'). device: The device to run inference on ('cpu', 'cuda', or 'auto').
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperSTTSettings(device=...)`` instead. Use ``settings=WhisperSTTSettings(device=...)`` instead.
compute_type: The compute type for inference ('default', 'int8', 'int8_float16', etc.). compute_type: The compute type for inference ('default', 'int8', 'int8_float16', etc.).
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperSTTSettings(compute_type=...)`` instead. Use ``settings=WhisperSTTSettings(compute_type=...)`` instead.
no_speech_prob: Probability threshold for filtering out non-speech segments. no_speech_prob: Probability threshold for filtering out non-speech segments.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperSTTSettings(no_speech_prob=...)`` instead. Use ``settings=WhisperSTTSettings(no_speech_prob=...)`` instead.
language: The default language for transcription. language: The default language for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperSTTSettings(language=...)`` instead. Use ``settings=WhisperSTTSettings(language=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated
@@ -413,22 +413,22 @@ class WhisperSTTServiceMLX(WhisperSTTService):
Args: Args:
model: The MLX Whisper model to use for transcription. Can be an MLXModel enum or string. model: The MLX Whisper model to use for transcription. Can be an MLXModel enum or string.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperMLXSTTSettings(model=...)`` instead. Use ``settings=WhisperMLXSTTSettings(model=...)`` instead.
no_speech_prob: Probability threshold for filtering out non-speech segments. no_speech_prob: Probability threshold for filtering out non-speech segments.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperMLXSTTSettings(no_speech_prob=...)`` instead. Use ``settings=WhisperMLXSTTSettings(no_speech_prob=...)`` instead.
language: The default language for transcription. language: The default language for transcription.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperMLXSTTSettings(language=...)`` instead. Use ``settings=WhisperMLXSTTSettings(language=...)`` instead.
temperature: Temperature for sampling. Can be a float or tuple of floats. temperature: Temperature for sampling. Can be a float or tuple of floats.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=WhisperMLXSTTSettings(temperature=...)`` instead. Use ``settings=WhisperMLXSTTSettings(temperature=...)`` instead.
settings: Runtime-updatable settings. When provided alongside deprecated settings: Runtime-updatable settings. When provided alongside deprecated

2
src/pipecat/services/xtts/tts.py
View File

@@ -107,7 +107,7 @@ class XTTSService(TTSService):
Args: Args:
voice_id: ID of the voice/speaker to use for synthesis. voice_id: ID of the voice/speaker to use for synthesis.
.. deprecated:: 1.0.0 .. deprecated:: 0.0.105
Use ``settings=XTTSTTSSettings(voice=...)`` instead. Use ``settings=XTTSTTSSettings(voice=...)`` instead.
base_url: Base URL of the XTTS streaming server. base_url: Base URL of the XTTS streaming server.