26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
# 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.
|
|
|
|
### Why?
|
|
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
|
|
* 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).
|
|
* [Openai API-key](https://platform.openai.com/settings/profile?tab=api-keys)
|
|
|
|
## Installation, setup and running the bot
|
|
* `yarn install`
|
|
* `nvm use`
|
|
* `cp config.ts.example config.ts`
|
|
* Add matrix homeserver, bot-token and Openai API-key to the `config.ts`
|
|
* Run `yarn start` to start the bot
|
|
|
|
## Planned features
|
|
* Enable encryption
|
|
* Allow setting the model in the config-file
|
|
* Add logic for user management
|
|
* Add option to temporarily set/reset context
|