Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
f1delius authored Jul 28, 2024
1 parent 2ce89a3 commit 61564d8
Showing 1 changed file with 10 additions and 36 deletions.
46 changes: 10 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,18 @@ pip install -r requirements.txt
"password": "YOUR_PASSWORD",
"device_id": "YOUR_DEVICE_ID",
"room_id": "YOUR_ROOM_ID",
"openai_api_key": "YOUR_API_KEY",
"gpt_api_endpoint": "xxxxxxxxx"
"superagent_url" : "SUPERAGENT_API_URL",
"api_key" : "SUPERAGENT_API_KEY",
"owner_id" : "MATRIX_USER_ID",
"id" : "workflow or agent superagent id",
"type" : "WORKFLOW or AGENT",
"STREAMING" : "TRUE or FALSE"
}
```

*streaming env variable is used for multi or singe bot setup
if streaming is true it uses multi_bot else single_bot

4. Launch the bot:

```
Expand All @@ -69,42 +76,9 @@ python src/main.py
## Usage

To interact with the bot, simply send a message to the bot in the Matrix room with one of the following prompts:<br>
- `!help` help message

- `!gpt` To generate a one time response:

```
!gpt What is the meaning of life?
```

- `!chat` To chat using official api with context conversation

```
!chat Can you tell me a joke?
```

- `!lc` To chat using langchain api endpoint
```
!lc All the world is a stage
```
- `!pic` To generate an image using openai DALL·E or LocalAI

```
!pic A bridal bouquet made of succulents
```
- `!agent` display or set langchain agent
```
!agent list
!agent use {agent_name}
```
- `!new + {chat}` Start a new converstaion

LangChain(flowise) admin: https://github.com/hibobmaster/matrix_chatgpt_bot/wiki/Langchain-(flowise)
- `@username:spaceship.im Hi` Start a new converstaion

## Image Generation
![demo1](https://i.imgur.com/voeomsF.jpg)
![demo2](https://i.imgur.com/BKZktWd.jpg)
https://github.com/hibobmaster/matrix_chatgpt_bot/wiki/ <br>


## Thanks
Expand Down

0 comments on commit 61564d8

Please sign in to comment.