Assorted updates to Pipecat Flows docs#263
Merged
Merged
Conversation
- Add `name` to `NodeConfig` - Pass initial node into `initialize()` for dynamic flows - Deprecate `set_node()` in favor of `set_node_from_config()` Note that I didn't yet updates calls to `set_node()` from within `transition_callback`s—in an upcoming change we'll move away from `transition_callback` and `transition_to` altogether.
kompfner
force-pushed
the
pk/assorted-updates
branch
from
8e9ba80 to
a964da6
Compare
…stead of `transition_to` and `transition_callback`
kompfner
force-pushed
the
pk/assorted-updates
branch
3 times, most recently
from
721b6dc to
a910983
Compare
…unctionSchema` or function configuration dict (instead, metadata are automatically extracted from a combination of the function signature and docstring)
kompfner
force-pushed
the
pk/assorted-updates
branch
from
a910983 to
708c131
Compare
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request introduces assorted documentation updates and API adjustments for Pipecat Flows. Key changes include new deprecation warnings and guidance for legacy properties, updated function signatures and return types for improved clarity, and a shift from using set_node to set_node_from_config for node configuration.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| server/frameworks/flows/pipecat-flows.mdx | Updated documentation blocks with deprecation warnings and API usage notes |
| guides/features/pipecat-flows.mdx | Revised code examples and narrative to reflect new function signatures and configuration patterns |
Comments suppressed due to low confidence (3)
server/frameworks/flows/pipecat-flows.mdx:313
- [nitpick] The deprecation warning for the 'transition_to' field is clear, but consider adding a link to a migration or upgrade guide to help users transition to the new API.
</Warning>
server/frameworks/flows/pipecat-flows.mdx:677
- The inline comment suggests that a NodeConfig should be returned for dynamic flows, yet the function signature indicates a string. Please clarify the expected return type for consistency in the examples.
return None, "target_node" # Return NodeConfig instead of str for dynamic flows
markbackman
approved these changes
Jun 26, 2025
Contributor
markbackman
left a comment
markbackman
left a comment
There was a problem hiding this comment.
Really nice update 🙌
Thanks for cleaning up parts of the guide section, too.
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
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.
Depends on pipecat-ai/pipecat-flows#141 and pipecat-ai/pipecat-flows#142 being published first.