RagDocs

Ragdocs

Ragdocs é uma solução de código aberto que revoluciona como você interage com a documentação. Ao combinar o poder dos LLMs locais com a geração de gestão de recuperação de última geração (RAG) , os desenvolvedores podem obter respostas precisas instantaneamente de sua documentação sem custos de API.

Diga adeus a chamadas caras de API e preocupações com a privacidade. Com Ragdocs , toda a sua documentação permanece privada e fornece interações do tipo ChatGPT. Construído com a Milvus Vector Search e Next.js, é pronto para produção e fácil de implantar. Experimente o futuro da pesquisa de documentação com privacidade completa de dados e sem taxas de uso.

Rag.demo.1.mp4

? Características

• ? Interface de bate -papo inteligente : interface de conversação adaptada para documentação técnica.
• ? Geração aumentada de recuperação de ponta : respostas precisas e com reconhecimento de contexto.
• ? Suporte local do LLM : integrado ao Ollama para privacidade e eficiência.
• Pesquisa de vetores alimentada por Milvus : consulta rápida e escalável de documentos.
• Frontend da Modern Next.js : Experiência elegante e em tempo real do usuário.
• Suporte a vários documentos : manuseio contínuo de diversas pilhas de tecnologia.
• ⚡ Processamento rápido de documentos : ingestão e análise eficientes de atualizações.
• Atualizações incrementais : mantenha sua documentação em sincronia sem esforço.

---

Arquitetura

 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

---

Começando

Pré -requisitos

• Python 3.12+
• Node.js 20.17.0
• Milvus 2.0+
• Ollama (para suporte local de LLM)

Instale o Node.js com NVM :

nvm install 20.17.0
nvm use 20.17.0

---

Instalação

1. Clone o repositório :

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

2. Instale as dependências do Python :

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

# Install project dependencies
poetry install
poetry shell

Dependências -chave:

• INDEX LLAMA: 0.11.22
• FASTAPI: 0.115.4
• Milvus-Lite: 2.4.10
• Transformadores de frases: 2.7.0
• Tocha: 2.5.1

3. Instale as dependências do front -end :

 cd ragdocs_frontend
yarn

4. Configurar variáveis ​​de ambiente :

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

5. Comece Milvus :

 cd milvus
bash standalone_embed.sh start

6. Execute o back -end :

poetry run uvicorn ragdocs_api.conversation_api:app --reload

7. Execute o front -end :

 cd ragdocs_frontend
yarn dev

---

Uso

1. Adicione documentação : Coloque os arquivos nas respectivas pastas em data/ .
2. Comece a conversar : use o front -end para conversar e explorar sua documentação.
3. Compare pilhas de tecnologia : alavancam os recursos de comparação internos para análise.

---

? Configuração

Edite o arquivo .env.local para configurações de chave:

 MILVUS_HOST = localhost
MILVUS_PORT = 19530
OLLAMA_MODEL = llama3.2 

---

? Contribuindo

As contribuições são encorajadas! Siga estas etapas:

1. Fork o repositório.
2. Crie uma filial de recursos:

git checkout -b feature/AmazingFeature

3. Compreenda suas mudanças:

git commit -m ' Add some AmazingFeature '

4. Empurre seu ramo:

git push origin feature/AmazingFeature

5. Abra um pedido de tração.

---

Licença

Este projeto está licenciado sob a licença do MIT. Consulte o arquivo de licença para obter detalhes.

---

Agradecimentos

• Vercel AI Chatbot - Inspiração de modelo para o front -end.
• Llamaindex - Capacidades de pano de alimentação.
• MILVUS - Back -end de pesquisa de vetores eficientes.
• OLLAMA - Apoio Local LLM.

---

Apoiar

Se este projeto agregar valor ao seu trabalho, dê uma estrela!

Seu apoio faz a diferença e incentiva o desenvolvimento adicional. As sugestões de feedback e recursos são sempre bem -vindas!