Skip to content

docs: update for pipecat PR #4414 #788

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
markbackman wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −4
Open

docs: update for pipecat PR #4414 #788

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions api-reference/server/utilities/turn-management/turn-events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,10 +193,11 @@ async def on_assistant_turn_stopped(aggregator, message: AssistantTurnStoppedMes
| `message` | `AssistantTurnStoppedMessage` | Contains the assistant's transcript and metadata |

<Note>
This event fires when the LLM response completes, when the user interrupts, or
when a user image is appended to context. The event always fires when a turn
ends, even if `content` is empty (e.g., the turn was interrupted before any
tokens were generated).
This event fires when the LLM response completes, when the user interrupts,
when a user image is appended to context, or when a
`TTSSpeakFrame(append_to_context=True)` greeting finishes. The event always
fires when a turn ends, even if `content` is empty (e.g., the turn was
interrupted before any tokens were generated).
</Note>

### on_assistant_thought
Expand Down
7 changes: 7 additions & 0 deletions pipecat/learn/text-to-speech.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,13 @@ await tts.queue_frame(

The `append_to_context` parameter controls whether the spoken text is added to the conversation history. When `append_to_context=True`, the text is automatically committed to the context after being spoken, making it useful for bot greetings and injected speech that should be part of the conversation flow.

<Note>
When using `append_to_context=True`, the assistant aggregator's
`on_assistant_turn_started` and `on_assistant_turn_stopped` events will fire,
allowing you to capture the greeting text in your turn event handlers just like
LLM-generated responses. See [Turn Events](/api-reference/server/utilities/turn-management/turn-events) for details.
</Note>

### Dynamic Settings Updates

Update TTS settings during conversation using typed settings objects:
Expand Down
Loading