Allgemeine Einführung
Minima ist eine quelloffene RAG-Lösung (Retrieval-Augmented Generation), die sowohl den lokalen Einsatz als auch die Integration mit dem ChatGPT Integration. Dieses Projekt wird von dmayboroda betreut und soll eine flexible und unabhängige RAG Minima bietet drei Betriebsmodi: eine vollständig isolierte lokale Installation, einen Hybridmodus mit ChatGPT-Integration und einen Modus mit vollständiger Abhängigkeit von externen Diensten. Das Ziel des Projekts ist es, den Nutzern eine effiziente, skalierbare und einfach zu bedienende RAG-Lösung zur Verfügung zu stellen.
Das Projekt wird mit Docker bereitgestellt und unterstützt die Indizierung und Abfrage einer breiten Palette von Dateiformaten, darunter PDF, XLS, DOCX, TXT, MD und CSV. Minima wird unter der Mozilla Public Licence v2.0 (MPLv2) veröffentlicht, die sicherstellt, dass die Benutzer den Code nach eigenem Ermessen verwenden und verändern können.
Funktionsliste
- Dialog über lokale DokumenteDialog mit lokalen Dateien über die lokale Installation.
- Benutzerdefinierte GPT-ModiAbfrage lokaler Dateien unter Verwendung eines benutzerdefinierten GPT-Modells.
- Unterstützung mehrerer DateiformateUnterstützt die Indizierung und Abfrage von PDF-, XLS-, DOCX-, TXT-, MD- und CSV-Dateien.
- Docker-BereitstellungSchnelle Bereitstellung und Verwaltung über Docker.
- Konfiguration der UmgebungsvariablenKonfigurieren Sie Umgebungsvariablen über die .env-Datei, um Dateipfade und Modellparameter flexibel festzulegen.
- rekursiver IndexUnterstützt die rekursive Indizierung aller Unterordner und Dateien innerhalb eines Ordners.
Hilfe verwenden
Ablauf der Installation
- Klon-Lager::
git clone https://github.com/dmayboroda/minima.git
cd minima
- Aufbau und Betrieb von Containern::
docker-compose up --build
- KonfigurationsdateiÄndern nach Bedarf
config.yml
Datei, um den nativen oder integrierten Modus zu konfigurieren.
Richtlinien für die Verwendung
Lokalbetrieb
- Neue Dienste::
docker-compose aufwärts
- ZugangsschnittstelleIm Browser öffnen
http://localhost:9001
Sie können auf die lokale Schnittstelle von Minima zugreifen.
Integrierter Modus
- ChatGPT konfigurieren: in
config.yml
Fügen Sie den ChatGPT-API-Schlüssel und die zugehörige Konfiguration zum - Neue Dienste::
docker-compose aufwärts
- ZugangsschnittstelleIm Browser öffnen
http://localhost:9001
Die Minima-Schnittstelle, in die ChatGPT integriert ist, kann aufgerufen werden.
Detaillierte Funktionsweise
- Generierung von AbfragenSenden Sie eine Abfrage über die API-Schnittstelle und Minima wird sie je nach Konfiguration entweder im lokalen oder im integrierten Modus verarbeiten und die generierten Ergebnisse zurückgeben.
- Konfigurationsmanagement: durch Änderung der
config.yml
Datei können Sie die Betriebsarten und Parameter von Minima flexibel anpassen. - Log-AnsichtAlle Betriebsprotokolle werden in der Datei
Protokolle
die vom Nutzer jederzeit eingesehen und ausgewertet werden können.
allgemeine Probleme
- Container kann nicht gestartet werdenÜberprüfen Sie, ob Docker und Docker Compose korrekt installiert sind und ob die Ports nicht belegt sind.
- API-Anforderung fehlgeschlagenBestätigung
config.yml
Richtig konfiguriert, insbesondere der API-Schlüssel und die Endpunktadresse.