Hugging Face's logo

Spaces:
Noobian
/
MultiPDFChat
Runtime error

App Files Community
MultiPDFChat / README.md
Noobian's picture
Noobian
Update README.md
9271044
preview code
|
raw
history blame contribute delete
2.95 kB

A newer version of the Streamlit SDK is available: 1.39.0

Upgrade
metadata
title: MultiPDFChat
emoji: 🌍
colorFrom: yellow
colorTo: purple
sdk: streamlit
sdk_version: 1.21.0
app_file: app.py
pinned: false
license: openrail

Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

MultiPDF Chat App

You can find the tutorial for this project on YouTube.

Introduction

The MultiPDF Chat App is a Python application that allows you to chat with multiple PDF documents. You can ask questions about the PDFs using natural language, and the application will provide relevant responses based on the content of the documents. This app utilizes a language model to generate accurate answers to your queries. Please note that the app will only respond to questions related to the loaded PDFs.

How It Works

MultiPDF Chat App Diagram

The application follows these steps to provide responses to your questions:

  1. PDF Loading: The app reads multiple PDF documents and extracts their text content.

  2. Text Chunking: The extracted text is divided into smaller chunks that can be processed effectively.

  3. Language Model: The application utilizes a language model to generate vector representations (embeddings) of the text chunks.

  4. Similarity Matching: When you ask a question, the app compares it with the text chunks and identifies the most semantically similar ones.

  5. Response Generation: The selected chunks are passed to the language model, which generates a response based on the relevant content of the PDFs.

Dependencies and Installation

To install the MultiPDF Chat App, please follow these steps:

  1. Clone the repository to your local machine.

  2. Install the required dependencies by running the following command:

    pip install -r requirements.txt

  3. Obtain an API key from OpenAI and add it to the .env file in the project directory.

Usage

To use the MultiPDF Chat App, follow these steps:

  1. Ensure that you have installed the required dependencies and added the OpenAI API key to the .env file.

  2. Run the main.py file using the Streamlit CLI. Execute the following command:

    streamlit run app.py

  3. The application will launch in your default web browser, displaying the user interface.

  4. Load multiple PDF documents into the app by following the provided instructions.

  5. Ask questions in natural language about the loaded PDFs using the chat interface.

Contributing

This repository is intended for educational purposes and does not accept further contributions. It serves as supporting material for a YouTube tutorial that demonstrates how to build this project. Feel free to utilize and enhance the app based on your own requirements.

License

The MultiPDF Chat App is released under the MIT License.