matrix-bot-openai-wrapper/README.md
2024-08-25 03:59:49 +02:00

967 B

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.

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
  • Allow setting the model in the config-file
  • Add logic for user management
  • Add option to temporarily set context
  • Add option to reset context