realestninja/matrix-bot-openai-wrapper
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Nikhil Nawgiri 2024-09-10 11:36:53 +02:00
parent 7a9d296530
commit 4bf1452e86
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -2,23 +2,23 @@
## What does this bot do? ## What does this bot do?
This bot relays the prompt to the openai API and sends the answer back to the user who made the request. All this is done through the Matrix chat-client. This bot relays the prompt to the openai API and sends the answer back to the user who made the request. All this is done through the Matrix chat-client.
This way they can do less user-tracking if multiple people prompt through the same API token. ### Why?
Also chat clients, such as Matrix, are more practical to interact with bots. This way Openai can do less user-tracking since different people prompt through the same API-key.
Also imo chat clients, such as Matrix, are more practical instead of using the official app.
## Requirements ## Requirements
* Local environment requires `nodejs`, `yarn` and `nvm` * Local environment requires `nodejs`, `yarn` and `nvm`
* Access token for the Matrix account. The access token can be obtained by using this [script](https://git.pub.solar/realestninja/fetch-matrix-access-token). * Access token for the Matrix account. The access token can be obtained by using this [script](https://git.pub.solar/realestninja/fetch-matrix-access-token).
* [Openai API-key](https://platform.openai.com/settings/profile?tab=api-keys)
## Installation, setup and running the bot ## Installation, setup and running the bot
* `yarn install` * `yarn install`
* `nvm use` * `nvm use`
* `cp config.ts.example config.ts` * `cp config.ts.example config.ts`
* Edit the `config.ts` * Add matrix bot-token and Openai API-key to the `config.ts`
* Run `yarn start` to start the bot * Run `yarn start` to start the bot
## Planned features ## Planned features
* Improve formatting
* Allow setting the model in the config-file * Allow setting the model in the config-file
* Add logic for user management * Add logic for user management
* Add option to temporarily set context * Add option to temporarily set/reset context
* Add option to reset context