https://github.com/dotvignesh/PDFChat
The PDFChat app allows you to chat with your PDF files in natural language.
https://github.com/dotvignesh/PDFChat
embeddings gpt-3 langchain llm openai python streamlit
Last synced: about 1 year ago
JSON representation
The PDFChat app allows you to chat with your PDF files in natural language.
- Host: GitHub
- URL: https://github.com/dotvignesh/PDFChat
- Owner: dotvignesh
- Created: 2023-04-07T14:57:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-08T10:32:16.000Z (about 3 years ago)
- Last Synced: 2024-11-06T02:38:26.351Z (over 1 year ago)
- Topics: embeddings, gpt-3, langchain, llm, openai, python, streamlit
- Language: Python
- Homepage:
- Size: 5.54 MB
- Stars: 135
- Watchers: 3
- Forks: 47
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PDFChat
The PDFChat app allows you to chat with your PDF files using the power of langchain, OpenAI Embeddings, and GPT3.5 in the backend.
It uses Streamlit for the user interface.
## Demo
https://user-images.githubusercontent.com/19832025/230705607-00e830c1-0181-49b6-ba92-4c9294b6cec3.mp4
## Installation
To install and run the application, follow the instructions below:
1. Clone the repository using Git:
```bash
git clone https://github.com/dotvignesh/PDFChat.git
```
2. Change into the repository directory:
```bash
cd PDFChat
```
3. Create a conda environment:
```bash
conda create --name pdfchat
```
4. Activate the new conda environment:
```bash
conda activate pdfchat
```
5. Install the required packages:
```bash
pip install -r requirements.txt
```
6. Get your OpenAI API Key by following these steps:
- Go to [OpenAI Website](https://platform.openai.com/account/api-keys)
- Create an account or log in
- Navigate to the "API Keys" section
- Click on the "Create new secret key" button (or use an existing one)
- Copy the API key
7. Create a `.env` file in the root of the repository directory, and add the following line, replacing `` with your actual API key:
```bash
OPENAI_API_KEY=
```
8. Run the application using streamlit:
```bash
streamlit run app.py
```
The application should now be running at http://localhost:8501.
## Usage
Once the app is running, you can upload your PDF files and start chatting with them using the built-in chat interface.
Enjoy chatting with your PDF files!