matrix_chatgpt_bot/README.md

Introduction

This is a simple Matrix bot that uses OpenAI's GPT API and a Chatbot to generate responses to user inputs. The bot responds to two types of prompts: !gpt and !chat, depending on the first word of the prompt.

Installation and Setup

Docker method:
Edit config.json with proper values

sudo docker compose up -d

---

To run this application, follow the steps below:

1. Clone the repository:

git clone https://github.com/hibobmaster/matrix_chatgpt_bot.git

2. Install the required dependencies:
   

pip install -r requirements.txt

3. Create a new config.json file and fill it with the necessary information:
   If not set:
   room_id: bot will work in the room where it is in
   api_key: !chat command will not work

{
    "homeserver": "YOUR_HOMESERVER",
    "user_id": "YOUR_USER_ID",
    "password": "YOUR_PASSWORD",
    "device_id": "YOUR_DEVICE_ID",
    "room_id": "YOUR_ROOM_ID",
    "api_key": "YOUR_API_KEY"
}

4. Start the bot:

python main.py

Usage

To interact with the bot, simply send a message to the bot in the Matrix room with one of the two prompts:

• !gpt To generate a response using free_endpoint API:

!gpt What is the meaning of life?

• !chat To chat using official api with context associated support

!chat Can you tell me a joke?