https://github.com/animesh-algorithm/chat-with-pdf-cli
Chat with PDF documents
https://github.com/animesh-algorithm/chat-with-pdf-cli
chatgpt langchain-js language-model llms
Last synced: about 1 month ago
JSON representation
Chat with PDF documents
- Host: GitHub
- URL: https://github.com/animesh-algorithm/chat-with-pdf-cli
- Owner: animesh-algorithm
- License: mit
- Created: 2023-05-31T15:30:42.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-06T08:38:01.000Z (almost 2 years ago)
- Last Synced: 2024-04-28T17:04:19.618Z (about 1 year ago)
- Topics: chatgpt, langchain-js, language-model, llms
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/chat-with-pdf
- Size: 20.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Chat with PDF
Chat with PDF is a command-line application that allows you to have a conversational question-and-answer session with an AI-powered chatbot based on the contents of a PDF document.
## Installation
### Install the npm Package
To install the Chat with PDF npm package globally, make sure you have Node.js and npm (Node Package Manager) installed on your machine. If not, you can download them from [here](https://nodejs.org).
Open your terminal or command prompt and run the following command:
```bash
npm install -g chat-with-pdf
```
### Clone the Repository
To clone the GitHub repository, run the following command:
```bash
git clone https://github.com/animesharma3/chat-with-pdf.git
```
## Usage
### Command Line
1. Open your terminal or command prompt.
2. Set the `OPENAI_API_KEY` environment variable using the command line:
```bash
export OPENAI_API_KEY=your_openai_api_key
```
Replace `your_openai_api_key` with your actual OpenAI API key.
3. Run the application using the following command:
```bash
chat-with-pdf
```
4. Follow the prompts to provide the path to the PDF document and ask questions to interact with the chatbot.
### Visual Studio and C++ Development
1. Download and install Visual Studio from [here](https://visualstudio.microsoft.com/downloads/).
2. During the installation process, make sure to select "Desktop development with C++" from the available workloads.
3. Open your terminal or command prompt.
4. Set the `OPENAI_API_KEY` environment variable using the command line:
```bash
export OPENAI_API_KEY=your_openai_api_key
```
Replace `your_openai_api_key` with your actual OpenAI API key.
5. Run the application using the following command:
```bash
node chat
```
6. Follow the prompts to provide the path to the PDF document and ask questions to interact with the chatbot.
## License
This project is licensed under the MIT License.