matrix-bot-openai-wrapper/README.md

25 lines
967 B
Markdown
Raw Normal View History

2024-08-25 01:58:37 +00:00
# matrix-bot-openai-wrapper
## 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 way they can do less user-tracking if multiple people prompt through the same API token.
Also chat clients, such as Matrix, are more practical to interact with bots.
## Requirements
* 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).
## Installation, setup and running the bot
* `yarn install`
* `nvm use`
* `cp config.ts.example config.ts`
* Edit the `config.ts`
* Run `yarn start` to start the bot
## Planned features
* Improve formatting
2024-08-25 01:59:49 +00:00
* Allow setting the model in the config-file
2024-08-25 01:58:37 +00:00
* Add logic for user management
* Add option to temporarily set context
* Add option to reset context