dialog chat bot

Chatbot télégramme ouvertai

Il s'agit d'un chatbot télégramme basé sur Python qui utilise l'API OpenAI avec des modèles GPT-3.5-Turbo- * pour fournir des réponses conversationnelles aux utilisateurs de manière consacrée au contexte de dialogue.

Vous pouvez facilement configurer les paramètres des modèles OpenAI pour le chatbot en utilisant le fichier models.yml . Cette approche permet des ajustements rapides des paramètres du modèle tels que temperature , max_tokens , voice et ainsi de suite sans modifier le code. Modifiez simplement le fichier models.yml pour modifier le comportement et le style de réponse de votre chatbot selon les besoins.

Caractéristiques

• Fournit des réponses conversationnelles à la saisie de l'utilisateur, en utilisant l'API OpenAI.
• Capacité à configurer facilement plusieurs modèles et à choisir entre eux.
• Prend en charge l'entrée vocale (traite la parole en texte en utilisant le modèle d'Openai Whisper).
• Prend en charge la sortie vocale (traite le texte vers la parole à l'aide du modèle OpenAi TTS).
• Peut gérer plusieurs conversations avec différents utilisateurs simultanément.

Exigences

• Python 3.11+
• ffmpeg
• Compte ouvert et solde de compte positif. Les nouveaux utilisateurs obtiennent 5 $.

? Démarrage rapide

1. Installez le bot : choisissez entre une installation locale ou à l'aide de Docker. Voir la section d'installation pour des étapes détaillées.
2. Interagissez avec votre bot : une fois le bot en marche, ouvrez télégramme et commencez à envoyer des messages à votre bot.

Installation

Locale

• Clone ou télécharger le référentiel.

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

• Découvrez sur la branche GPT-3.5-turbo .

   git checkout gpt-3.5-turbo
  

• Créez un environnement virtuel et activez-le et installez les dépendances.

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

• Pour utiliser les messages vocaux, veuillez installer 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
  

• Copier / renommer .env.dist à .env et les remplir de données.

   cp .env.dist .env
  

  • Configurez un bot télégramme et obtenez un jeton de bot (voir https://medium.com/geekculture/generate-telegram-token-for-bot-api-d26faf9bf064 pour les instructions).

  • Configurez un compte OpenAI et obtenez une clé API (voir https://beta.openai.com/docs/quickstart pour les instructions).

• Exécutez le bot.

   python bot.py
  

Docker

• Installez Docker et Docker Compose (lien si vous ne savez pas comment).

• Copier / renommer .env.dist à .env et les remplir de données.

   cp .env.dist .env
  

• Maintenant, construisez simplement l'image et exécutez-la avec Docker Compose:

 docker compose build
docker compose up -d

Utilisation et configuration

Pour commencer, interagir avec le bot, envoyez n'importe quel message au bot télégramme.

Le chatbot utilise des configurations spécifiées dans le fichier models.yml pour adapter ses réponses. Ce fichier permet une personnalisation détaillée des paramètres du modèle OpenAI, offrant une flexibilité pour ajuster le comportement du bot en fonction de différents besoins ou contextes.

Configuration des modèles avec models.yml

Le fichier models.yml dans le répertoire de projet contient des configurations pour différents modèles ou scénarios. Voici comment le configurer:

1. Sélection d'un modèle : Sous la touche models , vous pouvez définir plusieurs configurations.

   Chaque configuration peut spécifier un modèle OpenAI différent. Par exemple, la configuration default utilise gpt-3.5-turbo avec une limite max_tokens de 100. Vous devez définir un nom de configuration de modèle dans la variable d'environnement MODEL_CONFIG_NAME pour sélectionner la configuration.

2. Configuration du modèle de chat Openai (section chat_model ) :

   • ID de modèle : choisissez l'ID de modèle approprié pour votre cas d'utilisation. Les options disponibles incluent différentes versions du modèle gpt-3.5-turbo , chacune avec différentes capacités et tailles de fenêtre de contexte.
   • Tokens max : Ce réglage requis contrôle la longueur de sortie en limitant le nombre maximum de jetons génère.
   • Pénalité de fréquence : ajustez la façon dont les nouveaux jetons sont générés en fonction de leur fréquence jusqu'à présent. Les valeurs positives réduisent la répétition.
   • Panne de présence : influencer la génération de nouveaux jetons en fonction de leur présence dans la conversation, favorisant la diversité des sujets.
   • Température : contrôler le caractère aléatoire des réponses. Des valeurs plus faibles entraînent un texte plus prévisible, tandis que des valeurs plus élevées augmentent la diversité.
   • Top P : Une alternative à la température, en concentrant le modèle sur les jetons les plus probables ou un ensemble plus large, selon la valeur.
   • Arrêt : Définissez des séquences spécifiques qui signalent le modèle pour arrêter de générer d'autres jetons, utile pour gérer le flux de conversation.

3. Configuration du comportement du chatbot (section chatbot ) :

   • Description : Définissez un contexte ou un rôle pour le chatbot au début de la conversation, en guidant ses réponses et son style.
   • Longueur : Le paramètre max_context_len définit le nombre total de jetons (entrées utilisateur et réponses BOT) considérés dans une seule fenêtre de conversation. L'ajustement de cela permet de gérer les détails de l'historique conversationnel et peut avoir un impact sur les exigences de calcul et la facturation.

4. Configuration de la voix de Bot (section voice ) :

   • Modèle : Choisissez entre les modèles de texte vocale disponibles (TTS) pour définir la qualité et les caractéristiques de la sortie vocale. Les options incluent TTS-1 pour la qualité standard et TTS-1-HD pour l'audio haute définition. Ce paramètre détermine la technologie de base pour la synthèse vocale.
   • Voix : Sélectionnez l'identité vocale spécifique à utiliser dans les options prises en charge: alloy , echo , fable , onyx , nova et shimmer . Chaque voix a un ton et un style uniques.
   • Vitesse : ajustez la vitesse de lecture de l'audio généré, avec une plage de 0,25 (plus lente) à 4,0 (plus rapide). Le paramètre par défaut est 1, représentant une vitesse normale.

? Dépannage

• Problèmes de messages vocaux : si le bot ne traite pas les messages vocaux, assurez-vous que FFMPEG est installé sur la machine hôte. Vérifiez les journaux du bot pour tous les messages d'erreur liés au traitement vocal.
• Restrictions d'accès : les utilisateurs de certaines régions, tels que la Russie, peuvent rencontrer des blocs lorsque vous essayez d'accéder aux services OpenAI, ce qui donne le retour sur une page d'erreur HTML. Pour contourner cela, configurez un VPN sur votre machine d'hébergement ou envisagez d'héberger le bot dans un emplacement géographique différent où les services OpenAI sont disponibles.