CodeRAG

دافع المشروع

جاء هذا المشروع من فكرة بسيطة: ماذا لو كان بإمكانك توفير قاعدة كود كاملة إلى LLM بدلاً من قطع صغيرة فقط؟ يعمل معظم مساعدي الترميز ، مثل المشاركين ، على نطاق محدود ، لكنني أردت شيئًا يمكنه التعامل مع السياق الكامل للمشروع.

من خلال دمج قاعدة الشفرة الكاملة مع الجيل المتمثل في الاسترجاع (RAG) ، يهدف هذا POC إلى تحسين جودة اقتراحات الكود وأهميتها. الهدف من ذلك هو أن نرى كيف يمكن لتوفير الكود الكامل للاستعلام في الوقت الفعلي تعزيز الإنتاجية.

المبرمج

CODERAG هي أداة استرجاع وزيادة رمز من الذكاء الاصطناعى والتي تستفيد من نماذج Openai (مثل gpt-4 أو gpt-3.5-turbo ) للاستعلام عن قاعدة الكود في الوقت الحقيقي ، والفهرسة ، والتحسين. يدمج هذا المشروع نظام الجيل (RAG) الذي تم تجهيزه للاسترجاع لمساعدة المطورين على البحث بسلاسة من خلال التعليمات البرمجية ، وتلقي الاقتراحات ، وتنفيذ التحسينات.

سمات

• فهرسة قاعدة كود في الوقت الحقيقي : يفهرس تلقائيًا ملفات الرمز عند التغييرات ، مع تحديثات في الوقت الفعلي.
• البحث عن قاعدة بيانات المتجهات : يستخدم FAISS أو قاعدة بيانات متجه مماثلة للبحث عن رمز سريع وفعال باستخدام التضمينات.
• مساعدة ترميز المحادثة : يدمج نماذج GPT من Openai لتوفير اقتراحات التعليمات البرمجية السياقية ، والتحسينات ، والإصلاحات.
• الإعدادات القابلة للتكوين : تتم إدارة الإعدادات الخاصة بالبيئة باستخدام ملف .env لمفاتيح API ، واختيار النماذج ، والأدلة.

مكدس التكنولوجيا

• Openai API : يعزز GPT-4O (أو أي نموذج Openai آخر) لتحسينات المحادثة والترميز.
• بيثون : الوظائف الأساسية وتفاعلات API.
• FAISS (بحث تشابه AI Facebook) : للبحث المستند إلى المتجهات.
• Python-dotenv : لإدارة متغيرات البيئة.
• الجيل المتمثل في الاسترجاع (RAG) : يجمع بين النماذج البحثية والتوليد.

تعليمات الإعداد

المتطلبات الأساسية

• بيثون 3.8+
• مفتاح API Openai (يمكنك الحصول على واحدة هنا)
• فايس

الخطوة 1: استنساخ المستودع

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

الخطوة 2: تثبيت التبعيات

إنشاء بيئة افتراضية (موصى بها):

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

تثبيت الحزم المطلوبة:

pip install -r requirements.txt

الخطوة 3: تكوين متغيرات البيئة

قم بإنشاء ملف .env في جذر المشروع وأضف المتغيرات التالية:

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 

الخطوة 4: تشغيل التطبيق

1. بدء الواجهة الخلفية :

   لبدء الواجهة الخلفية (الفهرسة ، التضمينات ، والمراقبة):

   python main.py

2. ابدأ الواجهة الأمامية :

   لإطلاق واجهة المستخدم SPEMANLIT:

   streamlit run app.py

الاستخدام

1. اطرح سؤالاً : اكتب سؤالك أو طلب الرمز في الواجهة. سيبحث النموذج في قاعدة الشفرة المفهرسة ويقدم اقتراحات أو تحسينات.
2. اقتراحات المراجعة : ستتلقى نسخة مدمجة أو ثابتة من الرمز بناءً على تحليل النموذج.
3. تاريخ المحادثة : يتتبع النظام استفساراتك واستجابات الذكاء الاصطناعي لسياق أفضل في التفاعلات المستقبلية.

هيكل المشروع

• main.py : البرنامج النصي الرئيسي لتشغيل التطبيق.
• prompt_flow.py : يتعامل مع Queryping API Openai ويدير تاريخ البحث والمحادثة.
• coderag/config.py : تخزين متغيرات التكوين وبيئة.
• coderag/search.py : يدير قاعدة بيانات المتجه (FAISS) بحثًا عن مقتطفات التعليمات البرمجية ذات الصلة.
• .env : يحمل إعدادات خاصة بالبيئة (مفاتيح API Openai ، تكوين النموذج ، إلخ).
• requirements.txt : يسرد تبعيات بيثون اللازمة لتشغيل المشروع.

المساهمة

لا تتردد في توتر هذا المستودع ، والمشكلات المفتوحة ، وتقديم طلبات السحب.

1. شوكة المستودع.
2. قم بإنشاء فرع الميزات الخاص بك ( git checkout -b feature/your-feature ).
3. ارتكب التغييرات الخاصة بك ( git commit -am 'Add new feature' ).
4. ادفع إلى الفرع ( git push origin feature/your-feature ).
5. افتح طلب سحب.

رخصة

هذا المشروع مرخص بموجب ترخيص Apache. انظر ملف الترخيص للحصول على التفاصيل.