dialog chat bot

Chatbot de telegrama de Operai Telegram

Este es un Telegram Chatbot basado en Python que utiliza la API de OpenAI con modelos GPT-3.5-TURBO-* para proporcionar respuestas de conversación a los usuarios de una manera que consciente con el contexto de diálogo.

Puede configurar fácilmente los parámetros de los modelos OperaI para el chatbot utilizando el archivo models.yml . Este enfoque permite ajustes rápidos de la configuración del modelo como temperature , max_tokens , voice , etc. sin alterar el código. Simplemente edite el archivo models.yml para cambiar el estilo de comportamiento y respuesta de su chatbot según sea necesario.

Características

• Proporciona respuestas de conversación a la entrada del usuario, utilizando la API de OpenAI.
• Capacidad para configurar fácilmente múltiples modelos y elegir entre ellos.
• Admite la entrada de voz (procesa el habla a texto utilizando el modelo Operai Whisper).
• Admite la salida de voz (procesa texto al habla utilizando el modelo OpenAI TTS).
• Puede manejar múltiples conversaciones con diferentes usuarios simultáneamente.

Requisitos

• Python 3.11+
• ffmpeg
• Cuenta Operai y saldo positivo de la cuenta. Los nuevos usuarios obtienen $ 5.

? Comienzo rápido

1. Instale el bot : elija entre una instalación local o use Docker. Consulte la sección de instalación para obtener pasos detallados.
2. Interactúe con su bot : una vez que el bot está en funcionamiento, abra el telegrama y comience a enviar mensajes a su bot.

Instalación

Local

• Clon o descargar el repositorio.

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

• Vea la rama GPT-3.5-Turbo .

   git checkout gpt-3.5-turbo
  

• Cree un entorno virtual y activelo e instalar dependencias.

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

• Para usar mensajes de voz, instale 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
  

• Copie/renombre .env.dist a .env y llénelo con datos.

   cp .env.dist .env
  

  • Configure un bot de telegrama y obtenga un token BOT (ver https://medium.com/geekculture/generate-telegram-token-for-bot-api-d26faf9bf064 para instrucciones).

  • Configure una cuenta de OpenAI y obtenga una clave API (consulte https://beta.openai.com/docs/quickstart para obtener instrucciones).

• Ejecuta el bot.

   python bot.py
  

Estibador

• Instale Docker y Docker Compose (enlace si no sabe cómo).

• Copie/renombre .env.dist a .env y llénelo con datos.

   cp .env.dist .env
  

• Ahora simplemente construya la imagen y ejecútala con Docker Compose:

 docker compose build
docker compose up -d

Uso y configuración

Para comenzar a interactuar con el bot, envíe cualquier mensaje al bot del telegrama.

El chatbot utiliza configuraciones especificadas en el archivo models.yml para adaptar sus respuestas. Este archivo permite una personalización detallada de los parámetros del modelo Operai, ofreciendo flexibilidad para ajustar el comportamiento del bot de acuerdo con las diferentes necesidades o contextos.

Configuración de modelos con models.yml

El archivo models.yml en el directorio del proyecto contiene configuraciones para diferentes modelos o escenarios. Aquí le mostramos cómo configurarlo:

1. Selección de un modelo : debajo de la tecla models , puede definir múltiples configuraciones.

   Cada configuración puede especificar un modelo Operai diferente. Por ejemplo, la configuración default utiliza gpt-3.5-turbo con un límite max_tokens de 100. Debe establecer un nombre de configuración del modelo en la variable de entorno MODEL_CONFIG_NAME para seleccionar la configuración.

2. Configuración del modelo de chat de OpenAI (Sección chat_model ) :

   • ID de modelo : elija la ID de modelo apropiada para su caso de uso. Las opciones disponibles incluyen varias versiones del modelo gpt-3.5-turbo , cada una con diferentes capacidades y tamaños de ventana de contexto.
   • Tokens máximos : esta configuración requerida controla la longitud de salida al limitar el número máximo de tokens que genera el modelo.
   • Penalización de frecuencia : ajuste cómo se generan nuevos tokens en función de su frecuencia hasta ahora. Los valores positivos reducen la repetición.
   • Presencia Penalización : Influir en la generación de nuevos tokens basados ​​en su presencia en la conversación, promoviendo la diversidad en los temas.
   • Temperatura : controlar la aleatoriedad de las respuestas. Los valores más bajos dan como resultado un texto más predecible, mientras que los valores más altos aumentan la diversidad.
   • Top P : una alternativa a la temperatura, enfocando el modelo en los tokens más probables o en un conjunto más amplio, dependiendo del valor.
   • Detener : Defina secuencias específicas que indiquen al modelo para que deje de generar más tokens, útil para administrar el flujo de conversación.

3. Configuración del comportamiento de chatbot (sección chatbot ) :

   • Descripción : Establezca un contexto o papel para el chatbot al comienzo de la conversación, guiando sus respuestas y estilo.
   • Longitud : el parámetro max_context_len define el número total de tokens (entradas de usuario y respuestas de bot) considerado en una sola ventana de conversación. Ajustar esto ayuda a administrar los detalles del historial de conversación y puede afectar los requisitos computacionales y la facturación.

4. Configuración de la voz de Bot (sección voice ) :

   • Modelo : Elija entre modelos disponibles de texto a voz (TTS) para definir la calidad y las características de la salida de voz. Las opciones incluyen TTS-1 para calidad estándar y TTS-1-HD para audio de alta definición. Esta configuración determina la tecnología base para la síntesis de voz.
   • Voz : seleccione la identidad de voz específica para usar en las opciones compatibles: alloy , echo , fable , onyx , nova y shimmer . Cada voz tiene un tono y estilo únicos.
   • Velocidad : ajuste la velocidad de reproducción del audio generado, con un rango de 0.25 (más lento) a 4.0 (más rápido). La configuración predeterminada es 1, que representa la velocidad normal.

? Solución de problemas

• Problemas de mensaje de voz : si el bot no procesa los mensajes de voz, asegúrese de que FFMPEG esté instalado en la máquina host. Verifique los registros del bot para obtener cualquier mensaje de error relacionado con el procesamiento de voz.
• Restricciones de acceso : los usuarios en ciertas regiones, como Rusia, pueden encontrar bloques al intentar acceder a los servicios de OpenAI, lo que resulta en que el bot que devuelva una página de error HTML. Para eludir esto, configure una VPN en su máquina de alojamiento o considere alojar el bot en una ubicación geográfica diferente donde hay servicios de OpenAI disponibles.