dialog chat bot

Openai Telegramチャットボット

これは、GPT-3.5-Turbo-*モデルを使用してOpenai APIを使用して、ダイアログコンテキストを意識した方法でユーザーに会話の応答を提供するPythonベースのTelegram Chatbotです。

models.ymlファイルを使用して、ChatbotのOpenAIモデルのパラメーターを簡単に構成できます。このアプローチにより、コードを変更せずに、 temperature 、 max_tokens 、 voiceなどのモデル設定をすばやく調整できます。 models.ymlを編集するだけで、必要に応じてチャットボットの動作と応答スタイルを変更してください。

特徴

• OpenAI APIを使用して、ユーザー入力に対する会話の応答を提供します。
• 複数のモデルを簡単に構成し、それらを選択する機能。
• 音声入力をサポートします（Openai Whisperモデルを使用してテキストにスピーチを処理します）。
• 音声出力をサポートします（OpenAI TTSモデルを使用してテキストから音声までテキストを処理します）。
• 異なるユーザーとの複数の会話を同時に処理できます。

要件

• Python 3.11+
• ffmpeg
• OpenAIアカウントと肯定的なアカウント残高。新規ユーザーは5ドルを取得します。

？クイックスタート

1. ボットのインストール：ローカルインストールのいずれかを選択するか、Dockerを使用します。詳細な手順については、インストールセクションを参照してください。
2. ボットと対話する：ボットが稼働していたら、電報を開けてボットにメッセージの送信を開始します。

インストール

地元

• リポジトリをクローンまたはダウンロードします。

   git clone [email protected]:welel/dialog-chat-bot.git
  

• GPT-3.5-Turboブランチのチェックアウト。

   git checkout gpt-3.5-turbo
  

• 仮想環境を作成し、それをアクティブにし、依存関係をインストールします。

   python -m venv env
  source env/bin/activate
  pip install --upgrade pip && pip install -r requirements.txt
  

• ボイスメッセージを使用するには、FFMPEGをインストールしてください。

   # on Ubuntu or Debian
   sudo apt update && sudo apt install ffmpeg
   
   # on Arch Linux
   sudo pacman -S ffmpeg
   
   # on MacOS using Homebrew (https://brew.sh/)
   brew install ffmpeg
   
   # on Windows using Chocolatey (https://chocolatey.org/)
   choco install ffmpeg
   
   # on Windows using Scoop (https://scoop.sh/)
   scoop install ffmpeg
  

• .env.dist to .envにコピー/名前を付けて、データを入力します。

   cp .env.dist .env
  

  • 電報ボットをセットアップしてボットトークンを取得します（https://medium.com/geekculture/generate-telegram-token-for-bot-api-d26faf9bf064を参照）。

  • OpenAIアカウントを設定してAPIキーを取得します（手順についてはhttps://beta.openai.com/docs/quickstartを参照）。

• ボットを実行します。

   python bot.py
  

Docker

• DockerとDocker Composeをインストールします（方法がわからない場合はリンク）。

• .env.dist to .envにコピー/名前を付けて、データを入力します。

   cp .env.dist .env
  

• ここで、単に画像を作成し、Docker Composeで実行します。

 docker compose build
docker compose up -d

使用法と構成

ボットとの対話を開始するには、テレグラムボットにメッセージを送信します。

チャットボットは、 models.ymlファイルで指定された構成を使用して、その応答を調整します。このファイルにより、OpenaIモデルパラメーターの詳細なカスタマイズが可能になり、さまざまなニーズやコンテキストに応じてボットの動作を調整する柔軟性が提供されます。

models.ymlを使用してモデルを構成します

Project Directoryのmodels.ymlファイルには、さまざまなモデルまたはシナリオの構成が含まれています。これを構成する方法は次のとおりです。

1. モデルの選択： modelsキーの下で、複数の構成を定義できます。

   各構成は、異なるOpenAIモデルを指定できます。たとえば、 default構成では、 max_tokensリミット100のgpt-3.5-turboを使用します。環境変数MODEL_CONFIG_NAMEでモデル構成名を設定して、構成を選択する必要があります。

2. OpenAIチャットモデルの構成（ chat_modelセクション） ：

   • モデルID ：ユースケースに適切なモデルIDを選択します。利用可能なオプションにはgpt-3.5-turboモデルのさまざまなバージョンが含まれ、それぞれ異なる機能とコンテキストウィンドウサイズを備えています。
   • Max Tokens ：この必要な設定は、モデルが生成するトークンの最大数を制限することにより、出力の長さを制御します。
   • 周波数ペナルティ：これまでの頻度に基づいて、新しいトークンの生成方法を調整します。正の値は繰り返しを減らします。
   • 存在ペナルティ：会話での存在に基づいて、新しいトークンの生成に影響を与え、トピックの多様性を促進します。
   • 温度：応答のランダム性を制御します。値が低いと予測可能なテキストになりますが、値が高いほど多様性が増加します。
   • トップP ：値に応じて、モデルを最も可能性の高いトークンまたはより広いセットに焦点を合わせ、温度に代わるものです。
   • 停止：モデルがさらにトークンの生成を停止するように示す特定のシーケンスを定義します。これは、会話の流れを管理するのに役立ちます。

3. チャットボットの動作の構成（ chatbotセクション） ：

   • 説明：会話の開始時にチャットボットのコンテキストまたは役割を設定し、その応答とスタイルを導きます。
   • 長さ： max_context_lenパラメーターは、単一の会話ウィンドウで考慮されるトークン（ユーザー入力とボット応答）の総数を定義します。これを調整すると、会話履歴の詳細を管理し、計算要件と請求に影響を与える可能性があります。

4. ボットの音声の構成（ voiceセクション） ：

   • モデル：Voice出力の品質と特性を定義するために、利用可能なテキストからスピーチ（TTS）モデルを選択します。オプションには、標準品質のTTS-1と高解像度オーディオのTTS-1-HDが含まれます。この設定により、音声合成のベーステクノロジーが決定されます。
   • 音声：サポートされているオプションから使用する特定の音声IDを選択します： alloy 、 echo 、 fable 、 onyx 、 nova 、およびshimmer 。各声にはユニークなトーンとスタイルがあります。
   • 速度：生成されたオーディオの再生速度を調整し、0.25（より遅い）から4.0（より速い）の範囲の範囲を調整します。デフォルト設定は1で、通常の速度を表します。

？トラブルシューティング

• 音声メッセージの問題：ボットが音声メッセージの処理に失敗した場合、FFMPEGがホストマシンにインストールされていることを確認してください。音声処理に関連するエラーメッセージについては、ボットのログを確認してください。
• アクセス制限：ロシアなどの特定の地域のユーザーは、OpenAIサービスにアクセスしようとする際にブロックに遭遇する可能性があり、BOTがHTMLエラーページを返します。これを回避するには、ホスティングマシンでVPNを構成するか、Openaiサービスが利用可能な別の地理的場所でボットをホストすることを検討してください。