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许可证获得许可的。有关详细信息，请参见许可证文件。