TeleGPT

Telegpt

API -Dokumente | Veröffentlichungen | Twitter

Ein Out-of-Box-Chatgpt-Bot für Telegramm.

Telegpt ist ein Telegrammbot, das auf Teloxid -Framework und async_openai basiert. Es bietet eine einfache Möglichkeit, mit den neuesten ChatGPT -Modellen zu interagieren, die Ihren eigenen API -Schlüssel verwenden.

Merkmale

? Blitz schnell mit reinem Rust -Codebasis.
? Alle Arten von Chat (privat und gruppen-) Unterstützung.
Live -Streaming -Token für Ihre Nachrichtenblase.
⌨️ Telegram-Blaveed-Markdown- Rendering-Unterstützung.
? TOKEN -Nutzungsstatistikaufzeichnung und abfragbar über Befehle.
Vollständig anpassbar mit der dateibasierten Konfiguration.
Administratorfunktionen (Beta) und Benutzerzugriffskontrolle unterstützt.

Telegpt bekommen

Docker

Wir empfehlen Ihnen, das vorgebaute Docker -Bild bei der Bereitstellung eines dedizierten Servers zu verwenden. Es wird über GitHub Containerregistrierung per GitHub -Aktion veröffentlicht. Derzeit werden Maschinen mit AMD64 -Architektur unterstützt.

1. Melden Sie sich bei GitHub Container Registry an (erforderlich, wenn sie beim Ziehen nicht autorisiert sind):

docker login -u your_github_username -p your_personal_access_token https://ghcr.io

2. Erstellen Sie eine config.json -Datei mit der Vorlage:

cp config.json.example config.json

Befolgen Sie die folgenden Anweisungen, um Token in config.json auszufüllen.

• Get Telegram Bot Tokens: https://core.telegram.org/bots/tutorial
• Holen Sie sich OpenAI-API-Token: https://platform.openai.com/account/api-keys

3. Starten Sie den Docker -Container:

docker-compose up -d # start the container

Andere Befehle, die Sie möglicherweise nützlich finden:

docker-compose logs -f # check the logs, press ctrl+c to stop viewing
docker-compose down # stop the container
docker-compose pull # pull the latest image

Herunterladen von Release

Um intern im Haus bereitzustellen oder zu testen, können Sie die vorgefertigte Binärdatei direkt von der Seite "Releases" herunterladen. Derzeit werden Linux- und MacOS -Hosts (Intel und Apple Silicon) unterstützt.

Aus der Quelle bauen

Klonen Sie das Repository und rennen Sie:

$ cargo build --release

Verwendung

Sie müssen eine Konfigurationsdatei erstellen, bevor Sie den Bot ausführen. Das Programm liest standardmäßig telegpt.config.json aus Ihrem aktuellen Arbeitsverzeichnis. Sie können auch den Konfigurationsdateipfad über -c angeben.

Die Konfiguration wird in diesem Dokument beschrieben, und hier ist ein Beispiel:

{
  "openaiAPIKey" : " sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx " ,
  "botToken" : " 8888888888:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX " ,
  "adminUsernames" : [ " cyandev " ],
  "conversationLimit" : 30 ,
  "databasePath" : " ./path/to/telegpt.sqlite " ,
  "i18n" : {
    "resetPrompt" : " I’m ready for a new challenge. What can I do for you now? "
  }
}

Um den Bot zu starten, rennen Sie einfach:

$ /path/to/telegpt

Wenn Sie sehen, dass die Nachricht Bot is started , sind Sie bereit zu gehen!

Aktivieren Sie die ausführliche Protokollierung

Hinweis: Die Eingabe der Benutzer wird in DEBUG -Level angemeldet. Um die Privatsphäre der Benutzer zu schützen, aktivieren Sie dies bitte nicht in der Produktionsumgebung.

Für das Debugging -Zweck können Sie die ausführlichen Protokolle aktivieren, indem Sie die Umgebungsvariable RUST_LOG einstellen. Zum Beispiel:

$ RUST_LOG=TRACE /path/to/telegpt

Admin -Funktionen (Beta)

Diese Funktion hängt von der Datenbank ab, um die Konfigurationen zu speichern. Um sicherzustellen, dass Ihre Daten nach dem Wiederaufbau nicht verloren gehen, müssen Sie einen Datenbankpfad in der Konfigurationsdatei festlegen.

Der Bot verfügt über einige grundlegende Verwaltungsfunktionen integriert. Sie können steuern, wer den Bot verwenden dürfen und die Mitgliedsliste über eine Reihe von Befehlen dynamisch ändern.

Standardmäßig ist der Bot für die öffentliche Verwendung verfügbar. Es bedeutet, dass jeder, der es hinzufügt, mit ihm chatten kann, was Ihre Token stark kosten kann. Wenn Sie den Bot nur innerhalb einer kleinen Gruppe von Personen bereitstellen und verwenden möchten, senden Sie den Befehl /set_public off , um den Bot privat zu machen. Wenn Sie es erneut öffentlich machen möchten, senden Sie /set_public on .

Wenn sich der Bot im privaten Modus befindet, können nur Admin -Benutzer und eingeladene Mitglieder damit chatten. Sie können Mitglieder über /add_member und /del_member addieren oder löschen. Das Argument ist der Benutzername . Zum Beispiel: /add_member cyandev .

Derzeit können nur Admin -Benutzer Admin -Befehle verwenden, andere Mitgliederbenutzer dürfen sie nicht verwenden.

Datenbank

Der Bot verwendet die SQLite -Datenbank, um einige Daten zu speichern, die während der Laufzeit erstellt wurden. Wenn Sie standardmäßig keinen lokalen Dateipfad angeben, werden die Daten in der Speicherdatenbank gespeichert. Wenn Sie den Bot neu starten, gehen alle früheren Daten (z. B. hinzugefügte Mitglieder) verloren. Wir empfehlen Ihnen, die Datei-basierte Datenbank für Usability zu verwenden.

Roadmap

Telegpt wird in letzter Zeit aktiv aufrechterhalten, es gibt einige geplante Funktionen in der Entwicklung.

• Wiederholen Sie es mit exponentiellem Backoff.
• Gesprächsvoreinstellungen.
• Benutzerfreundlichere Schnittstelle für Administratorvorgänge.
• Fernbedienung mit HTTP -APIs.

Beitrag

Probleme und PRs sind begrüßt. Bevor Sie neue Probleme oder PRs einreichen, ist es besser, zuerst die vorhandenen zu überprüfen. Diskussionen und Feature -Anfragen sind schön zu haben, bevor Sie an etwas arbeiten.

Lizenz

MIT