dialog chat bot

Openai Telegram聊天机器人

这是一个基于Python的Telegram聊天机器人，它使用带有GPT-3.5-Turbo-*模型的OpenAI API，以对话框上下文感知方式向用户提供对话响应。

您可以使用models.yml文件轻松地为聊天机器人配置OpenAI模型的参数。这种方法可以快速调整模型设置，例如temperature ， max_tokens ， voice等，而无需更改代码。只需编辑models.yml文件即可根据需要更改聊天机器人的行为和响应样式。

特征

• 使用OpenAI API对用户输入提供对话响应。
• 能够轻松配置多个模型并在它们之间进行选择。
• 支持语音输入（使用Openai Whisper模型处理文本的语音）。
• 支持语音输出（使用OpenAI TTS模型处理文本到语音）。
• 可以同时与不同用户进行多个对话。

要求

• Python 3.11+
• ffmpeg
• OpenAI帐户和正面帐户余额。新用户可获得$ 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
  

• 复制/inname .env.dist为.env并填充数据。

   cp .env.dist .env
  

  • 设置电报机器人并获取机器人令牌（请参阅https://medium.com/geekculture/generate-telegram-telegram-token-for-bot-api-api-d26faf9bf064）。

  • 设置一个OpenAI帐户并获取API密钥（请参阅https://beta.openai.com/docs/quickstart有关说明）。

• 运行机器人。

   python bot.py
  

Docker

• 安装Docker和Docker组成（如果您不知道如何链接）。

• 复制/inname .env.dist为.env并填充数据。

   cp .env.dist .env
  

• 现在，只需构建图像并使用Docker组成：

 docker compose build
docker compose up -d

用法和配置

要开始与机器人进行交互，将任何消息发送给电报机器人。

聊天机器人使用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部分） ：

   • 模型ID ：为您的用例选择适当的模型ID。可用的选项包括各种版本的gpt-3.5-turbo模型，每个版本都具有不同的功能和上下文窗口尺寸。
   • 最大令牌：此必需的设置通过限制模型生成的最大令牌来控制输出长度。
   • 频率惩罚：根据迄今为止的频率调整新令牌的生成方式。正值减少重复。
   • 存在惩罚：根据他们在对话中的存在，影响新代币的产生，从而促进主题的多样性。
   • 温度：控制响应的随机性。较低的值会导致更可预测的文本，而较高的值会增加多样性。
   • 顶部P ：根据值，将模型聚焦在最可能的令牌或更广泛的集合上，具体取决于该值。
   • 停止：定义特定的序列，该序列发出信号，以停止产生进一步的令牌，可用于管理对话流。

3. 配置聊天机器人行为（ chatbot部分） ：

   • 描述：在对话开始时为聊天机器人设置上下文或角色，指导其响应和样式。
   • 长度： max_context_len参数定义单个对话窗口中考虑的令牌总数（用户输入和bot响应）。调整此功能有助于管理对话历史记录的细节，并可能影响计算要求和计费。

4. 配置机器人的语音（ voice部分） ：

   • 模型：在可用的文本到语音（TTS）模型之间选择以定义语音输出的质量和特征。选项包括用于标准质量的TTS-1和高清音频的TTS-1-HD。此设置确定语音综合的基础技术。
   • 语音：从受支持的选项中选择特定的语音身份： alloy ， echo ， fable ， onyx ， nova和shimmer 。每个声音都有独特的音调和风格。
   • 速度：调整生成音频的播放速度，范围从0.25（慢）到4.0（快速）。默认设置为1，代表正常速度。

？故障排除

• 语音消息问题：如果机器人未能处理语音消息，请确保在主机计算机上安装FFMPEG。检查机器人的日志是否与语音处理有关的任何错误消息。
• 访问限制：某些地区（例如俄罗斯）的用户在尝试访问OpenAI服务时可能会遇到块，从而导致返回HTML错误页面的机器人。为了避免这种情况，请在托管机上配置VPN或考虑在可用的OpenAI服务的不同地理位置中托管机器人。