dialog chat bot

Openai Telegram Chatbot

Это чат-бот Telegram на основе Python, который использует API OpenAI с моделями GPT-3.5-Turbo* для предоставления разговорных ответов на пользователей в диалоговом контекстном порядке.

Вы можете легко настроить параметры моделей OpenAI для чат -бота, используя файл models.yml . Этот подход позволяет быстро регулировать настройки модели, такие как temperature , max_tokens , voice и так далее, не изменяя код. Просто отредактируйте файл models.yml .

Функции

• Обеспечивает разговорные ответы на пользовательский ввод, используя API OpenAI.
• Возможность легко настроить несколько моделей и выбирать между ними.
• Поддерживает голосовой ввод (обрабатывает речь в текст, используя модель Openai Whisper).
• Поддерживает голосовой выход (обрабатывает текст в речь с помощью модели Openai TTS).
• Может одновременно обрабатывать несколько разговоров с разными пользователями.

Требования

• Python 3.11+
• ffmpeg
• Openai Account и положительный баланс счета. Новые пользователи получают 5 долларов.

? Быстрый старт

1. Установите бот : выберите между локальной установкой или с помощью Docker. См. Раздел установки для подробных шагов.
2. Взаимодействуйте с вашим ботом : как только бот запускается, откройте телеграмму и начните отправлять сообщения своему боту.

Установка

Местный

• Клонировать или загрузить репозиторий.

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

• Оформление на GPT-3.5-Turbo .

   git checkout gpt-3.5-turbo
  

• Создайте виртуальную среду, активируйте ее и установите зависимости.

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

• Чтобы использовать голосовые сообщения, установите 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
  

• Скопировать/переименовать .env.dist to .env и заполнить его данными.

   cp .env.dist .env
  

  • Установите бот Telegram и получите токен бота (см. Https://medium.com/geekculture/generate-telegram-token-for-bot-api-d26faf9bf064 для инструкций).

  • Установите учетную запись Openai и получите ключ API (см. Https://beta.openai.com/docs/quickstart для инструкций).

• Запустить бот.

   python bot.py
  

Докер

• Установите Docker и Docker Compose (ссылка, если вы не знаете, как).

• Скопировать/переименовать .env.dist to .env и заполнить его данными.

   cp .env.dist .env
  

• Теперь просто создайте изображение и запустите его с помощью Docker Compose:

 docker compose build
docker compose up -d

Использование и конфигурация

Чтобы начать взаимодействовать с ботом, отправьте любое сообщение в Telegram Bot.

Чатбот использует конфигурации, указанные в файле models.yml для адаптации его ответов. Этот файл обеспечивает подробную настройку параметров модели OpenAI, предлагая гибкость для регулировки поведения бота в соответствии с различными потребностями или контекстами.

Настройка моделей с models.yml

Файл models.yml в каталоге проекта содержит конфигурации для различных моделей или сценариев. Вот как это настроить:

1. Выбор модели : под ключом models вы можете определить несколько конфигураций.

   Каждая конфигурация может указать различную модель OpenAI. Например, конфигурация default использует gpt-3.5-turbo с пределом max_tokens 100. Вам необходимо установить имя конфигурации модели в переменной среды MODEL_CONFIG_NAME , чтобы выбрать конфигурацию.

2. Настройка модели чата OpenAI (раздел chat_model ) :

   • Идентификатор модели : выберите соответствующий идентификатор модели для вашего варианта использования. Доступные варианты включают в себя различные версии модели gpt-3.5-turbo , каждая из которых имеет различные возможности и размеры контекста.
   • Max Tokens : Эта необходимая настройка контролирует длину выходной сигналы, ограничивая максимальное количество токенов, которые генерирует модель.
   • Частотный штраф : Настройка того, как новые жетоны генерируются на основе их частоты до сих пор. Положительные значения уменьшают повторение.
   • Наказание о наличии : Влияйте на поколение новых жетонов на основе их присутствия в разговоре, способствуя разнообразию по темам.
   • Температура : контроль случайности ответов. Более низкие значения приводят к более предсказуемому тексту, в то время как более высокие значения увеличивают разнообразие.
   • Верхний P : альтернатива температуре, фокусируя модель на наиболее вероятных токенах или более широком наборе, в зависимости от значения.
   • Остановка : Определите конкретные последовательности, которые сигнализируют о модели, чтобы прекратить генерировать дальнейшие токены, полезные для управления потоком разговора.

3. Настройка поведения чат -бота (раздел chatbot ) :

   • Описание : Установите контекст или роль чат -бота в начале разговора, направляя его ответы и стиль.
   • Длина : параметр max_context_len определяет общее количество токенов (пользовательские входы и ответы бота), рассматриваемые в одном окне разговора. Корректировка этого помогает управлять деталями истории разговоров и может повлиять на вычислительные требования и выставление счетов.

4. Настройка голоса BOT ( voice раздел) :

   • Модель : выберите между доступными моделями текста в речь (TTS), чтобы определить качество и характеристики голосового вывода. Варианты включают TTS-1 для стандартного качества и TTS-1-HD для аудио высокой четкости. Эта настройка определяет базовую технологию для синтеза голоса.
   • Голос : выберите конкретную идентичность голоса, чтобы использовать из поддерживаемых параметров: alloy , echo , fable , onyx , nova и shimmer . Каждый голос имеет уникальный тон и стиль.
   • Скорость : отрегулируйте скорость воспроизведения сгенерированного звука, с диапазоном от 0,25 (медленнее) до 4,0 (быстрее). Настройка по умолчанию составляет 1, представляющая нормальную скорость.

? Поиск неисправностей

• Проблемы с голосовым сообщением : если бот не обрабатывает голосовых сообщений, убедитесь, что FFMPEG установлен на хост -машине. Проверьте журналы бота на наличие любых сообщений об ошибках, связанных с обработкой голоса.
• Ограничения доступа . Пользователи в определенных регионах, такие как Россия, могут столкнуться с блоками при попытке получить доступ к услугам Openai, что приведет к возвращению бота, возвращая страницу ошибок HTML. Чтобы обойти это, настройте VPN на вашем хостинговом компьютере или рассмотрите возможность размещения бота в другом географическом месте, где доступны услуги OpenAI.