tikhomirovv/llm-telegram-publisher-bot

Automate Telegram channel posts with AI-generated content using a configurable LLM-powered Telegram bot with scheduled publishing.

LLM Telegram Publisher Bot

Описание

LLM Telegram Publisher Bot - бот для автоматической генерации постов с помощью LLM (OpenAI ChatGPT) и автопубликации их в телеграм-канал. Этот бот предоставляет возможность настройки параметров LLM, кастомизации промпта и планирования публикаций с использованием cron-формата.

Основные функции

• Генерация контента с помощью LLM: Используйте мощность OpenAI ChatGPT для создания уникальных и интересных постов.
• Настройка параметров LLM: Настройте параметры модели языка для получения желаемого результата.
• Кастомизация промпта: Определите свой собственный промпт для направления генерации контента.
• Возможность форматировать ответ: Телеграм поддерживает html - возможна настройка формата ответа через промпт.
• Расписание публикаций: Автоматизируйте публикации с помощью cron-расписания и учетом временной зоны.
• Один бот для разных каналов: Настройте сколько угодно каналов, указав для каждого свое расписание, промпт и температуру.
• Временное окно: Укажите период времени, в течении которого пост должен быть опубликован.
• Простота установки и запуска: Быстрый старт с помощью bun и docker.

Установка

Перед началом убедитесь, что у вас установлен bun (v1.0.20 или выше).

1. Клонируйте репозиторий:

git clone https://github.com/tikhomirovv/llm-telegram-publisher-bot
cd llm-telegram-publisher-bot

2. Установите зависимости:

bun install

Конфигурация

Перед запуском бота, необходимо настроить следующие параметры:

1. Создайте файл .env (или скопируйте .env.example) и укажите в нем токен вашего бота, идентификатор канала и ключ OpenAI:

TELEGRAM_BOT_TOKEN="paste_bot_token_here"
OPENAI_KEY="your_openai_key"

2. Настройте параметры LLM, каналы, промпт и расписание для них в конфигурационном файле.

Конфигурация лежит в ./config. По-умолчанию загружается default.json, можно переопределить конфигурацию добавлением файлика с окружением ({NODE_ENV_VAR}.json, production.json например) или локальный local.json / local-{NOTE_ENV_VAR}.json.

Для разработки и проверки результатов можно создать ./config/local.json и переопределить промпты и расписание, например на ["*/15 * * * *"] для генерации поста каждые 15 секунд.

• Подробнее о файлах конфигурации: https://github.com/node-config/node-config/wiki/Configuration-Files#file-load-order
• Подробнее о формате cron-расписания: https://www.npmjs.com/package/node-cron#cron-syntax
• Подробнее о настройках для ChatGPT: https://platform.openai.com/docs/api-reference/chat/create

Расписание

Для настройки расписания постов в конфигурации есть два ключа - schedule (cron-расписание, string[]) и delay_window_min (временное окно в мин., number).

Несколько наглядных примеров.

Пост каждый день ровно в 8:30:

{
    "schedule": ["30 8 * * *"],
}

Посты:

1. ПН, СР, ПТ - по 2 поста; 1-ый между 11:00-12:30, 2-й между 18:00-19:30
2. ВТ, ЧТ, СБ - один пост между 20:30-22:00

{
    "schedule": ["0 11,18 * * 1,3,5", "30 20 * * 2,4,6"],
    "delay_window_min": 90,
}

Расписание настраивается для каждого типа поста, поэтому варианты могут быть любые:

• несколько разных типов постов с разным расписанием в один канал
• разные типы постов в разные каналы
• смешанные конфигурации

Запуск

Чтобы запустить бота, используйте следующую команду:

# development mode
make dev

# or production mode
make start

# or build docker image, create and run container
make build && make run

Поддержка

Если у вас возникли вопросы или предложения, пожалуйста, создайте issue в этом репозитории.

Лицензия

Открытая лицензия MIT - см. LICENSE.