Minima: open source RAG container supporting local deployment or integration to ChatGPT, Claude

General Introduction

Minima is an open source RAG (Retrieval-Augmented Generation) solution that supports both local deployment and integration with the ChatGPT Integration. This program is maintained by dmayboroda and is designed to provide a flexible and independent RAG Minima offers three modes of operation: a fully isolated local installation, a hybrid mode with ChatGPT integration, and a mode with full dependency on external services. The goal of the project is to provide users with an efficient, scalable and easy-to-use RAG solution.

The project is deployed using Docker and supports indexing and querying of multiple file formats, including PDF, XLS, DOCX, TXT, MD, and CSV.Minima is released under the Mozilla Public License v2.0 (MPLv2), which ensures that users have the freedom to use and modify the code.

Function List

• Local Document Dialog: Talk to local files by way of local installation.
• Customized GPT modes: Queries local files using a custom GPT model.
• Multi-file format support: Supports indexing and querying of PDF, XLS, DOCX, TXT, MD and CSV files.
• Docker Deployment: Rapid deployment and management via Docker.
• Environment variable configuration: Configure environment variables through the .env file to flexibly set file paths and model parameters.
• recursive index: Supports recursive indexing of all subfolders and files within a folder.

Using Help

Installation process

1. clone warehouse::

   git clone https://github.com/dmayboroda/minima.git
cd minima

2. Building and running containers::

   docker-compose up --build

3. configuration file: Modify as necessary config.yml file to configure native or integrated mode.

Guidelines for use

local mode

1. Starting services::

   docker-compose up

2. access interface: Open in browser http://localhost:9001The Minima local interface can be accessed by clicking on the following link.

Integrated Mode

1. Configuring ChatGPT: in config.yml Add ChatGPT's API key and related configuration in the
2. Starting services::

   docker-compose up

3. access interface: Open in browser http://localhost:9001The Minima interface, which integrates ChatGPT, can be accessed.

Detailed Function Operation

• Query Generation: Send a query request through the API interface and Minima will process it in either local or integrated mode depending on the configuration and return the generated results.
• configuration management: by modifying the config.yml file, you can flexibly adjust Minima's operating modes and parameters.
• Log View: All operation logs are stored in the logs directory, which can be viewed and analyzed by the user at any time.

common problems

• Unable to start container: Check that Docker and Docker Compose are installed correctly and that the ports are not occupied.
• API request failed: Acknowledgement config.yml Configured correctly, especially the API key and endpoint address.