Code Monkey home page Code Monkey logo

read-my-document's Introduction

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://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:

read-my-document's People

Contributors

ranjeetkumar692 avatar ranjeet692 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.