telegram_openai_assistant

Openaiアシスタントテレグラムボット

このリポジトリは、OpenAIアシスタントを電報ボットと統合するための一般的なフレームワークを提供します。これにより、ユーザーはTelegramプラットフォームを介してOpenAIを搭載した会話エージェントと対話できます。

特徴

• ユーザークエリへのリアルタイムの応答。
• 毎日のメッセージカウント追跡。
• 将来の検索と分析のための質問と回答のペアの保存。

前提条件

開始する前に、次の要件を満たしていることを確認してください。

• バージョン3.7+を実行しているPython環境があります。
• 電報アカウントがあり、トークンを取得するために@BotFatherとボットを作成しました。
• APIキーを取得するためのOpenAIアカウントがあります。

あなたも必要です

• オープンAIアシスタントID：https：//platform.openai.com/assistants
• オープンAI APIキー：https：//platform.openai.com/api-keys
• 電報トークン：テレグラムからボットファーザーを直接使用してボットを作成し、電報トークンを取得します

インストール

リポジトリをローカルマシンにクローンします。

git clone https://github.com/efelem/telegram_openai_assistant
cd telegram_openai_assistant

パッケージをインストールします：

pip install -e . 

構成

ルートディレクトリに.envファイルを作成し、OpenAIおよびTelegramの資格情報を入力します。

 ASSISTANT_ID = your-assistant-id
CLIENT_API_KEY = your-openai-api-key
TELEGRAM_TOKEN = your-telegram-bot-token 

使用法

ボットを起動するには、端末で次のコマンドを実行します。

chatbot

ボットが実行され、電報ボットインターフェイスを介して対話することができます。

DeepSquareでTelegram Botクライアントを起動します

job.telegram_openai_assistant.yamlワークフローファイルを使用して、リポジトリのワークフローファイルを使用して、Telegram Botクライアントを簡単に起動できます。これらの簡単な手順に従って開始します。

DeepSquareプラットフォームを介して起動します

1. DeepSquareプラットフォームにログイン： app.deepsquare.runにログインしていることを確認してください。
2. ワークフローに移動する：プラットフォームの「ワークフロー」セクションに移動します。
3. 新しいワークフローを作成する： 「新しいワークフロー」をクリックして、 job.telegram_openai_assistant.yamlファイルのコンテンツを貼り付けてコピーします
4. ワークフローの開始：作成したら、「実行ワークフロー」ボタンをクリックしてワークフローを開始できます。
5. 監視とアクセス： 「ジョブ」セクションでジョブの進捗状況を監視します。完了したら、ジョブログに記載されている指示に従って、電報ボットにアクセスします。

DeepSquareコマンドラインツールを介して起動します

1. DeepSquare CLIをインストールする：まだお持ちでない場合は、DeepSquare CLIツールをインストールしてください。ここに指示があります。

2. リポジトリのクローン： job.telegram_openai_assistant.yamlファイルを含むリポジトリをクローンします。

3. リポジトリディレクトリに移動します。端末を開き、ディレクトリに移動し、そこでリポジトリをクローニングしました。

4. ワークフローファイルを実行します。次のコマンドを実行します。

   deepsquare run job.telegram_openai_assistant.yaml

5. ジョブの監視：次のコマンドを使用して、ジョブのステータスを監視してください。

   deepsquare status

6. Telegram Botにアクセス：ジョブが完了したら、ジョブログで提供されている指示に従って、Telegramボットにアクセスして対話します。

これらの手順に従うことにより、DeepSquareでTelegram Botクライアントと簡単に起動してやり取りできます。

貢献

貢献は、オープンソースコミュニティを学び、インスピレーションを与え、作成するのに驚くべき場所にするものです。あなたがする貢献はどんな貢献も大歓迎です。

1. プロジェクトをフォークします
2. 機能ブランチを作成します（ `git checkout -b feature/AmazingFeature`）
3. あなたの変更をコミットします（ `git commit -m 'いくつかのAmazingFeature'を追加）
4. ブランチへのプッシュ（ `gitプッシュオリジン機能/AmazingFeature`）
5. プルリクエストを開きます

ライセンス

MITライセンスの下で配布されます。詳細については、「ライセンス」を参照してください。

接触

プロジェクトリンク：https：//github.com/efelem/telegram_openai_assistant