Skip to content

ranjeet692/Read-My-Document

Repository files navigation

Read My Documents

Read-My-Document is a Langchain-based application that allows you to upload CSV, PDF, DOCX, and TXT files and ask questions related to the content of these documents. The application will search through the document and interact with Language Learning Models (LLMs) to generate a response to your query.

Features

  • Supports multiple file formats: CSV, PDF, DOCX, TXT.
  • Utilizes advanced Language Learning Models (LLMs) for query processing.
  • Allows users to select between different models, including OpenAI and GPT4All.
  • GPT4All, a ggml model, works locally on CPUs. Good for private documents. Applicaiton doesn't send document content to any api for embeding or generating response.

Initial Setup

Create a virtual environment

python3 -m venv .venv

Activate environment

source .venv/bin/activate

Install Dependencies

pip install -r requirements.txt

If using, Open AI APIs, Add your secret key

export OPENAI_API_KEY="your key" 

Get your Open API Keys

Open AI API

Running App

streamlit run main.py

With Docker

docker build -t MyDocumentQA .
docker run -p 8501:8501 MyDocumentQA

Access

Link: http:https://localhost:8501

App UI

App UI

Roadmap

  • Add support for text, doc, pdf and images

Project Architecture

Project Architecture

Local Models

Contributing

We welcome contributions to this project. To contribute:

Fork this repository. Create your feature branch (git checkout -b feature/fooBar). Commit your changes (git commit -am 'Add some fooBar'). Push to the branch (git push origin feature/fooBar). Create a new Pull Request.

License

This project is licensed as free for commercial use.

Contact Information

For more information or if you have any questions, you can reach out to us:

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages