Navya-Sree's picture
Update README.md
7e963c0 verified
metadata
title: Chat With Any PDF File
emoji: πŸš€
colorFrom: red
colorTo: red
sdk: docker
app_port: 8501
tags:
  - streamlit
pinned: false
short_description: Streamlit template space

title: PDF Chat Assistant emoji: πŸ“„ colorFrom: blue colorTo: purple sdk: streamlit sdk_version: 1.28.0 app_file: app.py pinned: false license: mit

πŸ“„ PDF Chat Assistant

An intelligent PDF chat application that allows you to upload any PDF document and have natural conversations with its content using AI.

🌟 Features

  • πŸ“€ Easy PDF Upload: Drag & drop or browse to upload PDF files
  • πŸ€– AI-Powered Chat: Ask questions and get intelligent answers about your document
  • πŸ’Ύ Conversation Memory: Maintains context throughout your chat session
  • 🎨 Beautiful Interface: Modern, responsive design with dark theme
  • ⚑ Fast Processing: Quick text extraction and real-time responses
  • πŸ”’ Privacy First: Your documents are processed securely and not stored

πŸš€ How to Use

  1. πŸ”‘ Enter your OpenAI API Key in the sidebar
  2. πŸ“€ Upload a PDF file using the file uploader
  3. ⏳ Wait for text extraction (usually takes a few seconds)
  4. πŸ’¬ Start asking questions about your document
  5. 🎯 Get instant AI-powered answers!

πŸ’‘ Example Questions

  • "What is this document about?"
  • "Summarize the main points"
  • "What are the key findings?"
  • "Give me the contact information"
  • "Explain the methodology used"

πŸ”‘ API Key Setup

To use this application, you'll need an OpenAI API key:

  1. Visit OpenAI Platform
  2. Sign up or log in to your account
  3. Go to the API Keys section
  4. Click "Create new secret key"
  5. Copy the key and paste it in the sidebar

Note: Your API key is only used during your session and is never stored or shared.

πŸ› οΈ Technical Details

  • Framework: Streamlit
  • AI Model: OpenAI GPT-3.5-turbo
  • PDF Processing: PyPDF2
  • Hosting: Hugging Face Spaces

🎯 Use Cases

  • πŸ“š Research: Quickly understand academic papers and research documents
  • πŸ“‹ Business: Analyze reports, contracts, and business documents
  • πŸ“– Education: Study textbooks and educational materials
  • πŸ“„ Legal: Review legal documents and contracts
  • πŸ“Š Reports: Extract insights from data reports and presentations

πŸ”’ Privacy & Security

  • Documents are processed in real-time and not stored
  • API keys are only used for the current session
  • No data is collected or shared with third parties
  • All processing happens securely in the cloud

πŸ“± Responsive Design

The application works seamlessly on:

  • πŸ’» Desktop computers
  • πŸ“± Mobile devices
  • πŸ“Ί Tablets
  • πŸ–₯️ Large screens

🀝 Contributing

This is an open-source project. Feel free to:

  • ⭐ Star the repository
  • πŸ› Report bugs
  • πŸ’‘ Suggest features
  • πŸ”§ Submit pull requests

πŸ“ž Support

If you encounter any issues:

  1. Check that your API key is valid and has available credits
  2. Ensure your PDF contains readable text (not just images)
  3. Try with a smaller PDF file if processing fails
  4. Refresh the page and try again

πŸ† Credits

Built with ❀️ using:


πŸŽ‰ Start chatting with your PDFs today!

Transform any PDF into an interactive conversation and unlock the power of AI-assisted document analysis.

Welcome to Streamlit!

Edit /src/streamlit_app.py to customize this app to your heart's desire. :heart:

If you have any questions, checkout our documentation and community forums.