RagDocs

Pavimento

Ragdocs es una solución de código abierto de vanguardia que revoluciona cómo interactúa con la documentación. Al combinar el poder de los LLM locales con la generación (RAG) de recuperación de última generación , los desarrolladores pueden obtener instantáneamente respuestas precisas de su documentación sin ningún costo de API.

Diga adiós a las costosas llamadas de API y preocupaciones de privacidad. Con Ragdocs , toda su documentación permanece privada mientras proporciona interacciones similares a ChatGPT. Construido con Milvus Vector Search y Next.js, está listo para la producción y fácil de implementar. Experimente el futuro de la búsqueda de documentación con privacidad de datos completa y sin tarifas de uso.

RAG.DEMO.1.MP4

? Características

• ? Interfaz de chat inteligente : interfaz de conversación adaptada para la documentación técnica.
• ? Generación aumentada de recuperación de vanguardia : respuestas precisas y conscientes del contexto.
• ? Soporte local de LLM : integrado con Ollama para la privacidad y la eficiencia.
• Búsqueda vectorial alimentada por Milvus : consulta de documentos rápidos y escalables.
• Modern Next.js Frontend : experiencia de usuario elegante y en tiempo real.
• Soporte de documentos múltiples : manejo sin problemas de diversas pilas tecnológicas.
• ⚡ Procesamiento de documentos rápidos : ingestión eficiente y análisis de actualizaciones.
• Actualizaciones incrementales : mantenga su documentación sin esfuerzo sin esfuerzo.

---

Arquitectura

 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

---

Empezando

Requisitos previos

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

Instale Node.js con NVM :

nvm install 20.17.0
nvm use 20.17.0

---

Instalación

1. Clon el repositorio :

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

2. Instalar dependencias de Python :

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

# Install project dependencies
poetry install
poetry shell

Dependencias clave:

• índice de llamas: 0.11.22
• Fastapi: 0.115.4
• Milvus-Lite: 2.4.10
• Transformadores de oraciones: 2.7.0
• antorcha: 2.5.1

3. Instalar dependencias frontend :

 cd ragdocs_frontend
yarn

4. Configurar variables de entorno :

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

5. Iniciar Milvus :

 cd milvus
bash standalone_embed.sh start

6. Ejecute el backend :

poetry run uvicorn ragdocs_api.conversation_api:app --reload

7. Ejecute el frontend :

 cd ragdocs_frontend
yarn dev

---

Uso

1. Agregar documentación : Coloque los archivos en las carpetas respectivas en data/ .
2. Comience a chatear : use el interfaz para chatear y explorar su documentación.
3. Compare las pilas tecnológicas : aproveche las características de comparación incorporadas para el análisis.

---

? Configuración

Edite el archivo .env.local para la configuración de clave:

 MILVUS_HOST = localhost
MILVUS_PORT = 19530
OLLAMA_MODEL = llama3.2 

---

? Que contribuye

¡Se alientan las contribuciones! Sigue estos pasos:

1. Bifurca el repositorio.
2. Crear una rama de características:

git checkout -b feature/AmazingFeature

3. Comprometa tus cambios:

git commit -m ' Add some AmazingFeature '

4. Empuja tu rama:

git push origin feature/AmazingFeature

5. Abra una solicitud de extracción.

---

Licencia

Este proyecto tiene licencia bajo la licencia MIT. Consulte el archivo de licencia para obtener más detalles.

---

Expresiones de gratitud

• Vercel Ai Chatbot - Inspiración de plantilla para el interfaz.
• Llamaindex - Capacidades de trapo de alimentación.
• MILVUS - Backend de búsqueda vectorial eficiente.
• Ollama - Soporte local de LLM.

---

Apoyo

Si este proyecto agrega valor a su trabajo, ¡dale una estrella!

Su apoyo marca la diferencia y fomenta un mayor desarrollo. ¡Los comentarios y las sugerencias de características siempre son bienvenidos!