telegram_openai_assistant

OpenAI Assistent Telegram Bot

Dieses Repository bietet einen allgemeinen Rahmen für die Integration eines OpenAI -Assistenten mit einem Telegrammbot. Es ermöglicht Benutzern, über die Telegrammplattform mit dem OpenAI-angetriebenen Konversationsagenten zu interagieren.

Merkmale

• Echtzeit-Antwort auf Benutzeranfragen.
• Tägliche Meldungszahl Tracking.
• Speicherung von Fragen- und Beantwortungspaaren für zukünftige Abruf und Analyse.

Voraussetzungen

Stellen Sie vor Beginn sicher, dass Sie die folgenden Anforderungen erfüllt haben:

• Sie haben eine Python -Umgebung, in der Version 3.7+ ausgeführt wird.
• Sie haben ein Telegrammkonto und haben einen Bot mit @BotFather erstellt, um ein Token zu erhalten.
• Sie haben ein OpenAI -Konto, um Ihre API -Schlüssel zu erhalten.

Sie brauchen auch

• Eine Open AI Assistant ID: https://platform.openai.com/assistants
• Ein offener AI-API-Schlüssel: https://platform.openai.com/api-keys
• Ein Telegramm -Token: Verwenden Sie Botfather direkt aus Telegramm, um Ihren Bot zu erstellen und das Telegramm -Token zu erhalten

Installation

Klonen Sie das Repository in Ihre lokale Maschine:

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

Installieren Sie die Pakete:

pip install -e . 

Konfiguration

Erstellen Sie eine .env -Datei im Stammverzeichnis und füllen Sie Ihre OpenAI- und Telegramm -Anmeldeinformationen aus:

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

Verwendung

Führen Sie den folgenden Befehl in Ihrem Terminal aus, um den Bot zu starten:

chatbot

Der Bot sollte jetzt ausgeführt werden und kann über Ihre Telegramm -Bot -Schnittstelle miteinander interagiert werden.

Starten des Telegram Bot -Kunden in DeepSquare

Sie können den Telegram -Bot -Client problemlos mit der Workflow -Datei job.telegram_openai_assistant.yaml in unserem Repository starten. Befolgen Sie diese einfachen Schritte, um loszulegen:

Starten Sie durch die DeepSquare -Plattform

1. Melden Sie sich bei der DeepSquare -Plattform an: Stellen Sie sicher, dass Sie in app.deepSquare.run angemeldet sind.
2. Navigieren Sie zu Workflows: Gehen Sie zum Abschnitt "Workflows" in der Plattform.
3. Erstellen Sie einen neuen Workflow: Klicken Sie auf den 'neuen job.telegram_openai_assistant.yaml ' und kopieren
4. Starten Sie den Workflow: Nach dem Erstellen können Sie den Workflow starten, indem Sie auf die Schaltfläche "Workflow ausführen" klicken.
5. Überwachen und Zugriff: Überwachen Sie den Fortschritt Ihres Jobs im Abschnitt "Jobs". Greifen Sie nach Abschluss nach Abschluss auf den Telegramm -Bot gemäß den Anweisungen in den Jobprotokollen zu.

Starten Sie durch das DeepSquare Command Line Tool

1. Installieren Sie DeepSquare CLI: Wenn Sie es noch nicht getan haben, installieren Sie das DeepSquare CLI -Tool. Anweisungen finden Sie hier.

2. Klonen Sie das Repository: Klonen Sie das Repository, das den job.telegram_openai_assistant.yaml enthält.

3. Navigieren Sie zum Repository -Verzeichnis: Öffnen Sie ein Terminal und navigieren Sie zum Verzeichnis, in dem Sie das Repository kloniert haben.

4. Führen Sie die Workflow -Datei aus: Führen Sie den folgenden Befehl aus:

   deepsquare run job.telegram_openai_assistant.yaml

5. Überwachen Sie den Job: Verwenden Sie den folgenden Befehl, um den Status Ihres Jobs zu überwachen:

   deepsquare status

6. Zugriff auf den Telegrammbot: Sobald der Job abgeschlossen ist, befolgen Sie die Anweisungen in den Jobprotokollen, um den Telegramm -Bot zugreifen und mit dem Telegrammbot zu interagieren.

Wenn Sie diese Schritte befolgen, können Sie mühelos den Telegramm -Bot -Kunden auf DeepSquare starten und interagieren.

Beiträge

Beiträge machen die Open-Source-Community zu einem erstaunlichen Ort, um zu lernen, zu inspirieren und zu kreieren. Alle Beiträge, die Sie leisten, werden sehr geschätzt .

1. Geben Sie das Projekt auf
2. Erstellen Sie Ihre Funktionszweig (`Git Checkout -B -Funktion/AmazingFeature").
3. Begehen Sie Ihre Änderungen ("Git Commit -m" Fügen Sie einige erstaunliche Feature hinzu ")
4. Push in den Zweig ("Git Push Origin Feature/AmazingFeature")
5. Öffnen Sie eine Pull -Anfrage

Lizenz

Unter der MIT -Lizenz verteilt. Weitere Informationen finden Sie in "Lizenz".

Kontakt

Projektlink: https://github.com/efelem/telegram_openai_assistant