Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Itz-fork/Yui
Simple Telegram AI Chat bot made using OpenAI and Luna API
https://github.com/Itz-fork/Yui
ai-chat chat-bot openai-chat-bot telegram-chat-bot
Last synced: 3 months ago
JSON representation
Simple Telegram AI Chat bot made using OpenAI and Luna API
- Host: GitHub
- URL: https://github.com/Itz-fork/Yui
- Owner: Itz-fork
- License: gpl-3.0
- Created: 2021-12-11T17:48:46.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-06-17T14:27:11.000Z (over 2 years ago)
- Last Synced: 2024-06-28T17:46:59.725Z (5 months ago)
- Topics: ai-chat, chat-bot, openai-chat-bot, telegram-chat-bot
- Language: Python
- Homepage:
- Size: 63.5 KB
- Stars: 40
- Watchers: 3
- Forks: 58
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Yui
***Yui, is a simple telegram chat bot made using OpenAI, AFFILIATE+ and Luna Chat bot***
----
## Deployment 👀
Deploying is easy 🤫! You can deploy this bot in Heroku or in a VPS ♥️! **Star 🌟 Fork 🍴 and Deploy**
#### With Heroku
#### Self-Hosting
```bash
git clone https://github.com/Itz-fork/Yui.git
cd Yui
pip3 install -r requirements.txt
```
**Edit "config.py" with your own values**
```bash
python3 -m Yui
```
## Configs 🗒️
- `APP_ID` - Your APP ID. Get it from [my.telegram.org](my.telegram.org)
- `API_HASH` - Your API_HASH. Get it from [my.telegram.org](my.telegram.org)
- `BOT_TOKEN` - Bot Token of Your Telegram Bot. Get it from [@BotFather](https://t.me/BotFather)
- `OWNER_ID` - Your Telegram Account ID. Get it from [@MissRose_bot](https://t.me/MissRose_bot) (Start the bot and send /info command)
- `CHAT_BOT_NAME` - Custom name for your chatbot. (Default to `Yui`)
- `OPENAI_KEY` - Your own [OpenAI](https://openai.com/) API Key
- Go to [OpenAI Sign Up Page](https://beta.openai.com/signup) and create your OpenAI Account
- Then go to [API Keys Section](https://beta.openai.com/account/api-keys)
- From there you can copy your OpenAI API Key
- `ARQ_KEY` - Your ARQ API Key. Get it from [@ARQRobot](https://t.me/ARQRobot)
- `DEFAULT_CHATBOT` - The Default chatbot you want to use after OpenAI. (`affiliateplus` or `luna`)
- `MAX_TOKENS` - The maximum number of tokens to generate in the completion
**For Heroku Users,**
- `ON_HEROKU` - Set this var to `True`
- `HEROKU_APP_NAME` - Your Heroku app name
- `HEROKU_API` - Your Heroku API
- Go to [account dashboard](https://dashboard.heroku.com/account)
- Scroll down and find the "API Key" section and click on Reveal button to get your API Key
### Note ⚠️
If you want to increase the response length limit change [Max Response Length Limit Value](https://github.com/Itz-fork/Yui/blob/ef431bb67f5c51ee3d5a634d91a2b0f740192d36/Yui/data/defaults.py#L19) to whatever you want (Value must be a integer). Also increasing this can spend your OpenAI credits quickly
## Support 🍪
## License & Copyright 👮
```
Copyright (c) 2021 Itz-fork
This Yui repository is licensed under GPLv3 License (https://github.com/Itz-fork/Yui/blob/master/LICENSE)
Copying or Modifying Any Part of the code without permission is strictly prohibited
```