UniqAI
/
openwebui-telegram
mirror of https://github.com/Sid-Sun/openwebui-telegram
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
12 Commits 1 Branch 0 Tags 90 KiB
Go 97.3%
Makefile 1.4%
Dockerfile 1.3%
Go to file
Sid Sun fbeea444fc refactor MessageLink: clean up unused prop and optimize insert message 
we don't actually need the child or to recurse over every previous message to insert a new message
additionally, add load and dump message store to disk in JSON

Signed-off-by: Sid Sun <sid@sidsun.com>
 		2024-05-16 00:44:09 +05:30
cmd remove unused const 2024-05-14 00:07:36 +05:30
pkg/bot refactor MessageLink: clean up unused prop and optimize insert message 2024-05-16 00:44:09 +05:30
.env.example Add example env 2024-05-13 22:18:57 +05:30
.gitignore Initial Commit 2020-08-19 02:18:55 +05:30
Dockerfile refactor MessageLink: clean up unused prop and optimize insert message 2024-05-16 00:44:09 +05:30
LICENSE Create LICENSE 2024-05-13 22:13:38 +05:30
Makefile remove unused const 2024-05-14 00:07:36 +05:30
README.md Add Dockerfile and info 2024-05-14 00:05:01 +05:30
docker-compose.yml Add Dockerfile and info 2024-05-14 00:05:01 +05:30
go.mod Use viper for config 2024-05-13 21:41:41 +05:30
go.sum Use viper for config 2024-05-13 21:41:41 +05:30

README.md

OpenWebUI-Telegram

🤖 A Telegram bot that integrates with OpenWeb UI's OpenAI compatible APIs to provide chat functionality.

Configuration

The configuration is loaded from environment variables, here are the environment variables you can set:

OpenAI Endpoint Options

  • OPENAI_ENDPOINT: The base OpenAI API compatible endpoint. example: http://localhost:3000/ollama/v1/. http & https both work.
  • OPENAI_API_KEY: The Bearer token API Key, example: sk-12345667890abcdefghijkl

Model Options

  • MODEL: The model to use. Default is llama3:instruct.
  • MODEL_TWEAK_LEVEL: The level of tweaking to apply to the model. Set to advanced to make Penalty tweaks take effect, else - none are provided to API. Default is minimal, i.e. no Penalty parameters.

Model Tweaks

  • MAX_TOKENS: The maximum number of tokens that the model can generate. Default is 1024.
  • TEMPERATURE: Controls the randomness of the model's output. Higher values make the output more random. Default is 0.8.
  • REPEAT_PENALTY: Penalty for repeating the same token. Default is 1.2.
  • CONTEXT_LENGTH: The maximum number of tokens in the context. Default is 8192.
  • PRESENCE_PENALTY: Penalty for using tokens that are not in the context. Default is 1.5.
  • FREQUENCY_PENALTY: Penalty for using tokens that are used frequently. Default is 1.0.

Bot Configuration

  • API_TOKEN: The Telegram Bot API token.

Usage

Only private chat is tested as of now.

Chatting

If you send messages without a reply, bot treats that as starting a new chat / thread. To continue a chat / thread, reply to the last (or previous) message you want to pick up the conversation from.

Commands

The bot supports two commands:

  1. To set system prompt, use /reset <system prompt>.
    • The default system prompt is You are a friendly assistant.
    • Once you set a custom system prompt, it will remain set until you either change it or bot is restarted.
  2. To regenerate a response, reply to the message you want to regenerate from and send /resend
    • Once the bot is restarted, the conversation history is lost and thread can't be continued.

How to run

Docker Compose

Copy the docker-compose.yml in this repo, create your env file in dev.env and run:

docker compose up

Shell

In the fish shell, you can just do:

env (cat dev.env | xargs -L 1) make serve

bash:

env $(cat dev.env | xargs -L 1) make serve

Contributing

Contributions are welcome. Please submit a pull request or create an issue if you have any improvements or suggestions.