Extension connecting text-generator to telegram bot api.

This is extension for oobabooga/text-generation-webui providing cai-chat like telegram bot interface.

REQUIREMENTS:

• oobabooga/text-generation-webui
• python-telegram-bot==13.15
• pyyaml (already in text-generation-webui requirements)
• deep-translator (already in text-generation-webui requirements)

HOW TO INSTALL:

1. clone this repo to "text-generation-webui\extensions"

cd text-generation-webui
git clone https://github.com/innightwolfsleep/text-generation-webui-telegram_bot extensions\telegram_bot

2. install "python-telegram-bot==13.15" module to your textgen environment. (run cmd_windows.bat or cmd_linux.sh and send run pip install -r extensions\telegram_bot\requirements.txt)

HOW TO USE:

1. add your bot token to "text-generation-webui\extensions\telegram_bot\telegram_token.txt" (ask https://t.me/BotFather how to get token)
2. run server.py with "--extensions telegram_bot"
3. (optional) if you are facing internet issue, change proxy_url at telegram_config.json into your own proxy. For example: https://127.0.0.1:10808

FEATURES:

• chat and notebook modes
• session for all users are separative (by chat_id)
• local session history - conversation won't be lost if server restarts. Separated history between users and chars.
• chat action "typing" during generating
• buttons: continue previous message, regenerate last message, remove last messages from history, reset history button, new char loading menu
• you can load new characters from text-generation-webui\characters with button
• you can load new model during conversation with button
• chatting "#" or "+" prefix for impersonate: "#You" or "+Castle guard" or "#Alice thoughts about me"
• "!" or "-" prefix to replace last bot message
• "++" prefix permanently replace bot name during chat (switch conversation to another character)
• "📷" prefix to make photo via SD api. Write like "📷Chiharu Yamada", not single "📷"
• save/load history in chat by downloading/forwarding to chat .json file
• integrated auto-translate (you can set model/user language parameter)
• voice generating (silero), en and ru variants
• translation_as_hidden_text option in .cfg - if you want to learn english with bot)))
• telegram_users.txt - list of permitted users (if empty - permit for all)
• antiflood - one message per 15 sec from one user limit

CONFIGURATION:

telegram_config
    bot_mode=admin  
        specific bot mode. admin for personal use
            - admin - bot answer for everyone in chat-like mode. All buttons, include settings-for-all are avariable for everyone. (Default)
            - chat - bot answer for everyone in chat-like mode. All buttons, exclude settings-for-all are avariable for everyone. (Recommended for chatting)
            - chat-restricted - same as chat, but user can't change default character
            - persona - same as chat-restricted, but reset/regenerate/delete message are unavailable too. 
            - notebook - notebook-like mode. Prefixes wont added automaticaly, only "\n" separate user and bot messages. Restriction like chat mode.
            - query - same as notebook, but without history. Each question for bot is like new convrsation withot influence of previous questions
    generator_script=GeneratorLlamaCpp
        name of generator script (generators folder):
            - GeneratorTextGeneratorWebui - module to integrate in oobabooga/text-generation-webui 
            - GeneratorTextGeneratorWebuiApi - use oobabooga/text-generation-webui API extension
    model_path=not_used_for_ooba
        legacy for standalone branch
	characters_dir_path=characters
	default_char=Example.yaml
		default cahracter and path to cahracters folder
	presets_dir_path=presets
	default_preset=Shortwave.yaml
		default generation preset and path to preset folder
	model_lang=en
	user_lang=en
		default model and user language. User language can be switched by users, individualy.
	html_tag_open=<pre>
	html_tag_close=</pre>
		tags for bot answers in tg. By default - preformatted text (pre)
	history_dir_path=extensions/telegram_bot/history
		directory for users history
	token_file_path=extensions/telegram_bot/telegram_token.txt
		bot token. Ask https://t.me/BotFather
	admins_file_path=extensions/telegram_bot/telegram_admins.txt
		users whos id's in admins_file switched to admin mode and can choose settings-for-all (generating settings and model)
	users_file_path=extensions/telegram_bot/telegram_users.txt
		if just one id in users_file - bot will ignore all users except this id (id's). Even admin will be ignored
	stopping_strings=<END>,<START>,end{code}
	eos_token=None
		generating settings
	translation_as_hidden_text=on
		if "on" and model/user lang not the same - translation will be writed under spoiler. If "off" - translation without spoiler, no original text in message.

telegram_admins.txt
	list of users id who forced to admin mode. 

telegram_users.txt
	list og users id (or groups id) who permitted interact with bot. If empty - everyone permitted

telegram_token.txt
	telegram bot token