RagDocs

Ragdocs

RagDocs adalah solusi sumber terbuka mutakhir yang merevolusi cara Anda berinteraksi dengan dokumentasi. Dengan menggabungkan kekuatan LLM lokal dengan generasi Pengambilan Pengambilan (RAG) yang canggih, pengembang dapat secara instan mendapatkan jawaban yang akurat dari dokumentasi mereka tanpa biaya API.

Ucapkan selamat tinggal pada panggilan API yang mahal dan masalah privasi. Dengan RagDocs , semua dokumentasi Anda tetap pribadi sambil memberikan interaksi seperti chatgpt. Dibangun dengan pencarian vektor Milvus dan Next.js, ini siap-produksi dan mudah digunakan. Rasakan masa depan pencarian dokumentasi dengan privasi data lengkap dan tanpa biaya penggunaan.

Rag.demo.1.mp4

? Fitur

• ? Antarmuka Obrolan Cerdas : Antarmuka percakapan yang disesuaikan untuk dokumentasi teknis.
• ? Generasi augmented augmented cutting-edge : respons yang akurat dan sadar konteks.
• ? Dukungan LLM Lokal : Terintegrasi dengan Ollama untuk privasi dan efisiensi.
• Pencarian Vektor Didukung oleh Milvus : Dokumen yang cepat dan dapat diskalakan kueri.
• Modern Next.js Frontend : Pengalaman pengguna yang ramping dan real-time.
• Dukungan Multi-Dokumen : Penanganan Tumpukan Teknologi Beragam.
• ⚡ Pemrosesan Dokumen Cepat : Konsumsi dan analisis pembaruan yang efisien.
• Pembaruan tambahan : Jaga agar dokumentasi Anda tetap dengan mudah.

---

Arsitektur

 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

---

Memulai

Prasyarat

• Python 3.12+
• Node.js 20.17.0
• Milvus 2.0+
• Ollama (untuk dukungan LLM lokal)

Instal Node.js dengan NVM :

nvm install 20.17.0
nvm use 20.17.0

---

Instalasi

1. Klon Repositori :

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

2. Pasang dependensi Python :

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

# Install project dependencies
poetry install
poetry shell

Ketergantungan kunci:

• llama-index: 0.11.22
• Fastapi: 0.115.4
• Milvus-Lite: 2.4.10
• Transformer kalimat: 2.7.0
• Obor: 2.5.1

3. Instal Dependencies Frontend :

 cd ragdocs_frontend
yarn

4. Mengatur variabel lingkungan :

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

5. Mulai Milvus :

 cd milvus
bash standalone_embed.sh start

6. Jalankan backend :

poetry run uvicorn ragdocs_api.conversation_api:app --reload

7. Jalankan frontend :

 cd ragdocs_frontend
yarn dev

---

Penggunaan

1. Tambahkan dokumentasi : Tempatkan file di folder masing -masing di bawah data/ .
2. Mulai mengobrol : Gunakan frontend untuk mengobrol dan jelajahi dokumentasi Anda.
3. Bandingkan Stacks Tech : Leverage fitur perbandingan bawaan untuk analisis.

---

? Konfigurasi

Edit file .env.local untuk pengaturan kunci:

 MILVUS_HOST = localhost
MILVUS_PORT = 19530
OLLAMA_MODEL = llama3.2 

---

? Berkontribusi

Kontribusi didorong! Ikuti langkah -langkah ini:

1. Garpu repositori.
2. Buat cabang fitur:

git checkout -b feature/AmazingFeature

3. Melakukan perubahan Anda:

git commit -m ' Add some AmazingFeature '

4. Dorong Cabang Anda:

git push origin feature/AmazingFeature

5. Buka permintaan tarik.

---

Lisensi

Proyek ini dilisensikan di bawah lisensi MIT. Lihat file lisensi untuk detailnya.

---

Ucapan Terima Kasih

• Vercel AI Chatbot - Inspirasi template untuk frontend.
• LLAMAINDEX - Powering Rag kemampuan.
• Milvus - Backend Pencarian Vektor yang Efisien.
• Ollama - Dukungan LLM Lokal.

---

Mendukung

Jika proyek ini menambah nilai pada pekerjaan Anda, harap berikan bintang!

Dukungan Anda membuat perbedaan dan mendorong pengembangan lebih lanjut. Umpan balik dan saran fitur selalu diterima!