Skip to content

docs: Add Conversational Flows (self.ask) documentation#5220

Open
iris-clawd wants to merge 6 commits intomainfrom
docs/conversational-flows-self-ask
Open

docs: Add Conversational Flows (self.ask) documentation#5220
iris-clawd wants to merge 6 commits intomainfrom
docs/conversational-flows-self-ask

Conversation

@iris-clawd
Copy link
Copy Markdown
Contributor

@iris-clawd iris-clawd commented Apr 1, 2026

Summary

Adds a new Conversational Flows (User Input) section to the Flows documentation, covering the self.ask() feature for inline user input during flow execution.

What's covered

  • Basic usage — simple single-ask example
  • Multiple asks — gathering several inputs in one method
  • Timeout supporttimeout= parameter, None on expiry, retry loop pattern
  • Metadata support — bidirectional context passing between flow and provider
  • Custom InputProvider — protocol for Slack/webhook/web UI integrations with full example
  • Auto-checkpoint behavior — state persistence before each ask
  • Comparison tableself.ask() vs @human_feedback (when to use which)
  • Coexistence note — both features work together in the same flow

Placement

Inserted immediately before the existing "Human in the Loop (human feedback)" section to keep the two HITL-related features adjacent.

API

def ask(self, message: str, timeout: float | None = None, metadata: dict[str, Any] | None = None) -> str | None

Note

Low Risk
Low risk: changes are limited to documentation content and a CI workflow adjustment; the main risk is the broken-link check failing if the Mintlify CLI/environment assumptions are off.

Overview
Adds a new Conversational Flows (User Input) section to docs/en/concepts/flows.mdx, documenting self.ask() with examples for multiple prompts, timeouts/retries, metadata, custom InputProviders, auto-checkpointing, and a comparison to @human_feedback.

Updates the docs broken-link GitHub Action to watch docs/docs.json (instead of docs.json) and to run the link checker via the newer mint CLI, including installing libsecret-1-0 to satisfy runtime dependencies.

Written by Cursor Bugbot for commit f789cf8. This will update automatically on new commits. Configure here.

@github-actions github-actions bot added the size/M label Apr 1, 2026
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 1, 2026

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

Project Status Preview Updated (UTC)
crewai 🟢 Ready View Preview Apr 1, 2026, 9:21 PM

iris-clawd and others added 6 commits April 2, 2026 13:14
Add comprehensive documentation for the self.ask() feature covering:
- Basic usage and API
- Multiple asks in a single method
- Timeout support with retry pattern
- Bidirectional metadata support
- Custom InputProvider protocol (Slack example)
- Auto-checkpoint behavior with persistence
- Comparison table: self.ask() vs @human_feedback
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants