Skip to content

A friendly AI for navigating documents and contracts.

Notifications You must be signed in to change notification settings

sd8capricon/paperpal

Repository files navigation

PaperPal: AI-Powered Contract Navigator

PaperPal is a web application designed to help users navigate, review, and analyze PDF documents such as contracts using AI. The app uses retrieval-augmented generation (RAG) for question-answering tasks, leveraging Langchain, FAISS, and Google Generative AI to provide detailed insights from uploaded PDFs.

Conversational RAG

Features

  • Upload and analyze multiple PDF contracts
  • AI-powered question answering based on document content
  • Risk review of uploaded contracts
  • Conversation history-aware retrieval and QA

Technologies

Usage Examples

chat1

chat1

Setup

Prerequisites

Ensure you have the following installed:

  • Python
  • Streamlit (for running the web app)
  • FAISS (for vector search)

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/paperpal.git
    cd paperpal
  2. Create a virtual environment and activate it

    python3 -m venv .venv
    ource venv/bin/activate  # On Windows: venv\Scripts\activate
  3. Install required dependencies

    pip install -r requirements.txt
  4. Set up your environment variables by creating a .env file in the root directory:

    GOOGLE_API_KEY=your_google_api_key

Running the App

Once you have installed all dependencies and configured your environment:

  1. Start the streamlit app
    streamlit run app.py
  2. The app will be available at http://localhost:8501/

About

A friendly AI for navigating documents and contracts.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published