https://github.com/teddyrendahl/ragwar

Retrieval Augmented Generation Chatbot for Warhammer 40k Rules
https://github.com/teddyrendahl/ragwar

Last synced: 11 days ago
JSON representation

Retrieval Augmented Generation Chatbot for Warhammer 40k Rules

• Host: GitHub
• URL: https://github.com/teddyrendahl/ragwar
• Owner: teddyrendahl
• License: gpl-3.0
• Created: 2024-02-17T04:41:58.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-02-18T01:43:08.000Z (10 months ago)
• Last Synced: 2024-05-27T20:59:05.851Z (7 months ago)
• Language: Python
• Homepage:
• Size: 23.2 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ragwar

Retrieval Augmented Generation Chatbot for Warhammer40k Rules

https://github.com/teddyrendahl/ragwar/assets/25753048/5862045c-de43-422d-a99c-7f0dda9489ae

## Installation

```bash

$ pip install -r requirements.txt

```

## How to Use

This project requires a valid `OPENAI_API_KEY` to do the embedding and response generation. Simply create

a `.env` file in this directory with your key as shown in the `.env.example`.

## Creating the Database

This project uses Chroma to create a local vector database of the embeddings. It's assumed this is done

before running `app.py`

```bash

$ python create_db.py

```

Afterwards you should see the generated files in a `chroma` folder

## Running the Application

To run the application use `streamlit`:

```bash

$ streamlit run app.py

```