ragflow
ragflow copied to clipboard
[Feature Request]: Outline KB integration (getoutline.com)
Is there an existing issue for the same feature request?
- [X] I have checked the existing issues.
Is your feature request related to a problem?
Yes. Currently, RAGFlow’s knowledge bases are limited to file uploads, which restricts the ability to integrate dynamic, structured data from external platforms (e.g., Outline, BookStack, Docmost, etc.). This creates friction for users who want to unify their workflows with live or collaboratively updated knowledge bases.
Describe the feature you'd like
I’d like to suggest RAGFlow support integration with external knowledge bases, starting with platforms like Outline. This would enable users to connect their external KBs directly to RAGFlow, providing real-time access to structured data for retrieval-augmented generation.
Key capabilities
- Sync structured data (e.g., collections, documents, pages) from external APIs.
- Enable real-time updates via webhooks or polling mechanisms.
- Allow users to manage and prioritise multiple knowledge base connections within RAGFlow.
Describe implementation you've considered
- API integration: Begin with Outline’s RPC-style API and OpenAPI specification to fetch and sync content. Extend to other platforms like BookStack and Docmost using their respective APIs.
- Incremental Syncs: Implement webhook-based incremental updates or scheduled polling to ensure live data remains accessible.
- Data structuring: Map external knowledge base structures (e.g., Collections/Documents in Outline, Books/Pages in BookStack) to RAGFlow’s knowledge base model.
- Authentication: Use API keys.
Documentation, adoption, use case
Scenarios:
- Dynamic knowledge updates: A team using Outline, Docmost or BookStack to manage evolving documentation can sync their collections/pages with RAGFlow, ensuring generated responses reflect the most current information.
- Collaborative KBs: Teams working on shared knowledge bases like Outline, Docmost, BookStack, etc., can integrate directly into RAGFlow for enhanced querying, summarisation, and retrieval.
- Hybrid workflows: Organisations combining file-based and live knowledge systems can centralise their workflows by integrating these platforms with RAGFlow.
Example Workflow:
1. User connects an external knowledge base (e.g., Outline) by providing API credentials.
2. RAGFlow fetches and indexes the content for retrieval.
3. Subsequent updates in the external platform trigger real-time syncs or periodic updates in RAGFlow.
Additional information
I'd like this too.
@fullstackdesign-xyz 👋 Thanks a lot for your suggestion, and sorry for the delayed response!
Your idea about supporting external knowledge bases like Outline really gave us something to think about 💡. While this isn’t currently supported in our product, we’ll be evaluating the potential of adding APIs for this kind of integration in the future.
Stay tuned for updates, and feel free to share more constructive feedback anytime — it’s always appreciated! 🙏🚀
Hi guys, I wrote a simple script ragflow-sync, on the base of the excellent outline wiki api wrapper called outline-python-api. You can used this as a temporary solution.
Also, please consider add this to ragflow. @which-W
@metorm Got it. Can't promise that we will integrate outline, but we do plan to integrate S3, Google Drive, etc.