CodeRAG

Motivation du projet

Ce projet est venu d'une idée simple: que se passe-t-il si vous pouviez fournir une base de code entière à un LLM au lieu de simples petits morceaux? La plupart des assistants de codage, comme les copilotes, fonctionnent sur une portée limitée, mais je voulais quelque chose qui pourrait gérer le contexte complet d'un projet.

En intégrant la base de code complète à la génération (RAG) (RAG) de la récupération, ce POC vise à améliorer la qualité et la pertinence des suggestions de code. L'objectif est de voir comment avoir le code complet disponible pour la requête en temps réel peut améliorer la productivité.

Coderag

Coderag est un outil de récupération et d'augmentation de code alimenté par AI qui exploite les modèles d'OpenAI (tels que gpt-4 ou gpt-3.5-turbo ) pour la requête, l'indexation et l'amélioration de la base de code en temps réel. Ce projet intègre un système de génération (RAG) (RAG) de la récupération pour aider les développeurs à rechercher de manière transparente via le code, à recevoir des suggestions et à mettre en œuvre des améliorations.

Caractéristiques

• Indexation de base de code en temps réel : index automatiquement les fichiers de code lors des modifications, avec des mises à jour en temps réel.
• Recherche de la base de données vectorielle : utilise FAIS ou une base de données vectorielle similaire pour une recherche de code rapide et efficace à l'aide d'intégration.
• Assistance au codage conversationnel : intègre les modèles GPT d'OpenAI pour fournir des suggestions de code contextuelles, des améliorations et des correctifs.
• Paramètres configurables : les paramètres spécifiques à l'environnement sont gérés à l'aide d'un fichier .env pour les clés API, la sélection du modèle et les répertoires.

Pile technologique

• API OpenAI : exploite GPT-4O (ou tout autre modèle OpenAI) pour les améliorations conversationnelles et codantes.
• Python : fonctionnalité centrale et interactions API.
• FAISS (Facebook AI Search Search) : pour la recherche basée sur les vecteurs.
• Python-Dotenv : pour gérer les variables environnementales.
• Génération (RAG) (RAG) de la récupération : combine des modèles de recherche et génératifs.

Instructions de configuration

Condition préalable

• Python 3.8+
• Clé API Openai (vous pouvez en obtenir un ici)
• Fais

Étape 1: cloner le référentiel

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

Étape 2: Installer les dépendances

Créer un environnement virtuel (recommandé):

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

Installer les packages requis:

pip install -r requirements.txt

Étape 3: Configurer les variables de l'environnement

Créez un fichier .env dans la racine du projet et ajoutez les variables suivantes:

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 

Étape 4: Exécutez l'application

1. Démarrez le backend :

   Pour démarrer le backend (indexation, intégres et surveillance):

   python main.py

2. Démarrez le frontend :

   Pour lancer l'interface utilisateur rationalisée:

   streamlit run app.py

Usage

1. Posez une question : saisissez votre question ou votre demande de code dans l'interface. Le modèle recherchera la base de code indexée et fournira des suggestions ou des améliorations.
2. Examiner les suggestions : vous recevrez une version fusionnée ou fixe du code en fonction de l'analyse du modèle.
3. Historique conversationnel : le système garde une trace de vos requêtes et des réponses de l'IA pour un meilleur contexte dans les interactions futures.

Structure du projet

• main.py : le script principal pour exécuter l'application.
• prompt_flow.py : gère la question de l'interrogation de l'API d'Openai et gère la recherche et l'historique conversationnel.
• coderag/config.py : stocke les variables de configuration et d'environnement.
• coderag/search.py : gère la base de données vectorielle (FAISS) recherche des extraits de code pertinents.
• .env : contient des paramètres spécifiques à l'environnement (touches API OpenI, configuration du modèle, etc.).
• requirements.txt : répertorie les dépendances Python nécessaires pour exécuter le projet.

Contributif

N'hésitez pas à alimenter ce référentiel, à ouvrir des problèmes et à soumettre des demandes de traction.

1. Fourk le référentiel.
2. Créez votre branche de fonctionnalité ( git checkout -b feature/your-feature ).
3. Commissez vos modifications ( git commit -am 'Add new feature' ).
4. Poussez vers la branche ( git push origin feature/your-feature ).
5. Ouvrez une demande de traction.

Licence

Ce projet est sous licence Apache. Voir le fichier de licence pour plus de détails.