Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jesusgautamah/chatgpt_assistant
ChatGPT Virtual Assistant to Telegram and Discord with Voice Recognition
https://github.com/jesusgautamah/chatgpt_assistant
assistant aws aws-polly azure chatgpt chatgpt-api docker docker-compose ibm ibm-cloud ibm-watson ruby speech-recognition speech-synthesis text-to-speech voice-assistant
Last synced: 3 months ago
JSON representation
ChatGPT Virtual Assistant to Telegram and Discord with Voice Recognition
- Host: GitHub
- URL: https://github.com/jesusgautamah/chatgpt_assistant
- Owner: JesusGautamah
- License: mit
- Archived: true
- Created: 2023-03-24T12:49:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-23T17:00:22.000Z (about 1 year ago)
- Last Synced: 2024-09-27T01:04:41.601Z (3 months ago)
- Topics: assistant, aws, aws-polly, azure, chatgpt, chatgpt-api, docker, docker-compose, ibm, ibm-cloud, ibm-watson, ruby, speech-recognition, speech-synthesis, text-to-speech, voice-assistant
- Language: Ruby
- Homepage:
- Size: 302 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# ChatGPT Assistant
[](https://badge.fury.io/rb/chatgpt_assistant)
[](https://opensource.org/licenses/MIT)
[](https://www.ruby-lang.org/en/)
This Ruby gem provides an easy way to initialize a client for Telegram and Discord bots using the ChatGPT API, audio transcription, Text to Speech, creating an assistant that can answer questions in text and voice and have a conversation with the user.
#### Voice messages on telegram only - discord voice bot is not available and not planned to be implemented anymore
##### Discord voice bot is been replaced by a voice assistant local packege to act like google assistant, alexa, siri, cortana, etc. The voice assistant is been developed to linux and android, but it can be ported to other platforms in the future.
#### Speech to Text services - OpenAI Audio Transcription
##### More services will be added in the future
#### Text to Speech services - IBM Watson, AWS Polly, Azure Text to Speech
#### Languages supported currently: en, pt
#### Registration and Account Confirmation are avaiable on telegram only, sign in with the same credentials on discord after registering on telegram.
## Requirements
- Ruby > 2.6.0 - for the gem who can create bots projects in your machine
- Ruby 3.2.2 - inside the docker container or run the bots in your machine
- Docker
- Docker Compose
- PostgreSQL
- Telegram Bot API Token
- Discord Bot API Token
- IBM Cloud Text to Speech API Key or AWS Polly API Key
- OpenAI API Key
## Installation
To install the gem, run:
```bash
gem install chatgpt_assistant
```
Alternatively, you can clone/fork this repo to use it as you wish.
## Installation as a gem example
```bash
gem install chatgpt_assistant
chatgpt_assistant PATH_TO_FOLDER
cd PATH_TO_FOLDER
cp .env_sample .env
bundle install
```
## Installation as a repo
Run in your terminal:
```bash
git clone https://github.com/JesusGautamah/chatgpt_assistant.git
cd chatgpt_assistant
cp .env_sample .env
bundle install
```
Make sure to run bundle before using the Lucy Dockerunner rake tasks.
Then, edit the .env_sample file to include the necessary credentials and rename it to .env. Run bundle install to install the necessary dependencies.
Include `LUCY_SU=sudo` in your .env if u run docker compose with sudo
## Migrate your database
```bash
rake compose:up && sudo docker compose run --rm telegram exe/chatgpt_bot migrate
```
## Install [Awesome Chatgpt Actors](https://github.com/JesusGautamah/awesome-chatgpt-actors)
```bash
rake chatgpt_actors:install
```
## Usage
You can start the Docker Compose services required for the gem using the rake tasks provided by the Lucy Dockerunner gem. These tasks include compose:up, compose:down, compose:status, compose:shell, compose:restart, and others listed previously.
For example, to start the services, run:
```bash
rake compose:up
```
To stop the services, run:
```bash
rake compose:down
```
After starting the Docker Compose services, you can use the features of the gem to create a chat assistant that responds to questions in both text and voice using the services mentioned above.
#### More compose rake tasks at https://github.com/JesusGautamah/lucy_dockerunner
## Discord Bot Commands
The discord commands prefix can be changed in the .env file.
The default prefix is !!
- !!start - shows the welcome message
- !!help - shows the help message
- !!login email:password - logs in the user. Remember to use private messages to register or login and share a server with right permissions with the bot to message it.
- !!list - lists the user created chatbots
- !!sl_chat CHAT TITLE - starts a chat with the chatbot with the given title
- !!new_chat CHAT TITLE - creates a new chatbot with the given title
- !!ask TEXT - sends a text to the chatbot
## Telegram Bot Commands
- /start - shows the welcome message
- /help - shows the help message
- login/email:password - logs in the user. Remember to use private messages to register or login.
- register/email:password - registers a new user, email is not verfied yet, so you can use any email, the password is encrypted with bcrypt and stored in the database with salt. Remember to use private messages to register or login.
- confirm/* name:token - confirms the user account. Remember to use private messages to register or login
- list - lists the user created chatbots
- sl_chat/CHAT TITLE - starts a chat with the chatbot with the given title
- new_chat/CHAT TITLE - creates a new chatbot with the given title
- TEXT - sends a text to the chatbot
- VOICE_MESSAGE or AUDIO FILE - sends a voice message to the chatbot and returns the response in voice
## Contributing
A good way to contribute is add your language to DefaultMessages class in lib/chatgpt_assistant/default_messages.rb. You can also add your language to the list of languages in the README.md file.
Bug reports and pull requests are welcome on GitHub at https://github.com/JesusGautamah/chatgpt_assistant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/JesusGautamah/chatgpt_assistant/blob/master/CODE_OF_CONDUCT.md).
## [](https://repography.com) / Recent activity [](https://repography.com)
[](https://github.com/JesusGautamah/chatgpt_assistant/commits)
[](https://github.com/JesusGautamah/chatgpt_assistant/issues)
[](https://github.com/JesusGautamah/chatgpt_assistant/pulls)
[](https://github.com/JesusGautamah/chatgpt_assistant/commits)
[](https://github.com/JesusGautamah/chatgpt_assistant/graphs/contributors)
[](https://github.com/JesusGautamah/chatgpt_assistant/commits)
## Contributors
- [Jesus Gautamah](https://github.com/JesusGautamah)
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the ChatgptAssistant project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/JesusGautamah/chatgpt_assistant/blob/master/CODE_OF_CONDUCT.md).