docs: update for pipecat PR #4665#880
Open
markbackman wants to merge 1 commit into
Open
Conversation
- Add append_to_context parameter to TTSStartedFrame documentation - Clarify that assistant turn events work for TTSSpeakFrame utterances - Document that on_assistant_turn_started fires when TTS begins for TTSSpeakFrame
markbackman
added
auto-docs
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated documentation update for pipecat PR #4665.
Changes
api-reference/server/frames/control-frames.mdx
append_to_contextparameter toTTSStartedFramedocumentationTrue) that determines whether the spoken text will be appended to the LLM contextTrue, the assistant aggregator tracks this as an assistant turn and fires turn eventsapi-reference/server/utilities/turn-management/turn-events.mdx
on_assistant_turn_startedclarifying it fires for both LLM responses andTTSSpeakFrameutteranceson_assistant_turn_stoppedto explicitly mention that it fires for both LLM responses andTTSSpeakFrameutterancesTTSSpeakFrameutterances, the start event now fires when TTS begins speaking (improvement from the bug fix)Context
PR #4665 fixed interruption handling for standalone
TTSSpeakFrame(append_to_context=True)utterances. Previously:on_assistant_turn_stoppeddidn't fire when these utterances were interruptedon_assistant_turn_startedfired at the end rather than the startThe fix adds an
append_to_contextfield toTTSStartedFrameand uses it to properly track assistant turns for TTS-driven utterances.Gaps identified
None - the changes only affect internal frame types and turn management behavior. All relevant documentation has been updated.