discord-rag

KO | EN

gitlite — search

#javascript #python #hacktoberfest #typescript #llm #go #android #deep-learning #nodejs #windows #cli #pytorch #security #ios

(★ 25)

Easily create a RAG app based on your Discord messages

discord-rag 최신버젼 다운로드

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

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Discord-RAG

This repo aims to provide a simple and fast way to create a RAG (Retrieval-Augmented Generation) application based on your Discord messages. This allows you to use an LLM that is aware of the context of your messages and can generate responses based on that. The repo also provides code to create a Discord bot that can be used to interact with the model directly in your Discord server. Ask for old informations that were discussed long ago, make summaries, ask questions about you and your friends, have fun with the bot!

Here is a high-level overview of the architecture we are going to build:
![](https://raw.githubusercontent.com/antoinelrnld/discord-rag/main/docs/img/discord-rag-architecture.png)

To get started, you will need to get through the following steps:

1. [Prerequisites](#1-prerequisites)
2. [Initial Data Ingestion](#2-initial-data-ingestion)
3. [Run the Indexing Pipeline](#3-run-the-indexing-pipeline)
4. [Launch the API](#4-launch-the-api)
5. [Discord Bot](#5-discord-bot)

> [!WARNING]  
> Keep in mind that the project is in its early stages and is only a prototype for now.

## 1. Prerequisites

- A [Discord Bot Token](https://discordjs.guide/preparations/setting-up-a-bot-application.html#your-bot-s-token)
- An [OpenAI API Key](https://platform.openai.com/settings/)
- [Docker](https://www.docker.com/) (Recommended)
- [Docker Compose](https://docs.docker.com/compose/) (Recommended)

## 2. Initial Data Ingestion

![](https://raw.githubusercontent.com/antoinelrnld/discord-rag/main/docs/img/initial-data-ingestion.png)

First, you will need to export the messages from your Discord server to store them elsewhere. We are going to store them in a MongoDB database.
You can either use your existing MongoDB instance or get one by using the [docker-compose.yml](./docker-compose.yml) file.

> [!IMPORTANT]  
> Don't forget to set the required environment variables in the [.env](./production/initial_ingestion/src/.env) file.  
> You will need the IDs of the channels you want to export the messages from. (Comma-separated)  
> You can get it by right-clicking on the channel and selecting "Copy ID" in Discord (you will need to enable Developer Mode in the settings).

First we start the MongoDB instance:
```console
docker-compose up mongo -d
```

Then we start the export process:
```console
docker-compose run initial_ingestion
```

> [!NOTE]  
> The extraction process can take a while depending on the number of messages in the channel(s).  
> You can keep track of the progress by checking the logs.  
> If the process is interrupted, you can restart it and it will continue from where it left off.  
> Once the process is done, you can move on to the next step.

## 3. Run the Indexing Pipeline

![](https://raw.githubusercontent.com/antoinelrnld/discord-rag/main/docs/img/indexing-pipeline.png)

Now that the messages are stored in the database, we can start the indexing pipeline. This will create the necessary indexes and embeddings for the messages to be used by the model. We are using a [SemanticChunking](https://github.com/FullStackRetrieval-com/RetrievalTutorials/blob/a4570f3c4883eb9b835b0ee18990e62298f518ef/tutorials/LevelsOfTextSplitting/5_Levels_Of_Text_Splitting.ipynb) strategy to split the messages into chunks. This allows us to group consecutive messages of the same topic together to have a better representation of the context. At least that's the idea.

> [!IMPORTANT]
> Don't forget to set the required environment variables in the [.env](./production/indexing_pipeline/.env) file.  
> You can let the default values if you want but you will need to set the `OPENAI_API_KEY`.

```console
docker-compose up mongo chroma -d # Make sure the MongoDB and ChromaDB instances are running
docker-compose run indexing_pipeline
```

> [!NOTE]
> The indexing process can be relatively slow because of the Semantic Chunking strategy.  
> Once it's done, you can move on to the next step.

## 4. Launch the API

![](https://raw.githubusercontent.com/antoinelrnld/discord-rag/main/docs/img/api.png)

We are now ready to launch the API that will allow us to interact with the model. The API receives a prompt from the user, retrieves the most relevant messages from the vector store, includes them in the prompt, and sends it to the model. The model then generates a response based on the context provided.

> [!IMPORTANT]  
> Don't forget to set the required environment variables in the [.env](./production/api/.env) file.  
> You can let the default values if you want but you will need to set the `OPENAI_API_KEY`.

You can set the `AGENT__LANGUAGE` variable to change the language of the system prompt that will be given to the LLM. Supported languages are:
- en (English) (default)
- fr (French)

Feel free to contribute to the repo and add more languages in the [system_prompt.py](./production/api/src/api/agent/system_prompt.py) file. You can also modify the existing prompts to better suit your needs.

```console
docker-compose up api -d
```

### Using the API

The API provides two endpoints:

| Method | Endpoint | Description | Parameters |
|--------|----------|-------------|------------|
| GET | /health | Check if the API is running | |
| POST | /invoke | Generate a response based on the prompt | `text` (JSON body) |

- `/invoke` will return a JSON response with the generated text.
    ```json
    {
        "question": "Tell me what you know about the time we went to the beach last summer.",
        "context": ["...", "..."],
        "answer": "When you went to the beach last summer, it was a sunny day and you had a lot of fun. You played volleyball and swam in the sea. You also had a picnic and watched the sunset. It was a great day!"
    }
    ```
- `/health` will return a JSON response with the status of the API.
    ```json
    {
        "status": "ok"
    }
    ```

> [!TIP]  
At this point the RAG application is ready to be used. Feel free to integrate it in any application. If you want to interact with the model directly in your Discord server, we provide the code of a Discord bot that you can use in the next section.

## 5. Discord Bot

> [!CAUTION]  
> The real-time data ingestion is not implemented yet.

![](https://raw.githubusercontent.com/antoinelrnld/discord-rag/main/docs/img/bot.png)

The Discord bot allows you to chat with the model directly in your Discord server. This way, everyone in your server can easily use the RAG application seamlessly. To interact with the bot, use the `/ask` command followed by the question you want to ask. The bot will then generate a response based on the context of the messages it has seen.

> [!IMPORTANT]  
> Don't forget to set the required environment variables in the [.env](./bot/src/.env) file.  
> You will need the `DISCORD_BOT_TOKEN` and the `DISCORD_BOT_CLIENT_ID`.  
> You can find the CLIENT_ID of your bot in the [Discord Developer Portal](https://discord.com/developers/applications) (Named "Application ID").

```console
docker-compose up bot -d
```

## Et Voilà!

![](https://raw.githubusercontent.com/antoinelrnld/discord-rag/main/docs/img/discord-rag-architecture.png)

We built a simple RAG application for Discord! Feel free to contribute to the repo and suggest improvements. For now it is still a proof of concept, there is a lot of room for improvement.

Once you went through all the steps at least once, you can start the whole application with a single command:

```console
$ docker-compose up mongo chroma api bot -d
```

discord-rag

discord-rag 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

discord-rag

discord-rag 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README