docs: add friendlier messages for optional dependency import checks

[jordanrfrazier]

Add friendlier messages for optional dependency import checks, to help direct users to documentation to install optional dependencies.

Summary by CodeRabbit

• Bug Fixes

  • Improved error messages for missing optional dependencies across various features, providing clearer installation instructions and guidance to consult documentation.
  • Enhanced user guidance when required packages for voice mode, Docling, NVIDIA ingest, Cassandra, Clickhouse, Couchbase, and PGVector are not installed.

• Documentation

  • Updated user-facing error messages to clarify which features require optional dependencies and how to install them.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This change updates ImportError messages across several modules to clarify that certain dependencies are optional. The new messages provide explicit installation instructions using uv pip install 'langflow[<dependency>]' and suggest consulting the documentation. In one case, error handling is added for a missing dependency, but no public API or logic is changed.

Changes

File(s)	Change Summary
voice_mode.py	Wrapped webrtcvad import in try-except; added detailed ImportError with install instructions for missing dependency.
docling_inline.py	Updated ImportError message for missing Docling dependency to clarify optional status and installation steps.
nvidia_ingest.py	Updated ImportError messages for NVIDIA Retriever Extraction (nv-ingest) dependencies to clarify optional status.
vectorstores/cassandra.py, vectorstores/cassandra_graph.py	Updated ImportError messages for missing cassio dependency to clarify optional status and installation instructions.
vectorstores/clickhouse.py, vectorstores/couchbase.py	Updated ImportError messages for Clickhouse and Couchbase dependencies to clarify optional status and installation steps.
vectorstores/pgvector.py	Added try-except for PGVector import with clear ImportError message for missing optional dependency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LangflowComponent
    participant DependencyManager

    User->>LangflowComponent: Use feature requiring optional dependency
    LangflowComponent->>DependencyManager: Attempt to import optional dependency
    alt Dependency present
        DependencyManager-->>LangflowComponent: Import succeeds
        LangflowComponent-->>User: Feature works as expected
    else Dependency missing
        DependencyManager-->>LangflowComponent: ImportError raised
        LangflowComponent-->>User: Raises ImportError with install instructions
    end

Loading

Possibly related PRs

• refactor: remove conditional voice mode support from backend and frontend #8597: Refactors voice_mode.py to defer and robustly handle webrtcvad imports, directly related to changes in import error handling for optional dependencies.

Suggested labels

size:S, lgtm, refactor

Suggested reviewers

• edwinjosechittilappilly

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch friendlier-dep-error-messages

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.