README in English

このプロジェクトは、OpenAI APIと連携してChatGPTを実装するDiscordボットです。
ユーザーごとにAPIキーを登録する形となっています。
Dockerを利用することが前提となっていますが、オンプレミスで構築することも可能です。
その際は適宜スクリプトを書き換えてください。

• Python 3.7以上
• Docker と Docker Compose
• OpenAI APIキー
• Discordボットトークン

ここではDiscord botの作成方法は割愛します。

1. リポジトリをクローンします：

   git clone https://github.com/Kawadian/DiscordGPT.git

2. クローンしたリポジトリに移動します

   cd ./DiscordGPT
   

3. 環境変数を設定します：

   .envファイルを作成し、以下の形式でDiscordのボットトークンを設定します：

   DISCORD_BOT_TOKEN=your_bot_token_here
   

4. Dockerイメージをビルドし、コンテナを起動します：

   docker-compose up

Discord上でボットをメンションするか、ボットにDMを送ると、OpenAI APIを通じて応答を生成します。初めて使用する場合、「/save_token」コマンドを使用してOpenAI APIのトークンを設定する必要があります。

/save_token：openaiのapiキーを保存します。

/delete_token：openaiのapiキーをサーバーから削除します。

/set_model：応答するモデルを変更します。

このプロジェクトではMariaDBを使用しています。データベースの設定はdocker-compose.ymlファイルで行います。

• OpenAI APIとDiscordの両方で使用量に制限があるため、適切な使用量を確認してください。
• このボットは学習型AIを使用しており、ユーザーからのすべてのメッセージに対する正確な応答を保証するものではありません。使用には十分な注意が必要です。
• 当方プログラミング初心者なので、至らない点があるかもしれません。

このプロジェクトはMITライセンスのもとで公開されています。詳細はLICENSEをご覧ください。

プルリクエストやイシューの提出は大歓迎です。大規模な変更を提案する場合は、まずイシューを通じて変更を提案してください。

何か質問や提案がある場合は、お気軽にイシューを作成してください。