Skip to content

Commit c0dfb95

Browse files
committed
update CHANGELOG for new interruption and speaking strategies
1 parent d7e63db commit c0dfb95

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

CHANGELOG.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,50 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
- Introducing new interruption and speaking strategies. Interruption strategies
13+
are used to indicate when the user should interrupt the bot (e.g. using VAD
14+
events or when a user says one or more words). Speaking strategies are used to
15+
indicate when the bot should start talking (e.g. using an end-of-turn
16+
detection model, or checking how long until the last user transcription). In
17+
conversational agents these are usually referred to start/stop speaking
18+
policies or plans.
19+
20+
Available interruption strategies:
21+
- VADInterruptionStrategy (default)
22+
- MinWordsInterruptionStrategy
23+
24+
Avaliable speaking strategies:
25+
- TranscriptionSpeakingStrategy (default)
26+
- TurnAnalyzerSpeakingStrategy
27+
28+
To set these strategies you do it when setting up the `PipelineTask`, for
29+
example:
30+
31+
```python
32+
task = PipelineTask(..., params=PipelineParams(
33+
interruption_strategies=[MinWordsInterruptionStrategy(min_words=1)],
34+
speaking_strategies=[
35+
TurnAnalyzerSpeakingStrategy(
36+
turn_analyzer=LocalSmartTurnAnalyzerV3(params=SmartTurnParams())
37+
)
38+
],
39+
))
40+
```
41+
42+
In order to use the new interruption and speaking strategies you should update
43+
to the new universal `LLMContext` and `LLMContextAggregatorPair`.
44+
1245
- Added a `TTSService.includes_inter_frame_spaces` property getter, so that TTS
1346
services that subclass `TTSService` can indicate whether the text in the
1447
`TTSTextFrame`s they push already contain any necessary inter-frame spaces.
1548

49+
### Deprecated
50+
51+
- `pipecat.audio.interruptions.MinWordsInterruptionStrategy` is deprecated. Use
52+
the new interruption and speaking strategies.
53+
54+
- `TransportParams.turn_analyzer` is deprecated, use the new speaking strategies.
55+
1656
### Fixed
1757

1858
- Fixed subtle issue of assistant context messages ending up with double spaces

0 commit comments

Comments
 (0)