CodeRAG

Motivación del proyecto

Este proyecto proviene de una idea simple: ¿qué pasaría si pudiera proporcionar una base de código completa a una LLM en lugar de solo piezas pequeñas? La mayoría de los asistentes de codificación, como los copilotos, trabajan en un alcance limitado, pero quería algo que pudiera manejar el contexto completo de un proyecto.

Al integrar la base de código completa con la generación de recuperación acuática (RAG), este POC tiene como objetivo mejorar la calidad y la relevancia de las sugerencias de código. El objetivo es ver cómo tener el código completo disponible para la consulta en tiempo real puede mejorar la productividad.

Coderag

Coderag es una herramienta de recuperación y aumento de código con IA que aprovecha los modelos de OpenAI (como gpt-4 o gpt-3.5-turbo ) para consultar, indexación y mejora de la base de código en tiempo real. Este proyecto integra un sistema de generación (RAG) de recuperación (RAG) para ayudar a los desarrolladores a buscar sin problemas a través del código, recibir sugerencias e implementar mejoras.

Características

• Indexación de base de código en tiempo real : indexa automáticamente los archivos de código en los cambios, con actualizaciones en tiempo real.
• Búsqueda de la base de datos vectorial : utiliza FAISS o una base de datos vectorial similar para la búsqueda de código rápido y eficiente utilizando incrustaciones.
• Asistencia de codificación conversacional : integra los modelos GPT de OpenAI para proporcionar sugerencias de código contextual, mejoras y correcciones.
• Configuración configurable : las configuraciones específicas del entorno se administran utilizando un archivo .env para claves API, selección de modelos y directorios.

Pila de tecnología

• API de OpenAI : aprovecha GPT-4O (o cualquier otro modelo Operai) para mejoras de conversación y codificación.
• Python : funcionalidad central e interacciones API.
• FAISS (búsqueda de similitud de IA de Facebook) : para la búsqueda basada en vectores.
• Python-Dotenv : para administrar variables de entorno.
• Generación de recuperación de la generación (RAG) : combina los modelos de búsqueda y generación.

Instrucciones de configuración

Requisitos previos

• Python 3.8+
• Clave de API de OpenAI (puede obtener una aquí)
• Faiss

Paso 1: Clonar el repositorio

git clone https://github.com/yourusername/CodeRAG.git
cd CodeRAG

Paso 2: Instalar dependencias

Crear un entorno virtual (recomendado):

python3 -m venv venv
source venv/bin/activate  # On Windows use `venvScriptsactivate`

Instalar paquetes requeridos:

pip install -r requirements.txt

Paso 3: Configurar variables de entorno

Cree un archivo .env en la raíz del proyecto y agregue las siguientes variables:

OPENAI_API_KEY=your_openai_api_key
OPENAI_EMBEDDING_MODEL=text-embedding-ada-002
OPENAI_CHAT_MODEL=gpt-4o
WATCHED_DIR=path_to_your_code_directory
FAISS_INDEX_FILE=path_to_faiss_index
EMBEDDING_DIM=1536  # Modify if you're using a different embedding model 

Paso 4: ejecute la aplicación

1. Comience el backend :

   Para comenzar el backend (indexación, integración y monitoreo):

   python main.py

2. Comience el frontend :

   Para iniciar la interfaz de usuario de transmisión:

   streamlit run app.py

Uso

1. Haga una pregunta : escriba su pregunta o solicitud de código en la interfaz. El modelo buscará la base de código indexada y proporcionará sugerencias o mejoras.
2. Sugerencias de revisión : recibirá una versión fusionada o fija del código basado en el análisis del modelo.
3. Historia de conversación : el sistema realiza un seguimiento de sus consultas y las respuestas de IA para un mejor contexto en futuras interacciones.

Estructura de proyectos

• main.py : el script principal para ejecutar la aplicación.
• prompt_flow.py : maneja la API de consulta de OpenAI y administra el historial de búsqueda e conversación.
• coderag/config.py : almacena variables de configuración y entorno.
• coderag/search.py : administra la base de datos Vector (FAISS) Búsqueda de fragmentos de código relevantes.
• .env : contiene configuraciones específicas del entorno (teclas API de OpenAI, configuración del modelo, etc.).
• requirements.txt : enumera las dependencias de Python necesarias para ejecutar el proyecto.

Que contribuye

Siéntase libre de desembolsar este repositorio, abrir problemas y enviar solicitudes de extracción.

1. Bifurca el repositorio.
2. Cree su rama de características ( git checkout -b feature/your-feature ).
3. Comprometer sus cambios ( git commit -am 'Add new feature' ).
4. Empuje a la rama ( git push origin feature/your-feature ).
5. Abra una solicitud de extracción.

Licencia

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