dialog chat bot

Openai Telegram Chatbot

Este é um chatbot de telegramas baseado em Python que usa a API do OpenAI com os modelos GPT-3.5-Turbo-* para fornecer respostas de conversação aos usuários de uma maneira com reconhecimento de contexto de diálogo.

Você pode configurar facilmente os parâmetros dos modelos OpenAI para o chatbot usando o arquivo models.yml . Essa abordagem permite ajustes rápidos de configurações de modelo, como temperature , max_tokens , voice e assim por diante, sem alterar o código. Simplesmente edite o arquivo models.yml para alterar o comportamento e o estilo de resposta do seu chatbot, conforme necessário.

Características

• Fornece respostas de conversação à entrada do usuário, usando a API OpenAI.
• Capacidade de configurar facilmente vários modelos e escolher entre eles.
• Suporta entrada de voz (processos de fala para texto usando o modelo de sussurro do OpenAI).
• Suporta saída de voz (processa texto para fala usando o modelo OpenAI TTS).
• Pode lidar com várias conversas com diferentes usuários simultaneamente.

Requisitos

• Python 3.11+
• ffmpeg
• Conta aberta e saldo positivo da conta. Novos usuários recebem US $ 5.

? Início rápido

1. Instale o bot : escolha entre uma instalação local ou usando o Docker. Consulte a seção de instalação para etapas detalhadas.
2. Interaja com o seu bot : Depois que o bot estiver em funcionamento, abra o telegrama e comece a enviar mensagens para o seu bot.

Instalação

Local

• Clone ou faça o download do repositório.

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

• Fecha na filial GPT-3.5-Turbo .

   git checkout gpt-3.5-turbo
  

• Crie um ambiente virtual e ative -o e instale dependências.

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

• Para usar mensagens de voz, instale o 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/renomeie .env.dist para .env e preencha -o com dados.

   cp .env.dist .env
  

  • Configure um bot de telegrama e obtenha um token de bot (consulte https://medium.com/geekculture/gereate-telegram-token-for-bot-api-d26faf9bf064 para obter instruções).

  • Configure uma conta OpenAI e obtenha uma chave da API (consulte https://beta.openai.com/docs/quickstart para obter instruções).

• Execute o bot.

   python bot.py
  

Docker

• Instale o Docker e o Docker Compose (link se você não souber).

• Copie/renomeie .env.dist para .env e preencha -o com dados.

   cp .env.dist .env
  

• Agora basta construir a imagem e executá -la com o Docker Compose:

 docker compose build
docker compose up -d

Uso e configuração

Para começar a interagir com o bot, envie qualquer mensagem para o bot de telegrama.

O chatbot usa configurações especificadas no arquivo models.yml para adaptar suas respostas. Esse arquivo permite a personalização detalhada dos parâmetros do modelo OpenAI, oferecendo flexibilidade para ajustar o comportamento do bot de acordo com diferentes necessidades ou contextos.

Configurando modelos com models.yml

O arquivo models.yml no diretório do projeto contém configurações para diferentes modelos ou cenários. Veja como configurá -lo:

1. Selecionando um modelo : na chave dos models , você pode definir várias configurações.

   Cada configuração pode especificar um modelo OpenAI diferente. Por exemplo, a configuração default usa gpt-3.5-turbo com um limite max_tokens de 100. Você precisa definir um nome de configuração de modelo no ambiente variável MODEL_CONFIG_NAME para selecionar a configuração.

2. Configurando o modelo de bate -papo do OpenAI (seção chat_model ) :

   • ID do modelo : escolha o ID do modelo apropriado para o seu caso de uso. As opções disponíveis incluem várias versões do modelo gpt-3.5-turbo , cada uma com diferentes recursos e tamanhos das janelas de contexto.
   • Tokens máximos : esta configuração necessária controla o comprimento da saída, limitando o número máximo de tokens que o modelo gera.
   • Pena de frequência : ajuste como os novos tokens são gerados com base em sua frequência até agora. Os valores positivos reduzem a repetição.
   • Pena de presença : influencie a geração de novos tokens com base em sua presença na conversa, promovendo a diversidade de tópicos.
   • Temperatura : Controle a aleatoriedade das respostas. Valores mais baixos resultam em texto mais previsível, enquanto valores mais altos aumentam a diversidade.
   • Top P : Uma alternativa à temperatura, focando o modelo nos tokens mais prováveis ​​ou em um conjunto mais amplo, dependendo do valor.
   • Pare : Defina sequências específicas que sinalizam o modelo para parar de gerar tokens adicionais, úteis para gerenciar o fluxo de conversas.

3. Configurando o comportamento do chatbot (seção chatbot ) :

   • Descrição : Defina um contexto ou função para o chatbot no início da conversa, orientando suas respostas e estilo.
   • Comprimento : o parâmetro max_context_len define o número total de tokens (entradas do usuário e respostas de bot) consideradas em uma única janela de conversa. Ajustar isso ajuda a gerenciar os detalhes do histórico de conversação e pode afetar os requisitos computacionais e o faturamento.

4. Configurando a voz de Bot (seção voice ) :

   • Modelo : Escolha entre os modelos disponíveis de texto em fala (TTS) para definir a qualidade e as características da saída de voz. As opções incluem TTS-1 para qualidade padrão e TTS-1-HD para áudio de alta definição. Essa configuração determina a tecnologia base para a síntese de voz.
   • Voz : selecione a identidade de voz específica a ser usada nas opções suportadas: alloy , echo , fable , onyx , nova e shimmer . Cada voz tem um tom e estilo únicos.
   • Velocidade : ajuste a velocidade de reprodução do áudio gerado, com um intervalo de 0,25 (mais lento) a 4,0 (mais rápido). A configuração padrão é 1, representando a velocidade normal.

? Solução de problemas

• Problemas de mensagem de voz : se o bot não conseguir processar mensagens de voz, verifique se o FFMPEG está instalado na máquina host. Verifique os logs do bot para obter mensagens de erro relacionadas ao processamento de voz.
• Restrições de acesso : os usuários de determinadas regiões, como a Rússia, podem encontrar blocos ao tentar acessar os serviços do OpenAI, resultando na página de erro de Bot retornando uma página de erro HTML. Para contornar isso, configure uma VPN em sua máquina de hospedagem ou considere hospedar o bot em um local geográfico diferente, onde os serviços do OpenAI estão disponíveis.