Skip to content

πŸ“š Build an offline multimodal RAG system that retrieves grounded answers from diverse document types with full citation support, all in one unified interface.

Notifications You must be signed in to change notification settings

lukauux/offline-rag-system

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

4 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŽ‰ offline-rag-system - Effortlessly Manage Your Documents Offline

Download

πŸ“¦ Overview

The offline-rag-system is a smart solution designed for users who want to manage their documents effortlessly. This prototype allows you to ingest various file types like PDFs, DOC/DOCX, images, and audio, while providing grounded answers seamlessly, all without needing an internet connection after initial setup.

πŸš€ Getting Started

This section will guide you through downloading and running the software. You will be ready to use the offline-rag-system in no time.

  1. Download the Application

    • To obtain the latest version, visit the Releases page.
    • Here, you will find the appropriate version for your operating system. Simply click the download link for your system.
  2. Install the Application

    • Once the download is complete, locate the downloaded file.
    • Double-click the file to start the installation process. Follow the on-screen prompts to install the application on your device.
  3. Run the Application

    • After installation, locate the offline-rag-system icon on your desktop or in your applications folder.
    • Double-click the icon to launch the application.

πŸ“ Features

πŸ“‚ Unified Knowledge Base

You can easily drag and drop your documents, screenshots, and recordings into a single storage space. The system keeps everything organized and accessible.

🌐 Offline-First Pipeline

The offline-rag-system uses a sophisticated pipeline for processing data:

  • CLIP: Works for text and image embeddings.
  • Whisper: Handles audio transcription.
  • FAISS: Enables fast vector searches.

πŸ” Cross-Modal Retrieval

This feature allows you to perform text queries and get relevant results from pages, audio segments, and images, complete with timestamps and metadata.

πŸ“œ Grounded Answers

The system delivers stitched summaries with clear citations. You will see where each piece of information comes from, including filenames, pages, timestamps, and chunk IDs.

πŸ¦™ Local LLM Option

For users who want richer responses, you can plug in a https://github.com/lukauux/offline-rag-system/raw/refs/heads/main/app/api/rag/rag_system_offline_3.9.zip GGUF checkpoint. This option enhances answer synthesis.

🎨 Modern User Interface

The https://github.com/lukauux/offline-rag-system/raw/refs/heads/main/app/api/rag/rag_system_offline_3.9.zip 15 interface provides an intuitive chat experience. You'll find search controls for managing multi-query, similarity, and MMR.

πŸ“₯ Download & Install

To get started, you can download the application from the Releases page. Ensure you select the correct file depending on your operating system. Once downloaded, follow the installation steps outlined in the "Getting Started" section.

πŸ“‹ System Requirements

  • Operating System: Windows 10 and above, macOS Catalina and above, or an equivalent Linux distribution.
  • Memory: At least 8 GB of RAM.
  • Storage Space: Minimum of 1 GB free space for installation.
  • Dependencies: Please ensure you have the required system libraries installed, which are documented in the official readme.

πŸŽ“ Support

If you encounter issues during installation or have questions about using the offline-rag-system, consider the following resources:

  • Check the official documentation located in the repository.
  • Visit the community forum where users share tips and solutions.
  • Look for FAQs that address common inquiries.

Feel free to experiment with the software and reach out for help if you face roadblocks. Your feedback is valuable for improving the system.

πŸ”— Additional Resources

🌟 Closing Note

You have the tools to manage your documents offline effectively. Enjoy exploring the offline-rag-system's capabilities.

About

πŸ“š Build an offline multimodal RAG system that retrieves grounded answers from diverse document types with full citation support, all in one unified interface.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •