https://github.com/losparviero/telesummary
Summarise any long text in Telegram, powered by GPT!
https://github.com/losparviero/telesummary
Last synced: 8 months ago
JSON representation
Summarise any long text in Telegram, powered by GPT!
- Host: GitHub
- URL: https://github.com/losparviero/telesummary
- Owner: losparviero
- License: agpl-3.0
- Created: 2023-03-09T22:26:09.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-20T20:17:15.000Z (over 2 years ago)
- Last Synced: 2025-01-12T16:13:11.342Z (9 months ago)
- Language: JavaScript
- Homepage: https://telesummarybot.t.me
- Size: 66.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Summariser Telegram Bot
Summarise any long text in Telegram, powered by GPT!
### Brief Note
This uses the official ChatGPT API which is paid hence will require an API key from OpenAI. You'll be billed for usage accordingly. Check OpenAI's website for pricing.
I also have an older project [ChatGPT Telegram Bot](https://github.com/Grahtni/ChatGPT-Telegram-Bot) which uses the chatgpt lib utilizing a puppeteer instance which doesn't need an API. However going the API route is much smoother as it doesn't have to deal with things like auth & captchas.
### Install
1. Clone git repo.
2. Run ```npm i``` in project folder. This will install the required dependencies.
3. Populate .env file with bot token, bot dev ID(s) and OpenAI API key.
#### Bot token can be obtained from @BotFather.
#### Bot dev ID refers to the user ID of your Telegram account. This is to prevent unauthorised access. You can add multiple IDs seperated by commas.
#### API key can be obtained from OpenAI.
4. Run ```node bot``` to start the bot.
#### It's advisable to run the bot using PM2 or any startup manager for persistent execution.
### Uninstall
1. Use ```rm -rf```.
*Note:* If you're unfamiliar with this command, delete project folder from file explorer.
### Mechanism
The bot uses the official ChatGPT API with a modified prompt to generate summaries.
Copyright (C) 2023 Zubin
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .