RagDocs

ragdocs

Ragdocs是一種尖端的開源解決方案，它徹底改變了您與文檔的互動方式。通過將本地LLM的力量與最先進的檢索型發電（RAG）相結合，開發人員可以立即從文檔中獲得準確的答案，而無需任何API成本。

告別昂貴的API電話和隱私問題。使用Ragdocs ，您的所有文檔都保持私密，同時提供類似Chatgpt的互動。它是由Milvus Vector Search和Next.js構建的，它已經準備就緒且易於部署。通過完整的數據隱私和沒有使用費來體驗文檔搜索的未來。

rag.demo.1.mp4

？特徵

• ？智能聊天接口：針對技術文檔的對話界面。
• ？尖端檢索增強發電：準確和上下文感知的響應。
• ？本地LLM支持：與Ollama集成以供隱私和效率集成。
• MILVUS提供支持的矢量搜索：快速可擴展的文檔查詢。
• Modern Next.js Frontend ：時尚，實時用戶體驗。
• 多文件支持：無縫處理各種技術堆棧。
• ⚡快速文檔處理：有效攝入和更新分析。
• 增量更新：使您的文檔毫不費力地保持同步。

---

建築學

 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

---

入門

先決條件

• Python 3.12+
• Node.js 20.17.0
• MILVUS 2.0+
• Ollama（用於本地LLM支持）

使用NVM安裝node.js：

nvm install 20.17.0
nvm use 20.17.0

---

安裝

1. 克隆存儲庫：

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

2. 安裝Python依賴性：

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

# Install project dependencies
poetry install
poetry shell

關鍵依賴性：

• 駱駝指數：0.11.22
• FastApi：0.115.4
• Milvus-Lite：2.4.10
• 句子轉換器：2.7.0
• 火炬：2.5.1

3. 安裝前端依賴性：

 cd ragdocs_frontend
yarn

4. 設置環境變量：

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

5. 開始米爾維斯：

 cd milvus
bash standalone_embed.sh start

6. 運行後端：

poetry run uvicorn ragdocs_api.conversation_api:app --reload

7. 運行前端：

 cd ragdocs_frontend
yarn dev

---

用法

1. 添加文檔：將文件放在data/下方的文件夾中。
2. 開始聊天：使用前端與文檔聊天並探索您的文檔。
3. 比較技術堆棧：利用內置比較功能進行分析。

---

？配置

為密鑰設置編輯.env.local文件：

 MILVUS_HOST = localhost
MILVUS_PORT = 19530
OLLAMA_MODEL = llama3.2 

---

？貢獻

鼓勵捐款！請按照以下步驟：

1. 分叉存儲庫。
2. 創建一個功能分支：

git checkout -b feature/AmazingFeature

3. 提交您的更改：

git commit -m ' Add some AmazingFeature '

4. 推您的分支：

git push origin feature/AmazingFeature

5. 打開拉動請求。

---

執照

該項目已根據MIT許可獲得許可。有關詳細信息，請參見許可證文件。

---

致謝

• Vercel AI聊天機器人 - 前端的模板靈感。
• LlamainDex-為RAG功能提供動力。
• MILVUS-有效的向量搜索後端。
• Ollama-本地LLM支持。

---

支持

如果此項目為您的工作增加價值，請給它星星！

您的支持會有所作為，並鼓勵進一步發展。總是歡迎反饋和功能建議！