0
0
mirror of https://gitflic.ru/project/maks1ms/ocab.git synced 2024-12-24 00:33:05 +03:00
Go to file
2024-07-10 12:36:56 +03:00
docs добавлена проверка зависимостей 2024-07-10 12:36:56 +03:00
scripts wip 2024-07-10 11:28:42 +03:00
src добавлена проверка зависимостей 2024-07-10 12:36:56 +03:00
.bandit Добавлены инструменты для повышения качества кода 2024-07-07 23:59:33 +03:00
.flake8 Автоматический рефакторинг и игнорирование flake8 2024-07-08 00:38:01 +03:00
.gitignore wip 2024-07-10 11:28:42 +03:00
.pre-commit-config.yaml Добавлен bandit в pre-commit-hook 2024-07-08 00:49:04 +03:00
how-to install deps.md Автоматический рефакторинг и игнорирование flake8 2024-07-08 00:38:01 +03:00
LICENSE Create LICENSE 2023-07-08 20:36:02 +03:00
poetry.lock добавлена проверка зависимостей 2024-07-10 12:36:56 +03:00
pyproject.toml добавлена проверка зависимостей 2024-07-10 12:36:56 +03:00
README.md wip 2024-07-09 23:57:48 +03:00

OpenChatAiBot V2

Что такое OCAB?

OCAB - это бот для Telegram, который призван помочь во взаимодействии с чатом. Бот поддерживает интеграцию модулей для расширения функционала. Фактически бот является платформой для запуска созданных для него модулей. Модули могут взаимодействовать друг с другом или быть полностью независимыми.

Что такое модуль?

Модуль - это директория, которая содержит в себе код модуля и его конфигурацию.

Структура модуля

Будет дополнено после закрытия issue #17.

Стандартные модули

В стандартный состав бота входят следующие модули:

  • admin - модуль для модерирования чата. Позволяет удалять сообщения, банить пользователей и т.д.
  • reputation - модуль репутации пользователей. Позволяет оценивать ответы пользователей и накапливать репутацию.
  • welcome - модуль приветствия новых пользователей. Позволяет приветствовать новых пользователей в чате, а также проверять пользователя капчей для предотвращения спама.
  • roles - модуль ролей. Позволяет назначать пользователям роли и ограничивать доступ к командам бота по ролям. Является важной частью системы прав доступа и модуля admin.

Дополнительные официальные модули

  • yandexgpt - модуль для генерации ответов на основе нейросети GPT-3.5. Позволяет боту отвечать на сообщения пользователей, используя нейросеть. Ключевой особенностью является построение линии контекста для нейросети, которая позволяет боту отвечать на вопросы, используя контекст предыдущих сообщений. Для этого используется модуль база данных хранящий историю сообщений.

Список модулей будет пополняться. Идеи для модулей можно оставлять в issues.

Установка бота

Docker

Вручную

Технологический стек

  • Python 3.11.6 или выше - основной язык программирования.
  • SQLite 3 - база данных для хранения информации о чате и пользователях.
  • Poetry - менеджер зависимостей.
  • aiogram 3 - библиотека для работы с Telegram API.
  • peewee - ORM для работы с базой данных.