Skip to content

docs: update for pipecat PR #5625 (eager end-of-turn) - #1280

Merged
markbackman merged 2 commits into
mainfrom
docs/pr-5625
Sep 11, 2026
Merged

docs: update for pipecat PR #5625 (eager end-of-turn)#1280
markbackman merged 2 commits into
mainfrom
docs/pr-5625

Conversation

@pipecat-docs-bot

Copy link
Copy Markdown

Automated documentation update for pipecat PR #5625.

Changes

Frame Documentation

  • api-reference/server/frames/data-frames.mdx: Added EagerTranscriptionFrame documentation — transcript of a turn a service predicts has ended before committing
  • api-reference/server/frames/system-frames.mdx:
    • Added EagerEndOfTurnCancelFrame documentation — frame withdrawing an eager end of turn
    • Updated UserStoppedSpeakingFrame description to mention SpeculationGate
  • api-reference/server/frames/llm-frames.mdx: Added speculation parameter to LLMContextFrame — marks inference as speculative
  • api-reference/server/frames/control-frames.mdx: Added skip_tts parameter documentation to LLMFullResponseStartFrame and LLMFullResponseEndFrame

STT Service Documentation

  • api-reference/server/services/stt/deepgram.mdx:
    • Added enable_eager_end_of_turn parameter to DeepgramFluxSTTService and DeepgramFluxSageMakerSTTService
    • Updated Notes section to explain eager end-of-turn behavior and behavior change (no longer pushes eager transcripts as InterimTranscriptionFrame)
    • Updated event handler table to note that on_eager_end_of_turn and on_turn_resumed are only emitted when enable_eager_end_of_turn is enabled
  • api-reference/server/services/stt/cartesia.mdx:
    • Added enable_eager_end_of_turn parameter to CartesiaTurnsSTTService
    • Updated Notes section to explain eager end-of-turn behavior
    • Updated event handler table to note that on_turn_eager_end and on_turn_resume are only emitted when enable_eager_end_of_turn is enabled

Turn Management Documentation

  • api-reference/server/utilities/turn-management/user-turn-strategies.mdx: Added EagerUserTurnStrategies documentation — strategies for services that predict end of turn before committing, with parameters for match policy, speculation timeout, and interruptions
  • api-reference/server/utilities/turn-management/turn-events.mdx: Updated on_user_turn_inference_triggered event documentation to include the new speculation parameter when the event is registered on UserTurnController (handlers on LLMUserAggregator and UserTurnProcessor remain unchanged)

Gaps identified

None

- Add EagerTranscriptionFrame and EagerEndOfTurnCancelFrame to frames documentation
- Add speculation parameter to LLMContextFrame
- Add skip_tts parameter to LLMFullResponseStartFrame and LLMFullResponseEndFrame
- Add enable_eager_end_of_turn parameter to DeepgramFluxSTTService, DeepgramFluxSageMakerSTTService, and CartesiaTurnsSTTService
- Update STT service event handlers and notes for eager end-of-turn behavior
- Add EagerUserTurnStrategies documentation
- Update on_user_turn_inference_triggered event signature with speculation parameter
@pipecat-docs-bot pipecat-docs-bot Bot added auto-docs Automated documentation update from pipecat source changes pipecat labels Sep 10, 2026
@github-actions

Copy link
Copy Markdown
Contributor

🔍 Mintlify preview for this branch: https://daily-docs-pr-5625.mintlify.site

@github-actions

Copy link
Copy Markdown
Contributor

Broken links detected!

Please check the workflow logs for details on which links are broken and fix them before merging.

1 similar comment
@github-actions

Copy link
Copy Markdown
Contributor

Broken links detected!

Please check the workflow logs for details on which links are broken and fix them before merging.

@markbackman
markbackman merged commit 1652237 into main Sep 11, 2026
4 of 6 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Broken links detected!

Please check the workflow logs for details on which links are broken and fix them before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes pipecat

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants