kibernikto 1.3.4

Easily run telegram bots connected to AI models.

kibernikto

Kibernikto is an app/lib to easily run telegram bots connected to AI models.

Having a link, Kibernikto based bots can summarize most of

• youtube videos
• webpages
• images

Given an image Kibernikto will publish it to a free image hosting service and then process as a link.

By default single_group_dispatcher is used with a following rules:

• One Kibernikto instance can be connected to one Telegram bot and work with one group chat. Privately it talks to master only and denies other users.
• Kibernikto can be added to any group chat (TG_FRIEND_GROUP_ID). The bot will need chat messages access set in group to operate. Private chat is only available for one master user (TG_MASTER_ID).

Kibernikto can post-process messages returned by one AI using another AI (for now it's a hardcoded 2 step chain).

install from pip

pip install kibernikto

how to run

• Create telegram bot using @BotFather and obtain it's key. You can also change the picture and other details there. Set env TG_BOT_KEY.

  Turn off Group Privacy for your bot to be able to react to group messages:

  
  

• Add your bot to the group you want. Set env TG_FRIEND_GROUP_ID. You can get the group ID using @getidsbot in telegram.

• Configure other env variables.

run cmd
(assuming local.env file is located in the same folder)

kibernikto --env_file_path=local.env

run code
(assuming you set the environment yrself)

• Install the requirements
  pip install -r requirements.txt
• Run main.py file using the environment provided.

environment:

First of all, full examples are in the examples folder.

In general, you can use one Ai provider API for all available Kibernikto actions, in that case all the AI related variables values will be the same.
However it is strongly recommended to use cheaper models for summarization tasks.

• Default OpenAI

OPENAI_BASE_URL=https://api.openai.com/v1
OPENAI_API_MODEL=gpt-4
OPENAI_API_KEY=yr-key  

• Multimodel vsegpt.ru

OPENAI_BASE_URL=https://api.vsegpt.ru:6070/v1  
OPENAI_API_KEY=sk-yr-key  
OPENAI_API_MODEL=openai/gpt-4  

Other AI behaviour options:

OPENAI_MAX_TOKENS=800  
OPENAI_WHO_AM_I=Answer all questions as {0}, the majestic lord of the universes with all the knowledge of our small planet.  

WeblinkSummaryPlugin and YoutubePlugin.

# If no key is provided, youtube videos and webpages will be ignored.
SUMMARIZATION_OPENAI_API_KEY=yr-key
SUMMARIZATION_OPENAI_API_BASE_URL=https://api.openai.com/v1  
SUMMARIZATION_OPENAI_API_MODEL=gpt-4-turbo-preview

ImageSummaryPlugin to process images.

# If no key is provided, images will not be processed.
IMAGE_SUMMARIZATION_OPENAI_API_KEY=yr-key
IMAGE_SUMMARIZATION_OPENAI_API_MODEL=gpt-4-vision-preview
IMAGE_SUMMARIZATION_OPENAI_API_BASE_URL=https://api.openai.com/v1

# You can get your key here: https://imgbb.com. If you do no set up this variable, default one will be used.  
# This is needed to store images send to the bot.  
IMAGE_STORAGE_API_KEY = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Telegram

# Telegram configuration
TG_BOT_KEY=XXXXXXXXXX:XXXxxxXXXxxxxXXXxxx  
TG_BOT_MAX_HISTORY=8  
TG_FRIEND_GROUP_ID=-XXXXXXXXXX  
# Your telegram ID. For example 122349243. Forward your message to @idstickerbot to get it.  
TG_MASTER_ID=XXXXXXXXX
# Kibernikto reacts to direct replies or when sees the following words. 
# Preserving pydantic-settings list format.  
TG_REACTION_CALLS=["киберникто","государь"]  
# sometimes Kibernikto sends stickers for fun together with his answers  
TG_STICKER_LIST=["CAACAgIAAxkBAAEKqsplQ8BRyPbGj_B_K4ujCLsDAe-l7wAC8AIAAs-71A7mCrGe-zzi0DME","CAACAgIAAxkBAAEIgoxkMaHv1maOeEne8CYAAY5s4kJ1e4wAAo4JAAIItxkCXSMuZ6bo59gvBA"]

For the full list of variables, see env_examples folder.

redactor mode

To run Kibernikto with additional redactor for each response change the bot_type to "vertihvostka":
kibernikto --env_file_path=local.env --bot_type=vertihvostka
And set the following env variables for a redactor network.

REDACTOR_OPENAI_API_KEY=sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
REDACTOR_OPENAI_BASE_URL=https://api.openai.com/v1
REDACTOR_OPENAI_API_MODEL=gpt-4-turbo-preview
#REDACTOR_OPENAI_WHO_AM_I=""
REDACTOR_MESSAGE="
    Replace several words in the text with their feminine equivalents; do not change the other words. In your response, return only the result without your comments:\n{message}
"

useful links

To create and operate your bot: https://t.me/BotFather
To obtain group/user ids etc: https://t.me/getidsbot
To obtain sticker ids: https://t.me/idstickerbot
To get familiar with basic OpenAI principles: https://openai.com
Basics on Gpt-4 vision: https://gptpluginz.com/gpt-4-vision-api
To find out more on models and multi-model api details: https://vsegpt.ru/Docs/Models
Website to text and other helpful tools https://toolsyep.com
Free image hosting: https://imgbb.com

code details

(ignore it if dont plan to create yr own plugins or Kibernikto bots using Kibernikto as a library)

You can write yr own bots extending TelegramBot class from kibernikto.telegram package.
See bots package for more details.

Plugins are entities that pre-process user input text before sending it to ai. Currently 3 plugins are available ( see plugins package):

• ImageSummaryPlugin (IMAGE_SUMMARIZATION_ env prefix)
• YoutubePlugin (SUMMARIZATION_ env prefix)
• WeblinkSummaryPlugin (SUMMARIZATION_ env prefix)

Each plugin overrides the applicable method from superclass, i.e.:

class YoutubePluginSettings(BaseSettings):
    model_config = SettingsConfigDict(env_prefix='SUMMARIZATION_')

    OPENAI_API_MODEL: str = "gpt-4-turbo-preview"
    OPENAI_BASE_URL: str = "https://api.openai.com/v1"
    OPENAI_API_KEY: str | None = None
    OPENAI_MAX_TOKENS: int = 800
    VIDEO_MESSAGE: str = _DEFAULT_TEXT


DEFAULT_SETTINGS = YoutubePluginSettings()


class YoutubePlugin(KiberniktoPlugin):
    index = 0

    @staticmethod
    def applicable():
        return DEFAULT_SETTINGS.OPENAI_API_KEY is not None
    ...