-
Notifications
You must be signed in to change notification settings - Fork 8
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.
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
Add Flows start_callback docs #140
base: main
Are you sure you want to change the base?
Conversation
|
||
Start callbacks execute before a function is called, allowing you to: | ||
|
||
- Provide immediate feedback while long-running operations complete |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These 3 bullet points sound kind of same-ish to me, like they're just paraphrasing (like I just did with this feedback whoops haha)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same feedback applies to where these bullets appear again
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated.
guides/features/pipecat-flows.mdx
Outdated
A function's behavior is determined by its properties: | ||
|
||
- `handler` only: Process data, stay in current state | ||
- `transition_to` (static flow) or `transition_callback` (dynamic flow) only: Pure transition to next state | ||
- Both: Process data, then transition | ||
- `start_callback` only or combined with others: Provide immediate feedback before execution |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we sure you can provide start_callback
by itself? Or does it need to piggyback on a provided handler
? It kind of doesn't make much conceptual sense (to me) on its own...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suppose it's possible but unlikely.
When there's no handler, it's likely an edge function and just transitioning, which shouldn't require a start_callback. But, it's possible 🤷.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm just going to drop the only/combined part.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
Docs for: pipecat-ai/pipecat-flows#101