Skip to content

fedeflowers/RAG_BGG

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RAG for board games

Requirements

Openai API key is needed, docker facilitates to run the app, otherwise install mongoDB and Qdrant locally and change settings to get access to these two locally

Overview

  • Search board game rules effortlessly with AI-powered Q&A.
  • Interact with uploaded PDFs to get instant rule clarifications.
  • View and retrieve past chats for easy reference.
  • Authenticated users can securely manage their sessions.
  • Load rulebooks seamlessly with PDF ingestion.
  • Leverage Docker for a hassle-free setup.
  • Efficiently handle game references without manual lookup.
  • Track and delete saved chats as needed.
  • Tweak settings to run locally with MongoDB and Qdrant.
  • Optimized for a smooth, intuitive user experience.
  • Have fun exploring board game rules like never before

Features

  • User Authentication: Secure sign-up and login process to manage user accounts.
  • PDF Upload: Ingest board game rulebooks in PDF format.
  • Interactive Q&A: Start with initial questions to guide user interaction.
  • Saved Chats: View, retrieve, and delete past chat sessions based on ingested files.
  • Reference Management: Easily reference specific details from uploaded games.
  • No Library Handling: Clearly indicates when no games have been ingested.

Getting Started

How to Start the Project with Docker

  1. Create external network:
    docker network create rag_bgg_rag_network
    
  2. Build and run image:
    docker-compose up --build
    
  3. If image is already built run
    docker-compose up
    
  4. Access streamlit at
    http://localhost:8501/
    

Required at least 8Gb of RAM given to docker

APP functionalities

Sign Up

Users need to create an account before accessing the app.

Sign Up

Login

Log in with your credentials to start using the app.

Login

Upload PDF

After logging in, upload a PDF file containing the board game rules.

Upload PDF

Start Questions

Begin your interaction with the app by answering initial questions.

Start Questions

Adjust Yuor Bot

Switch your openai bot and temperature

Openai Bot

Reference Feature

Access detailed references from the ingested game rules.

Reference

Saved Chats

View your saved chats, retrieve them based on file names, or delete them if no longer needed.

Saved Chats

No Libraries

If no games are ingested, the app will notify you accordingly.

No Libraries

About

RAG for optimal finding of information in boardgames rulebooks

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors