TeleGPT

Télégpt

Docs API | Sortie | Gazouillement

Un bot Chatgpt hors de boîte pour télégramme.

Telegpt est un bot télégramme basé sur le framework téloxyde et async_openai . Il fournit un moyen facile d'interagir avec les derniers modèles Chatgpt en utilisant votre propre clé API.

Caractéristiques

? Lightning Fast avec une base de code de rouille pure.
? Tous les types de supports de chat (privé et en groupe).
Les jetons en streaming en direct dans votre bulle de message.
⌨️ Les supports de rendu Markdown à saveur de télégramme .
? Enregistrement des statistiques d'utilisation de jetons et interrogable via les commandes.
Entièrement personnalisable avec la configuration basée sur des fichiers.
Fonctionnalités d'administration (BETA) et supports de contrôle d'accès des utilisateurs.

Obtenir Télégpt

Docker

Nous vous recommandons d'utiliser l'image Docker préfilée lors du déploiement d'un serveur dédié, il est publié via GitHub Container Registry par GitHub Action. Actuellement, les machines avec architecture AMD64 sont prises en charge.

1. Connectez-vous au registre des conteneurs GitHub (nécessaire si non autorisé lorsque vous tracez):

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

2. Créez un fichier config.json avec le modèle:

cp config.json.example config.json

Suivez les instructions ci-dessous pour remplir les jetons dans config.json .

• Get Telegram Bot Tokens: https://core.telegram.org/bots/tutorial
• Get Openai API Tokens: https://platform.openai.com/account/api-Keys

3. Démarrez le conteneur Docker:

docker-compose up -d # start the container

Autres commandes que vous pouvez trouver utiles:

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

Télécharger à partir de la sortie

Pour déployer ou tester en interne, vous pouvez télécharger le binaire pré-construit directement à partir de la page des versions. Actuellement, les hôtes Linux et MacOS (Intel et Apple Silicon) sont pris en charge.

Construire à partir de la source

Clone le référentiel et l'exécution:

$ cargo build --release

Usage

Vous devez créer un fichier de configuration avant d'exécuter le bot. Le programme lit telegpt.config.json à partir de votre répertoire de travail actuel par défaut, et vous pouvez également spécifier l'option de fichier de configuration via -c .

La configuration est décrite dans ce DOC, et voici un exemple:

{
  "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? "
  }
}

Pour démarrer le bot, exécutez simplement:

$ /path/to/telegpt

Lorsque vous voyez le message Bot is started , vous êtes prêt à partir!

Activer la journalisation verbeuse

Remarque: les entrées des utilisateurs seront enregistrées au niveau de DEBUG . Pour protéger la confidentialité des utilisateurs, veuillez ne pas l'activer dans l'environnement de production.

À des fins de débogage, vous pouvez activer les journaux verbeux en définissant la variable d'environnement RUST_LOG . Par exemple:

$ RUST_LOG=TRACE /path/to/telegpt

Fonctionnalités administratives (bêta)

Cette fonctionnalité dépend de la base de données pour stocker les configurations. Pour vous assurer que vos données ne seront pas perdues après la relance, vous devez définir un chemin de base de données dans le fichier de configuration.

Le bot a des fonctionnalités d'administration de base intégrées. Vous pouvez contrôler qui est autorisé à utiliser le bot et modifier dynamiquement la liste des membres via un ensemble de commandes.

Par défaut, le bot est disponible pour un usage public. Cela signifie que tous ceux qui l'ajoutent peuvent discuter avec, ce qui peut coûter fortement vos jetons. Si vous souhaitez déployer et utiliser le bot uniquement au sein d'un petit groupe de personnes, envoyez /set_public off commande pour rendre le bot privé. Lorsque vous souhaitez le rendre public, envoyer /set_public on .

Lorsque le bot est en mode privé, seuls les utilisateurs d'administration et les membres invités peuvent discuter avec. Vous pouvez ajouter ou supprimer des membres via la commande /add_member et /del_member . L'argument est le nom d'utilisateur . Par exemple: /add_member cyandev .

Actuellement, seuls les utilisateurs d'administration peuvent utiliser des commandes d'administration, d'autres utilisateurs membres ne sont pas autorisés à les utiliser.

Base de données

Le bot utilisera la base de données SQLite pour stocker certaines données produites pendant l'exécution. Par défaut, si vous ne fournissez pas de chemin de fichier local, les données seront stockées dans la base de données de mémoire. Lorsque vous redémarrez le bot, toutes les données précédentes (telles que les membres ajoutées) seront perdues. Nous vous recommandons d'utiliser la base de données basée sur des fichiers pour la convivialité.

Feuille de route

Telegpt sera activement maintenu récemment, il existe des fonctionnalités planifiées qui sont en développement.

• Réessayez avec un revers exponentiel.
• Préréglages de conversation.
• Interface plus conviviale pour les opérations administratives.
• Remote contrôlant avec les API HTTP.

Contribution

Les problèmes et les PR sont les bienvenus. Avant de soumettre de nouveaux problèmes ou PRS, il est préférable de vérifier d'abord les existants. Les discussions et les demandes de fonctionnalités sont agréables à avoir avant de commencer à travailler sur quelque chose.

Licence

Mit