diff --git a/README.md b/README.md index 6aa3c66..4ca09ee 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,25 @@ ## Introduction -This is a simple Matrix bot that uses OpenAI's GPT API and Bing AI and Google Bard to generate responses to user inputs. The bot responds to these commands: `!gpt`, `!chat` and `!bing` and `!pic` and `!bard` and `!talk`, `!goon`, `!new` and `!lc` and `!help` depending on the first word of the prompt. -![Bing](https://user-images.githubusercontent.com/32976627/231073146-3e380217-a6a2-413d-9203-ab36965b909d.png) -![image](https://user-images.githubusercontent.com/32976627/232036790-e830145c-914e-40be-b3e6-c02cba93329c.png) +This is a simple Matrix bot that support using OpenAI API, Langchain to generate responses from user inputs. The bot responds to these commands: `!gpt`, `!chat` and `!pic` and `!talk`, `!goon`, `!new` and `!lc` and `!help` depending on the first word of the prompt. ![ChatGPT](https://i.imgur.com/kK4rnPf.jpeg) ## Feature -1. Support Openai ChatGPT and Bing AI and Google Bard -2. Support Bing Image Creator -3. Support E2E Encrypted Room -4. Colorful code blocks -5. Langchain([Flowise](https://github.com/FlowiseAI/Flowise)) -6. ChatGPT Web ([pandora](https://github.com/pengzhile/pandora)) -7. Session isolation support(`!chat`,`!bing`,`!bard`,`!talk`) +1. Support official openai api and self host models([LocalAI](https://github.com/go-skynet/LocalAI)) +2. Support E2E Encrypted Room +3. Colorful code blocks +4. Langchain([Flowise](https://github.com/FlowiseAI/Flowise)) + ## Installation and Setup Docker method(Recommended):
Edit `config.json` or `.env` with proper values
For explainations and complete parameter list see: https://github.com/hibobmaster/matrix_chatgpt_bot/wiki
-Create an empty file, for persist database only
+Create two empty file, for persist database only
```bash -touch db +touch sync_db manage_db sudo docker compose up -d ``` @@ -47,7 +43,7 @@ pip install -U pip setuptools wheel pip install -r requirements.txt ``` -3. Create a new config.json file and fill it with the necessary information:
+3. Create a new config.json file and complete it with the necessary information:
Use password to login(recommended) or provide `access_token`
If not set:
`room_id`: bot will work in the room where it is in
@@ -63,13 +59,11 @@ pip install -r requirements.txt "device_id": "YOUR_DEVICE_ID", "room_id": "YOUR_ROOM_ID", "openai_api_key": "YOUR_API_KEY", - "access_token": "xxxxxxxxxxxxxx", - "api_endpoint": "xxxxxxxxx", - "bing_auth_cookie": "xxxxxxxxxx" + "api_endpoint": "xxxxxxxxx" } ``` -4. Start the bot: +4. Launch the bot: ``` python src/main.py @@ -92,39 +86,23 @@ To interact with the bot, simply send a message to the bot in the Matrix room wi !chat Can you tell me a joke? ``` -- `!bing` To chat with Bing AI with context conversation - -``` -!bing Do you know Victor Marie Hugo? -``` - -- `!bard` To chat with Google's Bard -``` -!bard Building a website can be done in 10 simple steps -``` - `!lc` To chat using langchain api endpoint ``` -!lc 人生如音乐,欢乐且自由 +!lc All the world is a stage ``` -- `!pic` To generate an image from Microsoft Bing +- `!pic` To generate an image using openai DALL·E or LocalAI ``` !pic A bridal bouquet made of succulents ``` -- `!new + {chat,bing,bard,talk}` Start a new converstaion +- `!new + {chat}` Start a new converstaion -The following commands need pandora http api: -https://github.com/pengzhile/pandora/blob/master/doc/wiki_en.md#http-restful-api -- `!talk + [prompt]` Chat using chatGPT web with context conversation -- `!goon` Ask chatGPT to complete the missing part from previous conversation - -## Bing AI and Image Generation +## Image Generation https://github.com/hibobmaster/matrix_chatgpt_bot/wiki/
-![](https://i.imgur.com/KuYddd5.jpg) -![](https://i.imgur.com/3SRQdN0.jpg) + ## Thanks 1. [matrix-nio](https://github.com/poljar/matrix-nio)