「DocsGPT」のインストール・使い方

Authors

• 

  Name

  章 有坂

  short bio

  オープンソースソフトウェアのトレンドを追いかけてます。

DocsGPTは、プロジェクトのドキュメンテーションを検索する際のプロセスを最適化するための先進的なオープンソースソリューションです。GPTモデルの統合により、開発者はプロジェクトに関する質問を簡単に行い、正確な回答を受け取ることができます。これにより、時間を消費する手動検索から解放され、必要な情報を素早く見つけることが可能になりますSource 0。

インストール・導入方法

DocsGPTのセットアップは以下の手順で行います：

1. Dockerがインストールされていることを確認します。これにより、すべての依存関係がインストールされ、ローカルモデルをダウンロードするか、OpenAIを使用することができます。

2. このリポジトリをクローンします：git clone https://github.com/arc53/DocsGPT.git

3. ルートディレクトリに.envファイルを作成し、API_KEY環境変数をあなたのOpenAI APIキーに設定し、VITE_API_STREAMINGをstreaming答えを望むかどうかに応じてtrueまたはfalseに設定します。以下のようになります：

API_KEY=Yourkey
VITE_API_STREAMING=true

4. バックエンドを実行するために、Python 3.10または3.11がインストールされていることを確認します。必要な環境変数をエクスポートするか、/applicationフォルダ内で.envファイルを準備します。application/.env_sampleをコピーして、API_KEYとEMBEDDINGS_KEYフィールドにあなたのOpenAI APIトークンを持つ.envを作成します。

5. 任意でPython仮想環境を作成します：

python -m venv venv
. venv/bin/activate

6. application/サブディレクトリに移動し、バックエンドの依存関係をインストールします：pip install -r application/requirements.txt

7. flask --app application/app.py run --host=0.0.0.0 --port=7091を使用してアプリを実行します。

8. celery -A application.app.celery worker -l INFOを使用してワーカーを起動しますSource 0。

使い方

DocsGPTの使い方は非常に直感的です。基本的な操作は以下の通りです：

1. プロジェクトに関する質問を入力します。
2. DocsGPTは質問を理解し、プロジェクトのドキュメンテーションから関連する情報を抽出します。
3. 得られた結果は、ユーザーが理解しやすい形式で表示されます。

また、DocsGPTはユーザーがコードを編集し、変更をライブでプレビューすることも可能です。これは、AIが特定のスタイルをミスした場合やセクションを見落とした場合に有用ですSource 0。