An open API service indexing awesome lists of open source software.

https://github.com/gokulgowthams/askdocs_gen-ai

Private Document Questioning and Answering Application which can answer any question that has been asked, by uploading the desired document the user can ask questions
https://github.com/gokulgowthams/askdocs_gen-ai

chromadb deeplearning docx2txt faiss generativeai huggingface langchain llama2 llamaindex openaiembeddings pdfplumber pinecone pymupdf sentencetransformer streamlit

Last synced: about 2 months ago
JSON representation

Private Document Questioning and Answering Application which can answer any question that has been asked, by uploading the desired document the user can ask questions

Awesome Lists containing this project

README

          

# ๐Ÿ’ฌ AskDocs AI

> *From documents to decisions โ€” powered by AI, secured locally.*

## ๐Ÿ” What is AskDocs AI?

**AskDocs AI** is a early stage startup comprising a powerful and private document question-answering app powered by **LLaMA 2** and **LangChain**. Upload your PDF, DOCX, or TXT files, and ask intelligent questions. All data is processed locally to maintain maximum privacy.

---

## ๐ŸŽฏ Features

- ๐Ÿ“„ Supports PDF, DOCX, and TXT files
- ๐Ÿง  Local LLaMA 2 model inference (no cloud dependencies)
- ๐Ÿ” Intelligent search & similarity-based retrieval
- ๐Ÿ“ฆ Built with Streamlit for an interactive UI
- ๐Ÿ–ผ๏ธ Custom dark-themed background support
- ๐Ÿงต Efficient multi-threaded document parsing

---

## ๐Ÿš€ Getting Started

### ๐Ÿ“ฆ Prerequisites

- Python 3.9+
- Download the LLaMA 2 model from [HERE!](https://huggingface.co/gokulgowtham01/AskDocs_GEN-AI/tree/main)

### ๐Ÿ“ Folder Structure

```
project_root/
โ”œโ”€โ”€ gen_ai.py # Streamlit application
โ”œโ”€โ”€ images/
โ”‚ โ””โ”€โ”€ freepik__adjust__9850.jpeg
โ”‚ โ””โ”€โ”€ 767.jpg
โ”œโ”€โ”€ faiss_index/ # Generated vector store (auto-created)
โ”œโ”€โ”€ evaluation_logs/ # Generated json file (auto-created)
โ”œโ”€โ”€ documents/
โ”‚ โ”œโ”€โ”€ empty.txt
โ”‚ โ”œโ”€โ”€ sample_doc.docx
โ”‚ โ”œโ”€โ”€ Advanced_Facts_Octopus.pdf
โ”‚ โ””โ”€โ”€ sample_txt.txt
โ””โ”€โ”€ requirements.txt
```

---

## ๐Ÿงฐ Installation

```bash
# Clone the repo
git clone https://github.com/yourusername/AskDocs_GEN-AI.git
cd AskDocs_GEN-AI

# (Optional) Create a virtual environment
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

```
## ๐Ÿง  Usage

```bash
# Run
streamlit run app.py
```

1. Upload one or more PDF, DOCX, or TXT documents.
2. Click Start The Fun!
3. Ask your question in natural language.
4. Get answers with cited document sources.

## ๐Ÿ“ฆ Dependencies

- streamlit
- PyMuPDF
- python-docx
- docx2txt
- requests
- numpy
- langchain
- sentence-transformers
- nltk
- rouge-score
- ctransformers
- faiss-cpu
- huggingface-hub

## ๐Ÿ“Ž Notes

- You need to download and manually place the LLaMA model.
- Ensure GPU support is configured if needed (set gpu_layers accordingly).
- Image background is customizable โ€” make sure the image path is valid.