paceyw/ragflow: RAGFlow is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. · GitHub

English | 简体中文 | 日本語 | 한국어

• 💡 What is RAGFlow?
• 🎮 Demo
• 📌 Latest Updates
• 🌟 Key Features
• 🔎 System Architecture
• 🎬 Get Started
• 🔧 Configurations
• 🛠️ Build RAGFlow image
• 🛠️ Launch service from source for development
• 📚 Documentation
• 📜 Roadmap
• 🏄 Community
• 🙌 Contributing

RAGFlow is an open-source RAG (Retrieval-Augmented Generation) engine based on deep document understanding. It offers a streamlined RAG workflow for businesses of any scale, combining LLM (Large Language Models) to provide truthful question-answering capabilities, backed by well-founded citations from various complex formatted data.

Try our demo at https://demo.ragflow.io.

• 2024-09-13 Adds search mode for knowledge base Q&A.
• 2024-09-09 Adds a medical consultant agent template.
• 2024-08-22 Support text to SQL statements through RAG.
• 2024-08-02 Supports GraphRAG inspired by graphrag and mind map.
• 2024-07-23 Supports audio file parsing.
• 2024-07-08 Supports workflow based on Graph.
• 2024-06-27 Supports Markdown and Docx in the Q&A parsing method, extracting images from Docx files, extracting tables from Markdown files.
• 2024-05-23 Supports RAPTOR for better text retrieval.

• Deep document understanding-based knowledge extraction from unstructured data with complicated formats.
• Finds "needle in a data haystack" of literally unlimited tokens.

• Intelligent and explainable.
• Plenty of template options to choose from.

• Visualization of text chunking to allow human intervention.
• Quick view of the key references and traceable citations to support grounded answers.

• Supports Word, slides, excel, txt, images, scanned copies, structured data, web pages, and more.

• Streamlined RAG orchestration catered to both personal and large businesses.
• Configurable LLMs as well as embedding models.
• Multiple recall paired with fused re-ranking.
• Intuitive APIs for seamless integration with business.

• CPU >= 4 cores
• RAM >= 16 GB
• Disk >= 50 GB
• Docker >= 24.0.0 & Docker Compose >= v2.26.1

  If you have not installed Docker on your local machine (Windows, Mac, or Linux), see Install Docker Engine.

1. Ensure vm.max_map_count >= 262144:

   To check the value of vm.max_map_count:

   $ sysctl vm.max_map_count

   Reset vm.max_map_count to a value at least 262144 if it is not.

   # In this case, we set it to 262144:
   $ sudo sysctl -w vm.max_map_count=262144

   This change will be reset after a system reboot. To ensure your change remains permanent, add or update the vm.max_map_count value in /etc/sysctl.conf accordingly:

   vm.max_map_count=262144

2. Clone the repo:

   $ git clone https://github.com/infiniflow/ragflow.git

3. Build the pre-built Docker images and start up the server:

   Running the following commands automatically downloads the dev version RAGFlow Docker image. To download and run a specified Docker version, update RAGFLOW_VERSION in docker/.env to the intended version, for example RAGFLOW_VERSION=v0.11.0, before running the following commands.

   $ cd ragflow/docker
   $ docker compose up -d

   The core image is about 9 GB in size and may take a while to load.

4. Check the server status after having the server up and running:

   $ docker logs -f ragflow-server

   The following output confirms a successful launch of the system:

       ____                 ______ __
      / __ \ ____ _ ____ _ / ____// /____  _      __
     / /_/ // __ `// __ `// /_   / // __ \| | /| / /
    / _, _// /_/ // /_/ // __/  / // /_/ /| |/ |/ /
   /_/ |_| \__,_/ \__, //_/    /_/ \____/ |__/|__/
                 /____/
   
    * Running on all addresses (0.0.0.0)
    * Running on http://127.0.0.1:9380
    * Running on http://x.x.x.x:9380
    INFO:werkzeug:Press CTRL+C to quit

   If you skip this confirmation step and directly log in to RAGFlow, your browser may prompt a network abnormal error because, at that moment, your RAGFlow may not be fully initialized.

5. In your web browser, enter the IP address of your server and log in to RAGFlow.

   With the default settings, you only need to enter http://IP_OF_YOUR_MACHINE (sans port number) as the default HTTP serving port 80 can be omitted when using the default configurations.

6. In service_conf.yaml, select the desired LLM factory in user_default_llm and update the API_KEY field with the corresponding API key.

   See llm_api_key_setup for more information.

   The show is now on!

When it comes to system configurations, you will need to manage the following files:

• .env: Keeps the fundamental setups for the system, such as SVR_HTTP_PORT, MYSQL_PASSWORD, and MINIO_PASSWORD.
• service_conf.yaml: Configures the back-end services.
• docker-compose.yml: The system relies on docker-compose.yml to start up.

You must ensure that changes to the .env file are in line with what are in the service_conf.yaml file.

The ./docker/README file provides a detailed description of the environment settings and service configurations, and you are REQUIRED to ensure that all environment settings listed in the ./docker/README file are aligned with the corresponding configurations in the service_conf.yaml file.

To update the default HTTP serving port (80), go to docker-compose.yml and change 80:80 to <YOUR_SERVING_PORT>:80.

Updates to the above configurations require a reboot of all containers to take effect:

$ docker-compose -f docker/docker-compose.yml up -d

To build the Docker images from source:

$ git clone https://github.com/infiniflow/ragflow.git
$ cd ragflow/
$ docker build -f Dockerfile.scratch -t infiniflow/ragflow:dev .

To launch the service from source:

1. Clone the repository:

   $ git clone https://github.com/infiniflow/ragflow.git
   $ cd ragflow/

2. Install all python dependencies in a newly created virtual environment named .venv:

   $ curl -sSL https://install.python-poetry.org | python3 -
   $ $HOME/.local/bin/poetry install --sync --no-root

3. Copy the entry script and configure environment variables:

   # Adjust configurations according to your actual situation (the following two export commands are newly added):
   # - Comment out `LD_LIBRARY_PATH`, if it is configured.
   # - Optional: Add Hugging Face mirror.
   source ~/.venv/bin/activate
   export PYTHONPATH=$(pwd)
   export HF_ENDPOINT=https://hf-mirror.com

4. Launch the third-party services (MinIO, Elasticsearch, Redis, and MySQL):

   $ docker compose -f docker/docker-compose-base.yml up -d

5. Adjust configurations Add the following line to /etc/hosts to resolve all hosts in docker/service_conf.yaml to 127.0.0.1:

   127.0.0.1       es01 mysql minio redis
   

   Edit docker/service_conf.yaml to change mysql port to 5455 and es port to 1200, as specified in docker/.env.

6. Launch the RAGFlow backend service: Comment out the nginx line in docker/entrypoint.sh and run the script:

   $ bash docker/entrypoint.sh

7. Launch the frontend service:

   $ cd web
   $ npm install --force
   $ vim .umirc.ts
   # Update proxy.target to http://127.0.0.1:9380
   $ npm run dev 

8. In your web browser, enter http://127.0.0.1/.

• Quickstart
• User guide
• References
• FAQ

See the RAGFlow Roadmap 2024

• Discord
• Twitter
• GitHub Discussions

RAGFlow flourishes via open-source collaboration. In this spirit, we embrace diverse contributions from the community. If you would like to be a part, review our Contribution Guidelines first.