Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/harshilshah1804/chatbot-pdf
This repository is created for the web development project of Custom PDF ChatBot by METIS, IITGN.
https://github.com/harshilshah1804/chatbot-pdf
cassandra flask gradient html-css-javascript langchain llama-index llama3
Last synced: 4 months ago
JSON representation
This repository is created for the web development project of Custom PDF ChatBot by METIS, IITGN.
- Host: GitHub
- URL: https://github.com/harshilshah1804/chatbot-pdf
- Owner: HarshilShah1804
- License: apache-2.0
- Created: 2024-05-22T10:08:49.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-20T07:55:58.000Z (7 months ago)
- Last Synced: 2024-10-12T19:02:11.606Z (4 months ago)
- Topics: cassandra, flask, gradient, html-css-javascript, langchain, llama-index, llama3
- Language: JavaScript
- Homepage: https://chatbot-pdf-52a2.onrender.com/
- Size: 9.37 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PDF - ChatBot
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Screenshots](#screenshots)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
- [Contributing](#contributing)
- [Contributors](#contributors)
## Introduction
[](https://github.com/HarshilShah1804/Chatbot-PDF/issues)
[](https://github.com/HarshilShah1804/Chatbot-PDF/stargazers)
[](https://github.com/HarshilShah1804/Chatbot-PDF/blob/main/LICENSE)
This repository contains a Flask-based web application that allows users to upload PDF files and interact with the chatbot to get responses to their queries on the content of the uploaded PDF. This project was developed for the summer projects released by Metis Club, IIT Gandhinagar. The LLM used was Llama3 by Meta, and the tech stack in frontend included HTML, CSS, Javascript, and FetchAPI integration; in backend, Python and Flask were used.
## Features
- Efficient reading of pdf files using Llamaparse
- Interactive UI that simulates chatting
## Screenshots
## Installation
### Clone the repository
```git
git clone https://github.com/HarshilShah1804/Chatbot-PDF.git
cd Chatbot-PDF
```
### Install Dependencies
```python
pip install -r requirements.txt
```
### Setting up Environment Variables
In Chatbot.py, add your Gradient access token and workspace ID and your llamaindex API key
```python
os.environ['GRADIENT_ACCESS_TOKEN'] = "YOUR_GRADIENT_ACCESS_TOKEN"
os.environ['GRADIENT_WORKSPACE_ID'] = "YOUR_GRADIENT_WORKSPACE_ID"
```
```python
api_key="your_api_key"
```
### Run the application
```bash
python app.py
```
By default, the application will be accessible at http://127.0.0.1:5000/.
## Usage
The app is configured in a way that it will not give answers to questions outside the scope of the PDF.
### Uploading a PDF.
1. Click on the "Upload" button.
2. Select the PDF file from your system. It will be automatically uploaded.
### Asking a query
1. After uploading a PDF, the bot will take some time to parse it, and a prompt will appear once it is ready to answer your queries.
2. After getting the prompt, type your query in the text box and click the send button.
## License
Distributed under the Apache License 2.0. See LICENSE for more information.
## Contributing
Contributions make the open-source community such an amazing place to be, learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## Contributors
[Harshil Shah](https://github.com/HarshilShah1804) |
[Rishank Soni](https://github.com/RishankSoni) |
[Samarth Sonawane](https://github.com/samarth2015)