CodeRAG

Projektmotivation

Dieses Projekt stammte aus einer einfachen Idee: Was wäre, wenn Sie einem LLM anstelle von kleinen Teilen eine gesamte Codebasis zur Verfügung stellen könnten? Die meisten Codierungsassistenten wie Co-Piloten arbeiten an einem begrenzten Bereich, aber ich wollte etwas, das den vollen Kontext eines Projekts bewältigen könnte.

Durch die Integration der vollständigen Codebasis in die Abruf-Generation (RAG) zielt dieser POC darauf ab, die Qualität und Relevanz von Codevorschlägen zu verbessern. Ziel ist es, zu sehen, wie der vollständige Code für Echtzeitabfragen die Produktivität verbessern kann.

Coderag

Codierag ist ein KI-angetanter Code-Abruf- und Augmentation-Tool, mit dem die Modelle von OpenAI (wie gpt-4 oder gpt-3.5-turbo ) für Echtzeit-Codebasis-Abfragen, -indexierung und -verbesserung nutzt. Dieses Projekt integriert ein RAG-System (Abruf-Augmented Generation), um Entwicklern dabei zu helfen, den Code nahtlos zu durchsuchen, Vorschläge zu erhalten und Verbesserungen zu implementieren.

Merkmale

• Echtzeit-Codebasis-Indexierung : Indiziert automatisch Codedateien bei Änderungen mit Echtzeit-Updates.
• Vektor -Datenbanksuche : Verwendet FAISS oder eine ähnliche Vektor -Datenbank für eine schnelle, effiziente Codesuche mithilfe von Einbettungen.
• Conversational Coding Assistance : Integriert die GPT -Modelle von OpenAI, um Kontextcodevorschläge, Verbesserungen und Korrekturen bereitzustellen.
• Konfigurierbare Einstellungen : Umgebungsspezifische Einstellungen werden mithilfe einer .env Datei für API-Schlüssel, Modellauswahl und Verzeichnisse verwaltet.

Tech Stack

• OpenAI-API : Nutzt GPT-4O (oder ein anderes OpenAI-Modell) für Konversations- und Codierungsverbesserungen.
• Python : Kernfunktionalität und API -Interaktionen.
• FAISS (Facebook AI-Ähnlichkeitssuche) : Für vektorbasierte Suche.
• Python-dotenv : Um Umgebungsvariablen zu verwalten.
• Retrieval-Augmented-Generation (LAG) : Kombiniert Such- und Generative Modelle.

Setup -Anweisungen

Voraussetzungen

• Python 3.8+
• OpenAI -API -Schlüssel (Sie können hier einen bekommen)
• Faiss

Schritt 1: Klonen Sie das Repository

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

Schritt 2: Abhängigkeiten installieren

Erstellen Sie eine virtuelle Umgebung (empfohlen):

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

Installieren Sie die erforderlichen Pakete:

pip install -r requirements.txt

Schritt 3: Konfigurieren von Umgebungsvariablen

Erstellen Sie eine .env -Datei im Stammvermögen des Projekts und fügen Sie die folgenden Variablen hinzu:

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 

Schritt 4: Führen Sie die Anwendung aus

1. Starten Sie das Backend :

   Um das Backend zu beginnen (Indizierung, Einbettungen und Überwachung):

   python main.py

2. Starten Sie die Frontend :

   So starten Sie die optimistische Benutzeroberfläche:

   streamlit run app.py

Verwendung

1. Stellen Sie eine Frage : Geben Sie Ihre Frage- oder Codeanforderung in die Schnittstelle ein. Das Modell durchsucht die indizierte Codebasis und liefert Vorschläge oder Verbesserungen.
2. Überprüfungsvorschläge : Sie erhalten eine zusammengeführte oder feste Version des Code, die auf der Analyse des Modells basiert.
3. Konversationsgeschichte : Das System verfolgt Ihre Abfragen und die KI -Antworten für einen besseren Kontext in zukünftigen Interaktionen.

Projektstruktur

• main.py : Das Hauptskript zum Ausführen der Anwendung.
• prompt_flow.py : Die API von Openai abfragt und die Suche und den Konversationsverlauf verwaltet.
• coderag/config.py : Speichert Variablen Konfiguration und Umgebungsvariablen.
• coderag/search.py : Verwaltet Vektordatenbank (FAISS) Suchanfragen nach relevanten Codeausschnitten.
• .env : Umgebungsspezifische Einstellungen (OpenAI-API-Schlüssel, Modellkonfiguration usw.).
• requirements.txt : Listet die Python -Abhängigkeiten auf, die für die Ausführung des Projekts erforderlich sind.

Beitragen

Fühlen Sie sich frei, dieses Repository zu geben, Probleme zu öffnen und Pull -Anfragen einzureichen.

1. Geben Sie das Repository auf.
2. Erstellen Sie Ihre Funktionszweig ( git checkout -b feature/your-feature ).
3. Bestimmen Sie Ihre Änderungen ( git commit -am 'Add new feature' ).
4. Drücken Sie in den Zweig ( git push origin feature/your-feature ).
5. Öffnen Sie eine Pull -Anfrage.

Lizenz

Dieses Projekt ist unter der Apache -Lizenz lizenziert. Weitere Informationen finden Sie in der Lizenzdatei.