Skip to content

docs: update for pipecat-flows PR #281#875

Open
markbackman wants to merge 1 commit into
mainfrom
docs/flows-pr-281
Open

docs: update for pipecat-flows PR #281#875
markbackman wants to merge 1 commit into
mainfrom
docs/flows-pr-281

Conversation

@markbackman
Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat-flows PR #281.

Changes

Updated API reference pages

  • api-reference/pipecat-flows/types.mdx
    • Added append_text_to_context parameter to ActionConfig with default value True
    • Updated text parameter description to clarify usage for both tts_say and end_conversation actions
    • Updated Built-in Action Types table to document the new parameter behavior

Updated guide pages

  • pipecat-flows/guides/actions.mdx

    • Added documentation and examples for append_text_to_context parameter in tts_say action
    • Added documentation and examples for append_text_to_context parameter in end_conversation action
  • pipecat-flows/guides/context-strategies.mdx

    • Added info box documenting that the initial flow node now follows its context strategy (default APPEND) instead of always replacing the context

Summary

These changes reflect two key improvements from PR #281:

  1. Context control for TTS actions: The built-in tts_say and end_conversation actions now support an append_text_to_context parameter (defaults to True), giving developers control over whether spoken text is added to the LLM context.

  2. Initial node context behavior: The initial flow node now respects its context strategy instead of always using RESET. With the default APPEND strategy, context written before the node's first inference (e.g., by a tts_say pre-action) is now preserved.

Gaps identified

None

Update documentation to reflect changes from pipecat-flows PR #281:

- Add append_text_to_context parameter to ActionConfig
- Document new parameter for tts_say and end_conversation actions
- Document initial node context strategy behavior change

These changes align with the new behavior where:
1. Built-in TTS actions now support controlling whether spoken text
   is appended to the LLM context (defaults to True)
2. Initial flow nodes now follow their context strategy instead of
   always replacing the context
@markbackman markbackman added auto-docs Automated documentation update from pipecat source changes flows labels Jun 5, 2026
@mintlify
Copy link
Copy Markdown

mintlify Bot commented Jun 5, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Pipecat 🟢 Ready View Preview Jun 5, 2026, 2:52 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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 flows

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant