TGPT is a minimalist, yet powerful GPT Telegram bot built in Go with a pure focus on functionality, speed, and efficiency. The bot doesn't require any database or extra dependencies, is lightweight enough that it can even run on lower-end hardware such as a Raspberry Pi Zero W.
- Fast and Efficient: Designed and built to work swiftly, ensuring optimal user experience.
- Minimal Requirements: Runs smoothly even on low-end hardware. No database or additional dependencies required.
- Accurate Cost Calculation: Precisely calculates cost, ensuring correct estimates. The bot meticulously tracks expenses for each user, providing a transparent view of usage costs.
- Multi-Currency Support: Offers the ability to display and recalculate costs in various currencies, catering to a global user base and their financial preferences.
- Versions Supported: Fully supports the GPT-3.5 Turbo and future-proof with GPT-4 support. Different context lengths can be handled, including the expanded context length for GPT-4 Turbo Preview (gpt-4-1106-preview) with up to 128k tokens.
- Chat History: Allows to maintain chat history, enabling continuity in user interactions.
- Light on Hardware: Among the unique advantages of TGPT is its low hardware requirements, making it easier to host and maintain than some other options.
-
GPT-3.5 Turbo (4k Context)
- Identifier: openai.GPT3Dot5Turbo
- Context Length: 4,000 tokens
- Cost Structure: Referenced by GPT3Dot5TurboCtx4k
-
GPT-3.5 Turbo (16k Context)
- Identifier: openai.GPT3Dot5Turbo16K
- Context Length: 16,000 tokens
- Cost Structure: Referenced by GPT3Dot5TurboCtx16k
-
GPT-4 (8k Context)
- Identifier: openai.GPT4
- Context Length: 8,000 tokens
- Cost Structure: Referenced by GPT4Ctx8k
-
GPT-4 (32k Context)
- Identifier: openai.GPT432K
- Context Length: 32,000 tokens
- Cost Structure: Referenced by GPT4Ctx32k
-
GPT-4 Turbo Preview (128k Context)
- Identifier: "gpt-4-1106-preview"
- Context Length: 128,000 tokens
- Cost Structure: Referenced by GPT4Turbo1106Ctx128k
-
GPT-3.5 Turbo (16k Context, Special Version)
- Identifier: "gpt-3.5-turbo-1106"
- Context Length: 16,000 tokens
- Cost Structure: Referenced by GPT3Dot5Turbo1106Ctx16k
This list represents the various configurations of the GPT-3.5 and GPT-4 models supported by TGPT, each with different context lengths to suit a variety of use cases. It is essential for users to choose the appropriate model based on their needs, considering factors such as the complexity of the task, the desired output length, and cost efficiency.
Clone the project into your Go directory.
git clone https://github.com/muzykantov/tgpt.git
Go to the project directory and build it. The binary file will be named tgpt. cd tgpt go build
To run the bot, simply start the executable. ./tgpt
Before you can run the bot, you need to configure it by setting environment variables. These variables can either be set in your environment directly or by using a .env file in the root directory of the project.
Below is a list of all the environment variables used by the bot, along with a description for each:
TGPT_TELEGRAM_BOT_TOKEN: Your Telegram bot token obtained from BotFather.TGPT_OPENAI_API_KEY: Your OpenAI API key for accessing GPT models.
TGPT_NAME: The name you want to give to your Telegram bot (default is "TGPT").TGPT_MODEL: The language model to use, default is "gpt-4".TGPT_ALLOWED_USERS: Comma-separated list of user IDs allowed to interact with the bot.TGPT_ADMIN_USERS: Comma-separated list of admin user IDs with extended permissions.TGPT_LANGUAGE: The language code for bot responses (default is "en").TGPT_ADMIN_CONTACT: The username or channel name of the admin for contact purposes.TGPT_CURRENCY: The currency symbol to use in financial interactions, e.g., for donations (default is "$").TGPT_RATE: The exchange rate used for converting currencies, if applicable (default is "1.0").
TGPT_CACHE_TTL_SEC: Time-to-live for the cache, in seconds (default is "3600").TGPT_DB_DIR: The directory where the database files will be stored (default is ".db").TGPT_MAX_TOKENS: The maximum number of tokens the model should generate in each response.TGPT_TEMPERATURE: Controls the randomness in the model's output, with lower values leading to more deterministic responses.TGPT_TOP_P: Influences the range of token probabilities considered for generating each token in a response.TGPT_PRESENCE_PENALTY: Adjusts the model to prefer tokens from the input, which can encourage the model to talk about new topics.TGPT_FREQUENCY_PENALTY: Adjusts the model to avoid using tokens from the input, which can discourage the model from repeating itself.TGPT_PROMPT: Bot's default prompt.
To use a .env file for your configuration:
- Create a file named
.envin the root directory of the project. - Copy the contents of the
.env.examplefile (if provided) into the.envfile. - Fill in the values for the environment variables.
Important: Never commit sensitive keys and tokens to version control. Always keep TGPT_TELEGRAM_BOT_TOKEN and TGPT_OPENAI_API_KEY confidential.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
TGPT is under the GPL license. See LICENSE for more information.
Go, Chatbot, GPT, Telegram Bot, Lightweight Chatbot, GPT-3.5 Turbo, GPT-4, Raspberry Pi, Minimalistic Chatbot, Accurate Cost Calculation, Fast and Efficient, Chat History Support
Crafted with care and efficiency. Always aimed at surpassing user's expectations. TGPT is the next step your Telegram Bot experience deserves.