Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ranitmanik/telegamgpt
TelegramGPT is a Telegram chatbot powered by OpenAI's GPT-3.5 Turbo model created using Python. It reads messages from a specified chat file and responds to user messages in Telegram using the GPT-3.5 Turbo model.
https://github.com/ranitmanik/telegamgpt
bot botfather chat-application chatbot chatgpt chatgpt-api openai openai-api telegram telegram-api telegram-bot telegram-bot-api
Last synced: about 2 months ago
JSON representation
TelegramGPT is a Telegram chatbot powered by OpenAI's GPT-3.5 Turbo model created using Python. It reads messages from a specified chat file and responds to user messages in Telegram using the GPT-3.5 Turbo model.
- Host: GitHub
- URL: https://github.com/ranitmanik/telegamgpt
- Owner: RanitManik
- License: mit
- Created: 2023-12-23T21:44:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-20T16:03:45.000Z (11 months ago)
- Last Synced: 2024-11-24T20:44:47.791Z (2 months ago)
- Topics: bot, botfather, chat-application, chatbot, chatgpt, chatgpt-api, openai, openai-api, telegram, telegram-api, telegram-bot, telegram-bot-api
- Language: Python
- Homepage: https://t.me/RanitGPTBot
- Size: 30.3 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TelegramGPT Chatbot
Welcome to the comprehensive setup guide for the ChatGPT Text Generation Service, a powerful tool that utilizes the state-of-the-art GPT-3.5 Turbo model to generate natural language text. Follow this step-by-step guide to set up the Text Generation Service and unlock the capabilities of ChatGPT.
## Table of Contents
- [Overview](#overview)
- [Features](#features)
- [Installation](#installation)
- [Clone the Repository](#1-clone-the-repository)
- [Install Required Packages](#2-install-required-packages)
- [Usage](#usage)
- [Set up Telegram Bot](#1-set-up-telegram-bot)
- [Create an OpenAI Account](#2-create-an-openai-account)
- [Access the OpenAI API Section](#3-access-the-openai-api-section)
- [Create a New API Key](#4-create-a-new-api-key)
- [Save and Run](#5-save-and-run)
- [Verify Functionality](#6-verify-functionality)
- [Configuration](#configuration)
- [Text Generation](#text-generation)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgment](#acknowledgment)
## Overview
TelegramGPT is a Telegram chatbot powered by OpenAI's GPT-3.5 Turbo model created using Python. It reads messages from a specified chat file and responds to user messages in Telegram using the GPT-3.5 Turbo model.
## Features
- Seamless integration with Telegram
- Configurable chat file selection
- Utilizes OpenAI GPT-3.5 Turbo for natural language understanding
- Easy-to-use and extendable
## Installation
### 1. Clone the Repository
```bash
git clone https://github.com/YourUsername/ChatGPT-Text-Generation
```
### 2. Install Required Packages
```bash
pip install -r requirements.txt
```
## Usage
### 1. Set up Telegram Bot
1. Create a Telegram bot on the [Telegram BotFather](https://core.telegram.org/bots#botfather).
2. Copy the bot token.
3. Replace `Your Telegram Bot Token Goes here` in the `.env` file with the actual bot token.
### 2. Create an OpenAI Account
1. Visit the OpenAI website: [https://beta.openai.com/](https://beta.openai.com/)
2. Sign up for an account if you don't have one. Follow the registration process.
### 3. Access the OpenAI API Section
1. Once you're logged in, navigate to the OpenAI API section.
- On the OpenAI dashboard, click on your account name in the top right corner.
- Select "API" from the dropdown menu.
### 4. Create a New API Key
1. In the API section, you'll find the option to create a new API key.
2. Click on the "Create API Key" button.
3. Give your API key a meaningful name related to your project (e.g., "TelegramGPT").
4. Copy the generated API key. It will look something like this: `sk-xxxxxx-xxxxxxxxxxxxxx`.
5. Open the `.env` file in your TelegramGPT project directory.
6. Replace the placeholder `Your openAI API key goes here` with the actual API key you obtained from OpenAI:
```plaintext
TELEGRAM_TOKEN=your_telegram_bot_token
OPENAI_API_KEY=sk-xxxxxx-xxxxxxxxxxxxxx
```
### 5. Save and Run
1. Save the changes to the `.env` file.
2. Now, when you run your TelegramGPT bot, it will use the OpenAI GPT-3.5 Turbo model with the specified API key.
### 6. Verify Functionality
1. Start a chat with your Telegram bot.
2. Use the `/setfile` command to set the chat file (e.g., `/setfile 1`).
3. Send messages to the bot and confirm that it generates responses using the GPT-3.5 Turbo model.
By following these steps, you've successfully created an OpenAI GPT-3.5 Turbo API key and integrated it into your TelegramGPT project. This key allows your bot to communicate with the OpenAI API and generate natural language responses.
## Configuration
You can configure the bot by modifying the following variables in `main.py`:
- `fileNumber`: Change the chat file by setting this variable to 1, 2, or 3 before `/setfile` flag and send it to bot.
- `model`: Specify the GPT model to be used (default is "gpt-3.5-turbo").
- Adjust other parameters like `temperature`, `max_tokens`, `top_p`, `frequency_penalty`, and `presence_penalty` as needed.
### Chat Files
- `chats/chat1.txt`: [Sample chat file 1](chats/chat1.txt) — my resume
- `chats/chat2.txt`: [Sample chat file 2](chats/chat2.txt) — whatsapp chat bwtween me and my friend
- `chats/chat3.txt`: [Sample chat file 3](chats/chat3.txt) — a simple AI generated friends chat
## Text Generation
Experiment with the service by sending text prompts and receiving generated responses. Adjust configuration parameters for different text generation styles.
## Contributing
1. Clone the repository:
```bash
git clone https://github.com/RanitManik/TelegamGPT.git
```
2. **Add This repo as Remote**:
```bash
git remote add origin https://github.com/RanitManik/TelegamGPT.git
```
3. **Create a New Branch** for your feature or bugfix:
```bash
git checkout -b feature/{your_feature} or bugfix/{issue_number}
```
4. **Commit** your changes:
```bash
git commit -m "Your meaningful commit message here"
```
5. **Push** your changes to the repository:
```bash
git push origin feature/{your_feature} or bugfix/{issue_number}
```
Feel free to contribute to the project by opening issues or pull requests. Any feedback or improvements are appreciated.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
Social Media
Username
Link
Email
[email protected]
Email
LinkedIn
Ranit Manik
LinkedIn
Instagram
ranit_manik_
Instagram
Facebook
RanitKumarManik
Facebook
Twitter
RANIT_MANIK
Twitter
## Acknowledgment
I want to express my gratitude to [CodeWithHarry](https://www.youtube.com/c/CodeWithHarry) for his insightful tutorial on creating the [myGPT Discord Chatbot using OpenAI's GPT-3.5 Turbo model](https://youtu.be/BP-w99ZINTc?si=tcUeGGh3MKCYODuk), which served as a crucial guide. Special thanks to contributors and the open-source community for enhancing the project. The inspiration behind TelegramGPT arose from the need for an advanced Telegram chatbot leveraging OpenAI's GPT-3.5 Turbo.
Best regards, Ranit Manik