CodeRAG

Проект мотивация

Этот проект исходил из простой идеи: что, если бы вы могли предоставить целую кодовую базу LLM вместо небольших кусочков? Большинство ассистентов по кодированию, такие как со-пилоты, работают над ограниченным объемом, но я хотел что-то, что могло бы справиться с полным контекстом проекта.

Интегрируя полную кодовую базу с поколением-поисковой генерацией (RAG), этот POC стремится улучшить качество и актуальность предложений кода. Цель состоит в том, чтобы увидеть, как наличие полного кода, доступного для запросов в реальном времени, может повысить производительность.

Кодераг

Coderag-это инструмент для поиска кода и увеличения кода, который использует модели OpenAI (такие как gpt-4 или gpt-3.5-turbo ) для запросов, индексации и улучшения в режиме реального времени. Этот проект интегрирует систему поиска-аугмента (RAG), чтобы помочь разработчикам плавно искать код, получать предложения и внедрить улучшения.

Функции

• Индексирование кодовой базы в реальном времени : автоматически индексирует файлы кода при изменениях с обновлениями в реальном времени.
• Поиск векторной базы данных : использует FAISS или аналогичную векторную базу данных для быстрого, эффективного поиска кода с использованием Embeddings.
• Помощь в разговорном кодировании : интегрирует модели GPT OpenAI, чтобы предоставить контекстные предложения, улучшения и исправления.
• Настраиваемые настройки : Настройки, специфичные для среды, управляются с использованием файла .env для клавиш API, выбора модели и каталогов.

Технический стек

• OpenAI API : использует GPT-4O (или любую другую модель OpenAI) для разговоров и улучшений кодирования.
• Python : основная функциональность и взаимодействие API.
• FAISS (Facebook AI SASE SASE) : для поиска на основе вектора.
• Python-Dotenv : для управления переменными среды.
• Поиск поколения (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. Начните фронт :

   Чтобы запустить пользовательский интерфейс:

   streamlit run app.py

Использование

1. Задайте вопрос : введите свой вопрос или запрос кода в интерфейс. Модель будет искать индексированную кодовую базу и предоставить предложения или улучшения.
2. Обзор предложения : вы получите объединенную или фиксированную версию кода на основе анализа модели.
3. История разговоров : система отслеживает ваши запросы и ответы ИИ для лучшего контекста в будущих взаимодействиях.

Структура проекта

• main.py : основной сценарий для запуска приложения.
• prompt_flow.py : обрабатывает запрос 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. Смотрите файл лицензии для получения подробной информации.