- 📒 Table of Contents
- 📍 Overview
- ⚙️ Features
- 📂 Project Structure
- 🧩 Modules
- 🚀 Getting Started
- 🤝 Contributing
The ChatPDF project is a Streamlit application that allows users to upload PDF and DOCX files and interact with a conversational AI model. It utilizes OpenAI API for conversational interactions and FAISS for fast similarity search. This project's core functionalities include parsing documents, extracting text, generating embeddings for user queries, and providing relevant responses based on document content. Its value proposition lies in simplifying the process of extracting information from documents and facilitating conversational interactions with the content.
| Feature | Description |
|---|---|
| ⚙️ Architecture | The system follows a modular design pattern, where different components handle tasks such as file upload, document content extraction, vector conversion, conversational retrieval, and user interaction. The application uses the OpenAI API, FAISS, and various utilities for these tasks. It also incorporates a web interface with Streamlit. |
| 📖 Documentation | The codebase provides clear and comprehensive documentation, explaining the purpose and usage of each component and function. It includes informative comments throughout the code to aid comprehension and maintainability. |
| 🔗 Dependencies | The system relies on external libraries such as OpenAI, FAISS, and Streamlit for key functionalities. These dependencies are clearly listed in the project's requirements.txt file, making project setup and replication easier. |
| 🧩 Modularity | The codebase is well organized into smaller, interchangeable components. Each component handles a specific task, promoting code reuse, maintainability, and ease of testing. The modular approach also allows for easy extension and customization. |
| ⚡️ Performance | The system performance is subject to external factors such as API responses and document sizes. However, the codebase optimizes where possible, utilizing FAISS for efficient similarity search and vector retrieval. |
| 🔀 Version Control | The project is managed through Git version control, as evident from the GitHub repository. This enables collaborative development, branch management, and issue tracking. Proper commit history and commenting facilitate code reviews and easy troubleshooting. |
| 🔌 Integrations | The system leverages multiple integrations, primarily with the OpenAI API for conversational interfaces and FAISS for similarity search. Streamlit is used to provide a web interface to users, and further integrations with additional services could be implemented for enhanced functionality. |
Root
| File | Summary |
|---|---|
| app.py | ChatPDF is a Streamlit application that allows users to upload PDF and DOCX files and ask questions about the content. It uses OpenAI API for conversational interactions, FAISS for fast similarity search, and various utilities for parsing and handling documents. It supports functions like parsing DOCX files, extracting textual content from PDFs and DOCX files, splitting text into manageable chunks, generating vectors from chunks using OpenAI embeddings and FAISS, and creating a ConversationalRetrievalChain instance for processing user queries. The main function handles file uploads, user input, and displays bot responses in a Streamlit interface. |
Before you begin, ensure that you have the following prerequisites installed:
pip install streamlitpip install langchainpip install openaipip install faiss-cpupip install python-docxpip install PyPDF2
- Clone the ChatPDF repository:
git clone https://github.com/rahul2002m/ChatPDF- Change to the project directory:
cd ChatPDF- Install the dependencies:
pip install -r requirements.txtstreamlit run app.pyContributions are always welcome! Please follow these steps:
- Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
- Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
- Create a new branch with a descriptive name (e.g.,
new-feature-branchorbugfix-issue-123).
git checkout -b new-feature-branch- Make changes to the project's codebase.
- Commit your changes to your local branch with a clear commit message that explains the changes you've made.
git commit -m 'Implemented new feature.'- Push your changes to your forked repository on GitHub using the following command
git push origin new-feature-branch- Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.