CodeRAG

プロジェクトの動機

このプロジェクトは、単純なアイデアから生まれました。ただし、小片ではなくLLMにコードベース全体を提供できるとしたらどうでしょうか。コピロットのようなほとんどのコーディングアシスタントは、限られた範囲で働いていますが、プロジェクトの完全なコンテキストを処理できるものが欲しかったのです。

完全なコードベースを検索された生成（RAG）と統合することにより、このPOCはコード提案の品質と関連性を向上させることを目指しています。目標は、リアルタイムクエリで完全なコードを使用できるようにすることで生産性を向上させることができることです。

Coderag

Coderagは、リアルタイムのコードベースクエリ、インデックス作成、および改善のためにOpenAIのモデル（ gpt-4やgpt-3.5-turboなど）を活用するAI搭載のコード検索および増強ツールです。このプロジェクトでは、検索された高等ジェネレーション（RAG）システムを統合して、開発者がコードをシームレスに検索し、提案を受け取り、改善を実装するのに役立ちます。

特徴

• リアルタイムコードベースインデックス：変更時に​​コードファイルを自動的にインデックスを作成し、リアルタイムの更新を使用します。
• ベクトルデータベース検索：埋め込みを使用した高速で効率的なコード検索にFAISSまたは同様のベクトルデータベースを使用します。
• 会話のコーディング支援：OpenAIのGPTモデルを統合して、コンテキストコードの提案、改善、修正を提供します。
• 構成可能な設定：環境固有の設定は、APIキー、モデル選択、およびディレクトリの.envファイルを使用して管理されます。

技術スタック

• OpenAI API ：会話およびコーディングの改善のためにGPT-4O（またはその他のOpenAIモデル）を活用します。
• Python ：コア機能とAPIの相互作用。
• FAISS（Facebook AIの類似性検索） ：ベクターベースの検索用。
• 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. フロントエンドを開始します：

   Rimelit UIを起動するには：

   streamlit run app.py

使用法

1. 質問する：質問またはコードリクエストをインターフェイスに入力します。モデルはインデックス付きコードベースを検索し、提案または改善を提供します。
2. 提案のレビュー：モデルの分析に基づいて、コードのマージまたは固定バージョンを受信します。
3. 会話の歴史：システムは、将来の相互作用においてより良いコンテキストのためのクエリとAI応答を追跡します。

プロジェクト構造

• main.py ：アプリケーションを実行するメインスクリプト。
• prompt_flow.pyの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ライセンスの下でライセンスされています。詳細については、ライセンスファイルを参照してください。