From 794fcef380f99f5e6646165914352bb1c71fd424 Mon Sep 17 00:00:00 2001 From: Anton Palgunov Date: Sat, 1 Apr 2023 22:01:46 +0100 Subject: [PATCH] readme --- Readme.md | 2 ++ Readme.ru.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/Readme.md b/Readme.md index bf5497b..19fd797 100644 --- a/Readme.md +++ b/Readme.md @@ -1,5 +1,7 @@ # Telegram Bot with ChatGPT +[Русский](./Readme.ru.md) + This is a simple Telegram bot that uses the ChatGPT model to generate responses to user messages. The bot is built using Python and the pyTelegramBotAPI package for interacting with the Telegram Bot API, and the OpenAI API for generating responses using the ChatGPT model. ## Prerequisites diff --git a/Readme.ru.md b/Readme.ru.md index e69de29..9f06ef1 100644 --- a/Readme.ru.md +++ b/Readme.ru.md @@ -0,0 +1,48 @@ +# Телеграм-бот с ChatGPT + +Это простой Телеграм-бот, который использует модель ChatGPT для генерации ответов на сообщения пользователей. Бот создан на языке Python с использованием пакета pyTelegramBotAPI для взаимодействия с API ботов Телеграм и API OpenAI для генерации ответов с помощью модели ChatGPT. + +## Требования + +Для работы с этим ботом вам понадобятся: + +- Python версии 3.6 или выше +- Токен Телеграм-бота (получить его можно, следуя инструкциям [здесь](https://core.telegram.org/bots#creating-a-new-bot)) +- Ключ API OpenAI (получить его можно, зарегистрировавшись на сайте [здесь](https://beta.openai.com/signup/)) + +## Установка + +Чтобы установить необходимые пакеты Python, выполните следующую команду: + +`pip install -r requirements.txt` + +Это установит пакеты pyTelegramBotAPI и openai, необходимые для работы бота. + +## Использование + +Чтобы запустить бота, выполните следующую команду: + +`python bot.py` + +Бот начнет работу и будет прослушивать входящие сообщения от пользователей. Когда пользователь отправит сообщение, бот сгенерирует ответ с помощью модели ChatGPT и отправит его пользователю. + +## Использование 2 + +Для запуска бота просто выполните команду docker-compose up. Это запустит Docker-контейнер с работающим ботом. + +## Настройка + +Чтобы настроить бота, вам нужно изменить файл bot.py и заменить следующие заполнители на свои значения: + +- YOUR_TELEGRAM_BOT_TOKEN_HERE: замените это на токен вашего Телеграм-бота +- YOUR_OPENAI_API_KEY_HERE: замените это на ключ API OpenAI + +Вы также можете изменить функцию generate_response в файле bot.py, чтобы настроить генерацию ответов моделью ChatGPT. + +## Внесение изменений + +Если вы обнаружите какие-либо проблемы или у вас есть предложения по улучшению бота, не стесняйтесь открывать issue или отправлять запрос на изменение (pull request). + +## Лицензия + +Этот проект лицензирован под лицензией MIT - см. файл LICENSE для получения подробной информации.