Skip to content

A question-answering framework empowered with a custom retrieval-augmented generation (RAG) pipeline to answer queries on local documents

Notifications You must be signed in to change notification settings

maryamyazdi/QA-with-RAG

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Question Answering with Retrieval-Augmented Generation

QA-with-RAG is a free, containerised question-answer framework that allows you to ask questions about your documents and get accurate answers.

This app uses a method called retrieval-augmented generation (RAG) to retrieve information that is relevant to your question from your uploaded documents. It then uses a large language model (LLM) to answer the question with the retrieved context.

Preview

 

Technical Components

The current implementation uses the following components:

Getting Started

  1. Install poetry on your machine

  2. Creat a virtual environment and install the dependencies specified in the pyproject.toml file by running

poetry install
  1. Run the project using the command
docker compose up

Note: The first time you run this, it might take a while to build the image and download the embedding model.

  1. The UI (as showed in the snapshot in the Preview section) should open up in your default browser running on the port 8501.

Usage

I. Select the directory containing your pdf file(s).

II. Type your question

III. Choose a language model used for final inference

VI. Choose the number of retrieved chunks from the database. The higher this number, the more complex your result may be.

V. Run and enjoy!

About

A question-answering framework empowered with a custom retrieval-augmented generation (RAG) pipeline to answer queries on local documents

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Languages