Giter Club home page Giter Club logo

document-query-chatbot's Introduction

Document QA System

What is a Document Question Answering System?

Document Question Answering models can be used to answer natural language questions about documents. Typically, Document QA models consider textual, layout, and potentially visual information. This is useful when the question requires some understanding of the visual aspects of the document. Nevertheless, certain Document QA models can work without document images. Hence the task is not limited to visually-rich documents and allows users to ask questions based on spreadsheets, text, PDFs, etc.

A visual example of a Document Question Answering System

Source: https://huggingface.co/tasks/document-question-answering

Project Overview

This project is a web application that allows you to upload a PDF file and ask questions about the content of the document. The application uses the OpenAI API to generate answers to the questions asked about the uploaded document.

The application uses Pinecone to store the document embeddings generated from the uploaded PDF file that is used to give OpenAI the context of the document to generate answers to the questions asked about the document.

Pinecone Vector Database Generate Flowchart

Source: https://www.pinecone.io

Web Application Stack

  • Next.js v14
  • Tailwind CSS v3
  • TypeScript v5

Design

Font:

Montserrat (headings), Nunito (body)

Colour Theme:

Colour Theme

Source: https://coolors.co/897ceb-e9e8ee-99989f-575151-b2b7f6-d65e57

User Flow Diagram

User Flow Diagram

Diagram made with draw.io

AWS Architecture Diagram

AWS Architecture Diagram

Diagram made with draw.io

Services Used

OAuth Providers Used

Getting Started

First, run the initial setup:

# new terminal
nvm use # or download the node version in .nvmrc
npm run setup

Verify that an .env.local file is generated on your project directory. Also verify that node -v corresponds to the version in .nvmrc.

Then, run the development server:

npm run dev

Open http://localhost:3000 with your browser to see the web application.

You'll find Sanity Studio on http://localhost:3000/admin.

(OPTIONAL) Set Up Auto nvm use

You can set up nvm to automatically switch to the correct node version when you cd into this project directory. This is done by reading the .nvmrc file in the root of the project with the node version we are using.

Read here on achieving this.

Learn More

More information on Document QA Systems:

To learn more about Next.js, take a look at the following resources:

Similar Projects

document-query-chatbot's People

Contributors

raaedkabir avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.