CodeRAG

แรงจูงใจในโครงการ

โครงการนี้มาจากแนวคิดง่ายๆ: ถ้าคุณสามารถให้รหัสฐานทั้งหมดแก่ LLM แทนที่จะเป็นเพียงชิ้นเล็ก ๆ ผู้ช่วยการเข้ารหัสส่วนใหญ่เช่นนักบินร่วมทำงานในขอบเขตที่ จำกัด แต่ฉันต้องการบางสิ่งที่สามารถจัดการกับบริบททั้งหมดของโครงการ

ด้วยการรวมรหัสเบสเต็มรูปแบบเข้ากับ Generation Retrieval-Augmented (RAG) POC นี้มีจุดมุ่งหมายเพื่อปรับปรุงคุณภาพและความเกี่ยวข้องของคำแนะนำรหัส เป้าหมายคือการดูว่าการมีรหัสที่สมบูรณ์สำหรับการสืบค้นแบบเรียลไทม์สามารถเพิ่มประสิทธิภาพการผลิตได้อย่างไร

coderag

Coderag เป็นเครื่องมือดึงรหัสและการเสริมรหัส AI ที่ใช้ประโยชน์จากโมเดลของ OpenAI (เช่น gpt-4 หรือ gpt-3.5-turbo ) สำหรับ Codebase แบบเรียลไทม์การสืบค้นการจัดทำดัชนีและการปรับปรุง โครงการนี้รวมระบบการดึง (RAG) การดึงข้อมูล (RAG) เพื่อช่วยให้นักพัฒนาค้นหาอย่างราบรื่นผ่านรหัสรับคำแนะนำและใช้การปรับปรุง

คุณสมบัติ

• การจัดทำดัชนี codebase แบบเรียลไทม์ : จัดทำดัชนีไฟล์รหัสโดยอัตโนมัติเมื่อมีการเปลี่ยนแปลงพร้อมการอัปเดตแบบเรียลไทม์
• การค้นหาฐานข้อมูลเวกเตอร์ : ใช้ FAISS หรือฐานข้อมูลเวกเตอร์ที่คล้ายกันสำหรับการค้นหารหัสที่รวดเร็วและมีประสิทธิภาพโดยใช้ EMBEDDINGS
• ความช่วยเหลือการเขียนโค้ดสนทนา : รวมโมเดล GPT ของ OpenAI เพื่อให้คำแนะนำรหัสบริบทการปรับปรุงและการแก้ไข
• การตั้งค่าที่กำหนดค่าได้ : การตั้งค่าเฉพาะสภาพแวดล้อมได้รับการจัดการโดยใช้ไฟล์ .env สำหรับคีย์ API การเลือกรุ่นและไดเรกทอรี

ซ้อนเทค

• OpenAI API : ใช้ประโยชน์จาก GPT-4O (หรือโมเดล OpenAI อื่น ๆ ) สำหรับการปรับปรุงการสนทนาและการเข้ารหัส
• Python : ฟังก์ชั่นหลักและการโต้ตอบ API
• FAISS (การค้นหาความคล้ายคลึงกันของ Facebook AI) : สำหรับการค้นหาแบบเวกเตอร์
• Python-Dotenv : สำหรับการจัดการตัวแปรสภาพแวดล้อม
• Retrieval-Augmented Generation (RAG) : รวมโมเดลการค้นหาและการกำเนิด

คำแนะนำการตั้งค่า

ข้อกำหนดเบื้องต้น

• Python 3.8+
• คีย์ OpenAI API (คุณสามารถรับได้ที่นี่)
• คน

ขั้นตอนที่ 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. เริ่มต้นส่วนหน้า :

   เพื่อเปิดตัว UI Streamlit:

   streamlit run app.py

การใช้งาน

1. ถามคำถาม : พิมพ์คำถามหรือคำขอรหัสของคุณลงในอินเทอร์เฟซ โมเดลจะค้นหา codebase ที่จัดทำดัชนีและให้คำแนะนำหรือการปรับปรุง
2. คำแนะนำการตรวจสอบ : คุณจะได้รับรหัสเวอร์ชันที่ผสานหรือคงที่ตามการวิเคราะห์ของโมเดล
3. ประวัติการสนทนา : ระบบติดตามการสืบค้นของคุณและการตอบสนอง AI สำหรับบริบทที่ดีขึ้นในการโต้ตอบในอนาคต

โครงสร้างโครงการ

• main.py : สคริปต์หลักในการเรียกใช้แอปพลิเคชัน
• prompt_flow.py : จัดการการสืบค้น API ของ OpenAI และจัดการประวัติการค้นหาและการสนทนา
• coderag/config.py : เก็บตัวแปรการกำหนดค่าและสภาพแวดล้อม
• coderag/search.py : จัดการฐานข้อมูลเวกเตอร์ (FAISS) ค้นหาตัวอย่างโค้ดที่เกี่ยวข้อง
• .env : ถือการตั้งค่าเฉพาะสภาพแวดล้อม (คีย์ OpenAI API, การกำหนดค่าแบบจำลอง ฯลฯ )
• requirements.txt : แสดงรายการการพึ่งพา Python ที่จำเป็นในการเรียกใช้โครงการ

การบริจาค

อย่าลังเลที่จะแยกที่เก็บนี้ปัญหาเปิดและส่งคำขอดึง

1. แยกที่เก็บ
2. สร้างสาขาคุณสมบัติของคุณ ( git checkout -b feature/your-feature )
3. กระทำการเปลี่ยนแปลงของคุณ ( git commit -am 'Add new feature' )
4. ผลักดันไปยังสาขา ( git push origin feature/your-feature )
5. เปิดคำขอดึง

ใบอนุญาต

โครงการนี้ได้รับใบอนุญาตภายใต้ใบอนุญาต Apache ดูไฟล์ใบอนุญาตสำหรับรายละเอียด