egbert

KO | EN

gitlite — search

#hacktoberfest #go #machine-learning #rust #deep-learning #linux #nodejs #awesome #cli #awesome-list #vue #pytorch #mcp #openai

(★ 23)

A sarcastic chatbot, and a platform for making your own (potentially unsarcastic) gpt-based chatbots on slack/discord/minecraft/etc.

egbert 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Egbert
A sarcastic gpt-based chat bot.

Actually no, its a platform where you can define your own gpt-based bots,
give them personalities and memories,
and have them talk on Discord, Slack, Minecraft, and other places.

But Egbert was the first bot here and he won't let you forget it.

![](https://raw.githubusercontent.com/hkniberg/egbert/main/docs/images/egbert.png)

Here are some silly examples from Minecraft and Discord.

![examples.png](https://raw.githubusercontent.com/hkniberg/egbert/main/docs/images/examples.png)

# Getting started

**Disclaimer:** This is very much work-in-progress, and we're doing it mostly for fun and learning.
So expect things to change and sometimes break. Any tips & suggestions are welcome!

## How to install
Make sure you have a reasonably fresh version of nodejs, then run:
- `npm install`

## How to get your first echo bot working
You can check that it works by running a sample configuration that just has a console-based echo bot.
- `npm start config/examples/console-echobot.json5`

Then, in the console, type `hello echobot` and it should reply.

## How to create bot that uses GPT

- Get an OpenAI API key at `https://platform.openai.com/account/api-keys`
  If you don't already have an OpenAI account you will need to create one.
- Copy `config/examples/console-openai.json5` to `config/config.json5`
- Replace `YOUR_API_KEY_HERE` with your OpenAI API key.
- Run it! `npm start` (it uses `config/config.json5` by default, but you can specify another file like above)
- In the console, type `hello Egbert` and you should get a snarky reply.

## How to connect your bot to Discord
- Create a Discord bot account at `https://discord.com/developers/applications`, and invite the bot to your discord server.
  Here is a [useful tutorial](https://www.ionos.com/digitalguide/server/know-how/creating-discord-bot/).
- Open `config/discord-echobot.json5`. Copy the discord chat source config under `chat-sources` into your `config/config.json5`, and add your bot key.
- Run it! `npm start`
- Go to your discord server and type `hello egbert`. You should get a snarky reply.

## How to connect your bot to Slack
- Create a slack app on https://api.slack.com/apps. Get a hold of your `bot token`, `signing secret`, and `app token`.
- Open `config/slack-echobot.json5`. Copy the slack chat source config under `chat-sources` into your `config/config.json5`, and update as needed.
- Run it! `npm start`
- Go to your slack workspace and type `hello egbert`. You should get a snarky reply.

## How to connect your bot to Minecraft
- Bots can listen to a Minecraft server log, and respond to messages in-game using RCon and /tellraw commands.
- Open `config/minecraft-echobot.json5`. Copy the minecraft chat source config under `chat-sources` into your `config/config.json5`, and edit it as needed.
- Run it! `npm start`
- Log in to your Minecraft server and type `hello egbert`. You should get a snarky reply.

# How it works

* A **chat source** is a place where a bot can chat. For example a Discord server or Slack workspace.
* When a message is detected (for example someone writes on a discord channel), 
the chat source relays the message to the associated bots (see Social Context below) and gives them a chance to generate a response.
* If a bot wants to respond (for example because its name was mentioned), 
it will connect to OpenAI and generate a response using chat gpt (we may add support for other response generators in the future).
* The chat source relays the response back, for example as a discord message response.

![img.png](https://raw.githubusercontent.com/hkniberg/egbert/main/docs/images/message-flow-example.png)

You can add multiple chat sources and multiple bots, and connect them as you like.

![img.png](https://raw.githubusercontent.com/hkniberg/egbert/main/docs/images/multiple-chat-sources.png)

# Chat context

When talking to a bot it's nice if the bot is aware of the recent messages in the channel,
so you can actually have a back-and-forth conversation.
We call this **chat context**.
Whenever a chat source asks a bot to generate a response, it also includes the chat context.

The details of this depend on the chat source. For example:
* In Discord chat source, the chat context is the previous X messages (configurable) in the same channel.
* In Minecraft chat source, the chat context is the previous X messages in the chat log.
Note that this may include non-chat things like somebody logging in or dying, 
and the bot can be configured to respond to that too.

Here is an example of what happens when a chat source receives the trigger message `Egbert, what do you think?`,
and uses the previous 4 messages as chat context when asking the bot to generate a response.

> Chat context:
>> * [Henrik] Hi Pat, what did you do this weekend?
>> * [Pat] Learned how to make pizza!
>> * [Henrik] Was it worth the effort?.
>> * [Pat] Not really.
>> 
> Trigger message:
>> * [Henrik] Egbert, what do you think?
>>
> Response message:
>> * [Egbert] She should have ordered the pizza in the first place. Cooking is overrated.

The prompt sent to OpenAI will look something like this:

> **GPT Prompt:**  
> You are Egbert, a sarcastic unhelpful bot.  
> Here is the recent chat history:  
> * [Henrik] Hi Pat, what did you do this weekend?
> * [Pat] Learned how to make pizza!
> * [Henrik] Was it worth the effort?.
> * [Pat] Not really.
>
> Respond to this:
> * [Henrik] Egbert, what do you think?`

# Memories

Bots can have a long-term memory (= stored on disk). This is done by hooking up a **memory manager** to the bot.

We currently support two memory managers:
- **Keyword triggered memory manager**: The bot remembers things when you ask it to remember them.
For example `"Egbert, remember: Never laugh at Dave's jokes"`. Memories are saved in a JSON file in the `memories` folder.
- **Weaviate memory manager**: The bot remembers everything important that is said to it and stores in [Weaviate](https://weaviate.io/), 
an open source vector DB that you can easily run locally.
When generating responses it will selectively include memories that are relevant to the current chat context.

Which to choose? That depends.
- Keyword triggered memory manager gives you 100% control over what your bot remembers.
But you can't add too many memories because of GPT token limits.
- Weaviate memory manager is fully automated and more scalable, 
but you have less control over exactly which memories your bot will save and recall.

Regardless of which memory manager you use, the relevant memories will be included in the prompt to GPT.

> **GPT Prompt:**  
> You are Egbert, a sarcastic unhelpful bot.
> 
> You have the following memories:
> * [Jim] Never laugh at Dave's jokes
> * [Henrik] I made Egbert because I like to code
>  
> (recent chat history here)
> 
> [Jim] Hey Egbert, you seem a bit buggy today.

This makes the bots more useful, and a lot more fun. For example exchanges like this:

> * [Jim] Hey Egbert, you seem a bit buggy today.
> * [Egbert] Not my fault. Go talk to Mr Genius Coder Henrik over there.

A fun little detail is that you configure the discord chat source to add an emoji to
any message that it has remembered. That's especially useful with the Weaviate memory manager,
since you wouldn't know otherwise.

![img.png](https://raw.githubusercontent.com/hkniberg/egbert/main/docs/images/remember-emoji.png)

## Keyword triggered memory manager

To enable keyword triggered memory management:
 
- Take a look at `config/examples/console-openai-keywordmemory.json5`
- Copy the `memoryManagers` section to your config. 
- Add `"memoryManager": "keyword"` to your bot config entry.

That's it. Try it! Start up the app and inject some memories using "Egbert, remember: ....".
You'll see a file popping up in your `memories` folder, 
and the console will show how the memories are included in each prompt.
Restart the app (to clear the chat history) and ask some questions to test if Egbert remembered correctly.

One caveat with this memory manager is that it always includes all stored memories in the GPT prompt,
so if you have too many memories you will hit the GPT token limit and get an error.

## Weaviate memory manager

- Take a look at `config/examples/console-openai-weaviate.json5`
- Copy the `memoryManagers` section to your config.
- Insert your openAi key there, and tweak any other numbers if you like.
- Add `"memoryManager": "weaviate"` to your bot config entry.

You will need a weaviate instance to connect to.

You can easily run weaviate locally using [docker compose](https://docs.docker.com/compose/install/).
For starters, you can simply run `config/examples/docker-compose.yml`.

- `cd config/examples` 
- `docker-compose up`

That's it! Now you have a running Weaviate DB listening on port 8080,
and the weaviate example config above should work right out of the box.

Try it! Start up the app and chat with Egbert about some random topics.
The console will show how a fixed number of relevant memories are included in each prompt.
Restart the app (to clear the chat history) and ask some questions to test if Egbert remembered correctly.

Note that the sample docker-compose file has some commented out lines that you can use to configure where
the memories are stored on disk. If you don't do this, the memories will disappear if the docker container is removed.
Useful for testing, but for production you probably want to store the memories on disk.

The nice thing about this memory manager is that it includes only a fixed number of memories in each prompt,
regardless of how many are stored. So it is less likely to cause token limit problems.

The problem with saving ALL messages is that you get quite a lot of junk in the vector DB, things like "Hi Egbert" or questions
like "Egbert, what do you think?". These are not very useful memories to recall when generating responses. 
To solve this, we can ask GPT to determine if a message is worth saving or not. 
See the commented out section of `config/examples/console-openai-weaviate.json5` for an example of this.

# Social context

When you have the same bot connecting to multiple chat sources,
you need to decide if the bot should have separate memories for each chat source.
This is configured using **social contexts**.
A social context is essentially just a tag that you set on chat sources and bots in the config file.

> **Example: shared social context**  
> Me and my friends have a little gaming community with a discord server and Minecraft server,
> and Egbert is present on both.
> I've configured these to use the same social context. 
> That way, if I say "Egbert, Remember: Never laugh at Dave's jokes", then that will apply
> on both the Discord server and in Minecraft.

> **Example: different social contexts**  
> I have a family discord as well, and Egbert is present there too. 
> However I use a different social context called "family" for that, so Egbert has a separate
> memory bank for things that are relevant to my family only.

When a chat message comes in, the associated chat source will determine which social context the message belongs to.
For example a single Discord chat source may connect to multiple Discord servers (or guilds),
and you can configure each one to use a different social context.

An incoming message will only be relayed to bots that are in that social context.
A bot can belong to multiple social contexts and it will keep those memories separate.

# Known issue: Token limits

When talking to GPT there is a limit to how much text can be included in a prompt & response. 
Currently the application crashes when we hit that limit. We need to implement token counting.

This is especially an issue with the keyword triggered memory manager (see above).
If you add too many memories it will crash every time because of token limits.

# Which chat sources are provided?

- Slack
- Discord
- Minecraft
- Telegram

Coming soon:
- Teams

# Development tips

- `npm test` runs unit tests
- `npm run watch` will run the typescript compiler in watch mode, so it will auto-recompile when you change a file.

# License

This project is licensed under the MIT License - see the LICENSE file for details.

egbert

egbert 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

egbert

egbert 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README