/skimmerUI

Primary LanguageTypeScript

React + TypeScript + Vite

Poetry Project: A Django-Based PDF Query System

Table of Contents

  1. Project Titles and Internal Titles
  2. Introduction
  3. Technologies Used
  4. Launch
  5. Illustrations
  6. Scope of Functions
  7. Use Examples
  8. Project Status
  9. Sources

Project Titles and Internal Titles

Introduction

The Poetry Project is a Django-based web application designed to manage user features such as logins and registrations. This system leverages Llama Index to build a robust document querying system that allows readers to upload PDF files and query them based on their content. The system utilizes an agent reasoning loop to provide both single and multi-document reading capabilities.

Technologies Used

  • Python: 3.x
  • Django: 4.x
  • Poetry: For dependency management
  • Llama Index: For document querying
  • Agentic Rags: For building the agent reasoning loop
  • Dependencies:
    • python-dotenv = "^1.0.1"
    • ipykernel = "^6.29.4"
    • llama-index = "^0.10.46"
    • nest-asyncio = "^1.6.0"
    • notebook = "^7.2.1"
    • attrs = "^23.2.0"
    • openai = "^1.34.0"

Launch

To launch the Poetry Project, follow these steps:

  1. Clone the repository: 
    git clone https://github.com/yourusername/poetry-project.git
cd poetry-project
  2. Install dependencies using Poetry: 
    poetry install
  3. Set up environment variables: 
    cp .env.example .env
  4. Run the Django server: 
    poetry run python manage.py runserver

Illustrations

  • Login Page: A simple and secure user authentication interface.
  • PDF Upload: A user-friendly form to upload PDF documents.
  • Query Interface: An intuitive interface for querying uploaded documents.

Scope of Functions

  • User Authentication: Secure login and registration features.
  • PDF Management: Upload, view, and manage PDF documents.
  • Document Querying: Use Llama Index to query documents and retrieve relevant information.
  • Agent Reasoning Loop: Provides capabilities for single and multi-document reading.

Use Examples

  • Login and Registration: Users can create an account or log in to access the system.
  • Upload PDF: Users can upload PDF documents to the system.
  • Query PDF: Users can input queries to search through their uploaded documents.

Project Status

The Poetry Project is currently in active development. Future updates will include enhanced querying capabilities, better user interface, and more robust document management features.

Sources

Frontend official plugins are available: