CodeRAG

Motivasi proyek

Proyek ini berasal dari ide sederhana: bagaimana jika Anda bisa memberikan seluruh basis kode ke LLM, bukan hanya potongan -potongan kecil? Sebagian besar asisten pengkodean, seperti co-pilot, bekerja pada ruang lingkup terbatas, tetapi saya menginginkan sesuatu yang dapat menangani konteks penuh dari suatu proyek.

Dengan mengintegrasikan basis kode lengkap dengan Retrieval-Agusted Generation (RAG), POC ini bertujuan untuk meningkatkan kualitas dan relevansi saran kode. Tujuannya adalah untuk melihat bagaimana memiliki kode lengkap yang tersedia untuk kueri waktu-nyata dapat meningkatkan produktivitas.

Coderag

Coderag adalah alat pengambilan kode dan augmentasi yang bertenaga AI yang memanfaatkan model OpenAI (seperti gpt-4 atau gpt-3.5-turbo ) untuk quering, pengindeksan, dan peningkatan codebase real-time. Proyek ini mengintegrasikan sistem Pengambilan-Agung (RAG) untuk membantu pengembang mencari kode yang mulus melalui kode, menerima saran, dan mengimplementasikan perbaikan.

Fitur

• Pengindeksan CodeBase Real-Time : Secara otomatis mengindeks file kode setelah perubahan, dengan pembaruan waktu-nyata.
• Pencarian Database Vektor : Memanfaatkan FAISS atau database vektor serupa untuk pencarian kode yang cepat dan efisien menggunakan embeddings.
• Bantuan pengkodean percakapan : Mengintegrasikan model GPT OpenAI untuk memberikan saran, perbaikan, dan perbaikan kode kontekstual.
• Pengaturan yang dapat dikonfigurasi : Pengaturan khusus lingkungan dikelola menggunakan file .env untuk tombol API, pemilihan model, dan direktori.

Tumpukan teknologi

• API OpenAI : Memanfaatkan GPT-4O (atau model OpenAI lainnya) untuk perbaikan percakapan dan pengkodean.
• Python : Fungsionalitas inti dan interaksi API.
• FAISS (Pencarian Kesamaan AI Facebook) : Untuk pencarian berbasis vektor.
• Python-Dotenv : Untuk mengelola variabel lingkungan.
• Retrieval-Agusted Generation (RAG) : Menggabungkan model pencarian dan generatif.

Petunjuk Pengaturan

Prasyarat

• Python 3.8+
• Kunci API Openai (Anda bisa mendapatkannya di sini)
• Faiss

Langkah 1: Kloning repositori

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

Langkah 2: Pasang dependensi

Buat lingkungan virtual (disarankan):

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

Instal Paket yang Diperlukan:

pip install -r requirements.txt

Langkah 3: Mengkonfigurasi Variabel Lingkungan

Buat file .env di root proyek dan tambahkan variabel berikut:

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 

Langkah 4: Jalankan aplikasi

1. Mulailah backend :

   Untuk memulai backend (pengindeksan, embeddings, dan pemantauan):

   python main.py

2. Mulai frontend :

   Untuk meluncurkan UI StreamLit:

   streamlit run app.py

Penggunaan

1. Ajukan pertanyaan : Ketik pertanyaan atau permintaan kode Anda ke antarmuka. Model akan mencari basis kode yang diindeks dan memberikan saran atau perbaikan.
2. Saran ulasan : Anda akan menerima versi kode yang digabungkan atau tetap berdasarkan analisis model.
3. Sejarah percakapan : Sistem ini melacak pertanyaan Anda dan respons AI untuk konteks yang lebih baik dalam interaksi di masa depan.

Struktur proyek

• main.py : Script utama untuk menjalankan aplikasi.
• prompt_flow.py : Menangani permintaan API Openai dan mengelola sejarah pencarian dan percakapan.
• coderag/config.py : Menyimpan variabel konfigurasi dan lingkungan.
• coderag/search.py : Mengelola Vektor Database (FAISS) mencari cuplikan kode yang relevan.
• .env : Memegang pengaturan khusus lingkungan (tombol API OpenAI, konfigurasi model, dll.).
• requirements.txt : Daftar dependensi Python yang diperlukan untuk menjalankan proyek.

Berkontribusi

Jangan ragu untuk membayar repositori ini, membuka masalah, dan mengirimkan permintaan tarik.

1. Garpu repositori.
2. Buat Cabang Fitur Anda ( git checkout -b feature/your-feature ).
3. Komit perubahan Anda ( git commit -am 'Add new feature' ).
4. Dorong ke cabang ( git push origin feature/your-feature ).
5. Buka permintaan tarik.

Lisensi

Proyek ini dilisensikan di bawah lisensi Apache. Lihat file lisensi untuk detailnya.