TTSService: deprecate say() method
This commit is contained in:
@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
### Deprecated
|
### Deprecated
|
||||||
|
|
||||||
|
- `TTSService.say()` is deprecated, push a `TTSSpeakFrame` instead. Calling
|
||||||
|
functions directly is a discouraged pattern in Pipecat because, for example,
|
||||||
|
it might cause issues with frame ordering.
|
||||||
|
|
||||||
- `LLMMessagesFrame` is deprecated, in favor of either:
|
- `LLMMessagesFrame` is deprecated, in favor of either:
|
||||||
|
|
||||||
- `LLMMessagesUpdateFrame` with `run_llm=True`
|
- `LLMMessagesUpdateFrame` with `run_llm=True`
|
||||||
@@ -67,7 +71,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Added Chinese, Japanese, Korean word timestamp support to
|
- Added Chinese, Japanese, Korean word timestamp support to
|
||||||
`CartesiaTTSService`.
|
`CartesiaTTSService`.
|
||||||
|
|
||||||
- Added `region` parameter to `GladiaSTTService`. Accepted values: eu-west (default), us-west.
|
- Added `region` parameter to `GladiaSTTService`. Accepted values: eu-west
|
||||||
|
(default), us-west.
|
||||||
|
|
||||||
### Changed
|
### Changed
|
||||||
|
|
||||||
|
|||||||
@@ -269,9 +269,20 @@ class TTSService(AIService):
|
|||||||
async def say(self, text: str):
|
async def say(self, text: str):
|
||||||
"""Immediately speak the provided text.
|
"""Immediately speak the provided text.
|
||||||
|
|
||||||
|
.. deprecated:: 0.0.79
|
||||||
|
Push a `TTSSpeakFrame` instead to ensure frame ordering is maintained.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
text: The text to speak.
|
text: The text to speak.
|
||||||
"""
|
"""
|
||||||
|
import warnings
|
||||||
|
|
||||||
|
warnings.warn(
|
||||||
|
"`TTSService.say()` is deprecated. Push a `TTSSpeakFrame` instead.",
|
||||||
|
DeprecationWarning,
|
||||||
|
stacklevel=2,
|
||||||
|
)
|
||||||
|
|
||||||
await self.queue_frame(TTSSpeakFrame(text))
|
await self.queue_frame(TTSSpeakFrame(text))
|
||||||
|
|
||||||
async def process_frame(self, frame: Frame, direction: FrameDirection):
|
async def process_frame(self, frame: Frame, direction: FrameDirection):
|
||||||
|
|||||||
Reference in New Issue
Block a user