RagDocs

Ragdocs

Ragdocs ist eine hochmoderne Open-Source-Lösung, die revolutioniert, wie Sie mit Dokumentation interagieren. Durch die Kombination der Befugnis lokaler LLMs mit hochmodernen Abrufgeneration (RAG) können Entwickler sofort genaue Antworten aus ihrer Dokumentation ohne API-Kosten erhalten.

Verabschieden Sie sich von teuren API -Anrufen und Datenschutzbedenken. Mit Ragdocs bleibt Ihre gesamte Dokumentation privat und bietet Chatgpt-ähnliche Interaktionen. Es wurde mit Milvus Vectorsuche und Next.js erstellt und ist produktionsbereit und einfach zu bereitstellen. Erleben Sie die Zukunft der Dokumentationssuche mit vollständiger Datenschutz und ohne Nutzungsgebühren.

Rag.demo.1.mp4

? Merkmale

• ? Intelligente Chat -Schnittstelle : Konversationsschnittstelle, die auf technische Dokumentation zugeschnitten sind.
• ? Hochgeschädigte Abrufer Generation : Genauige und kontextbewusste Antworten.
• ? Lokale LLM -Unterstützung : Integriert in Ollama für Privatsphäre und Effizienz.
• Vektorsuche von Milvus betrieben : Schnelles und skalierbares Dokumentabfrage.
• Modern Next.js Frontend : Schlanke Echtzeit-Benutzererfahrung.
• Support für Multi-Dokument : nahtloser Umgang mit verschiedenen technischen Stapeln.
• ⚡ Schnelle Dokumentenverarbeitung : Effiziente Einnahme und Analyse von Aktualisierungen.
• Inkrementelle Updates : Halten Sie Ihre Dokumentation mühelos synchronisiert.

---

Architektur

 ragdocs/
├── data/                         # Documentation storage
│   ├── milvus_docs/              # Milvus documentation
│   ├── qdrant_docs/              # Qdrant documentation
│   └── weaviate_docs/            # Weaviate documentation
├── milvus/                       # Milvus standalone setup
│   └── standalone_embed.sh       # Milvus standalone script
├── ragdocs_api/                  # FastAPI backend
│   ├── conversation_api.py       # Chat API endpoints
│   ├── file_tracker.py           # Document change tracking
│   ├── llm_provider.py           # LLM integration (Ollama)
│   ├── markdown_processor.py     # Markdown processing
│   └── rag_system.py             # Core RAG implementation
└── ragdocs_frontend/             # Next.js frontend
    └── src/                      # Frontend source code

---

Erste Schritte

Voraussetzungen

• Python 3.12+
• Node.js 20.17.0
• Milvus 2.0+
• Ollama (für lokale LLM -Unterstützung)

Installieren Sie Node.js mit NVM :

nvm install 20.17.0
nvm use 20.17.0

---

Installation

1. Klonen Sie das Repository :

git clone https://github.com/AlexisBalayre/RagDocs.git
cd RagDocs

2. Installieren Sie Python -Abhängigkeiten :

 # Install poetry if not already installed
curl -sSL https://install.python-poetry.org | python3 -

# Install project dependencies
poetry install
poetry shell

Schlüsselabhängigkeiten:

• Lama-Index: 0.11.22
• Fastapi: 0.115.4
• Milvus-Lite: 2.4.10
• Satztransformer: 2.7.0
• Fackel: 2.5.1

3. Installieren Sie Frontend -Abhängigkeiten :

 cd ragdocs_frontend
yarn

4. Umgebungsvariablen einrichten :

cp example.env.local .env.local
# Edit .env.local with your configuration

5. Starten Sie Milvus :

 cd milvus
bash standalone_embed.sh start

6. Führen Sie das Backend aus :

poetry run uvicorn ragdocs_api.conversation_api:app --reload

7. Führen Sie die Frontend aus :

 cd ragdocs_frontend
yarn dev

---

Verwendung

1. Dokumentation hinzufügen : Platzieren Sie Dateien in den jeweiligen Ordnern unter data/ .
2. Beginnen Sie mit Chat : Verwenden Sie das Frontend, um mit Ihrer Dokumentation zu chatten und zu erkunden.
3. Vergleichen Sie Tech Stacks : Nutzen Sie integrierte Vergleichsfunktionen für die Analyse.

---

? Konfiguration

Bearbeiten Sie die .env.local -Datei für Schlüsseleinstellungen:

 MILVUS_HOST = localhost
MILVUS_PORT = 19530
OLLAMA_MODEL = llama3.2 

---

? Beitragen

Beiträge werden gefördert! Folgen Sie folgenden Schritten:

1. Geben Sie das Repository auf.
2. Erstellen Sie einen Feature -Zweig:

git checkout -b feature/AmazingFeature

3. Begehen Sie Ihre Änderungen:

git commit -m ' Add some AmazingFeature '

4. Drücken Sie Ihren Zweig:

git push origin feature/AmazingFeature

5. Öffnen Sie eine Pull -Anfrage.

---

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert. Weitere Informationen finden Sie in der Lizenzdatei.

---

Anerkennung

• Vercel ai Chatbot - Vorlage Inspiration für das Frontend.
• Llamaindex - Antrieb Lag -Fähigkeiten.
• Milvus - Effizienter Vektorsuche Backend.
• Ollama - Lokale LLM -Unterstützung.

---

Unterstützung

Wenn dieses Projekt Ihrer Arbeit einen Mehrwert verleiht, geben Sie ihm bitte einen Stern!

Ihre Unterstützung macht einen Unterschied und fördert die Weiterentwicklung. Feedback- und Feature -Vorschläge sind immer willkommen!