CodeRAG

項目動機

這個項目來自一個簡單的想法：如果您可以將整個代碼庫提供給LLM而不是僅僅是小塊怎麼辦？大多數編碼助手，例如副駕駛員，都在有限的範圍上工作，但我想要一些可以處理項目的完整背景的東西。

通過將完整的代碼庫與檢索功能的生成（RAG）集成在一起，該POC旨在提高代碼建議的質量和相關性。目的是了解可用的完整代碼用於實時查詢可以提高生產力。

Coderag

Coderag是AI驅動的代碼檢索和增強工具，利用OpenAI模型（例如gpt-4或gpt-3.5-turbo ）進行實時代碼庫查詢，索引和改進。該項目集成了檢索功能的生成（RAG）系統，以幫助開發人員無縫搜索代碼，接收建議並實施改進。

特徵

• 實時代碼庫索引：在更改時自動索引代碼文件，並進行實時更新。
• 矢量數據庫搜索：使用FAISS或類似的矢量數據庫，用於使用嵌入式的快速，有效的代碼搜索。
• 會話編碼幫助：集成OpenAI的GPT模型，以提供上下文代碼建議，改進和修復。
• 可配置的設置：特定於環境的設置是使用用於API鍵，模型選擇和目錄的.env文件管理的。

技術堆棧

• OpenAI API ：利用GPT-4O（或任何其他OpenAI模型）進行對話和編碼改進。
• Python ：核心功能和API相互作用。
• Faiss（Facebook AI相似性搜索） ：用於基於向量的搜索。
• Python-Dotenv ：用於管理環境變量。
• 檢索增強生成（RAG） ：結合了搜索和生成模型。

設置說明

先決條件

• Python 3.8+
• OpenAI API鍵（您可以在這裡找到一個）
• faiss

步驟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 run app.py

用法

1. 提出問題：將問題或代碼請求鍵入接口。該模型將搜索索引代碼庫，並提供建議或改進。
2. 審查建議：您將根據模型的分析收到代碼的合併或固定版本。
3. 對話歷史：系統跟踪您的查詢和AI響應，以在未來的互動中為更好的上下文。

項目結構

• main.py ：運行應用程序的主腳本。
• prompt_flow.py ：處理查詢OpenAI的API並管理搜索和對話歷史記錄。
• 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許可證獲得許可的。有關詳細信息，請參見許可證文件。