meinside / telegram-chatgpt-bot

A telegram bot which answers messages with ChatGPT API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Telegram ChatGPT Bot

A telegram bot which answers to messages with ChatGPT API.

1

You can also reply to messages for keeping the context of your conversation:

2

You can count the number of tokens of text with /count command:

count_command

Prerequisites

Configurations

Create a configuration file:

$ cp config.json.sample config.json
$ vi config.json

and set your values:

{
    "telegram_bot_token": "123456:abcdefghijklmnop-QRSTUVWXYZ7890",
    "openai_api_key": "key-ABCDEFGHIJK1234567890",
    "openai_org_id": "org-1234567890abcdefghijk",
    "openai_model": "gpt-3.5-turbo",
    "allowed_telegram_users": ["user1", "user2"],
    "db_filepath": null,
    "verbose": false
}

If db_filepath is given, all prompts and their responses will be logged in the SQLite3 file.

Build

$ go build

Run

Run the built binary with the config file's path:

$ ./telegram-chatgpt-bot path-to/config.json

Run as a systemd service

Createa a systemd service file:

[Unit]
Description=Telegram ChatGPT Bot
After=syslog.target
After=network.target

[Service]
Type=simple
User=ubuntu
Group=ubuntu
WorkingDirectory=/dir/to/telegram-chatgpt-bot
ExecStart=/dir/to/telegram-chatgpt-bot/telegram-chatgpt-bot /path/to/config.json
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target

and systemctl enable|start|restart|stop the service.

Commands

  • /help for help message.

Todos / Known Issues

  • Handle returning messages' size limit (Telegram Bot API's limit: 4096 chars)
    • Will send a text document instead of an ordinary text message.

License

The MIT License (MIT)

Copyright © 2023 Sungjin Han

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A telegram bot which answers messages with ChatGPT API


Languages

Language:Go 100.0%