paperless-gpt

paperless-gpt is a tool designed to generate accurate and meaningful document titles for paperless-ngx using Large Language Models (LLMs). It supports multiple LLM providers, including OpenAI and Ollama. With paperless-gpt, you can streamline your document management by automatically suggesting appropriate titles based on the content of your scanned documents.

Features

Multiple LLM Support: Choose between OpenAI and Ollama for generating document titles.
Easy Integration: Works seamlessly with your existing paperless-ngx setup.
User-Friendly Interface: Intuitive web interface for reviewing and applying suggested titles.
Dockerized Deployment: Simple setup using Docker and Docker Compose.

paperless-gpt

Getting Started

Prerequisites

Docker installed on your system.
A running instance of paperless-ngx.
Access to an LLM provider:
- OpenAI: An API key with access to models like gpt-4o or gpt-3.5-turbo.
- Ollama: A running Ollama server with models like llama2 installed.

Installation

Docker Compose

The easiest way to get started is by using Docker Compose. Below is an example docker-compose.yml file to set up paperless-gpt alongside paperless-ngx.

version: '3.7'
services:
  paperless-ngx:
    image: ghcr.io/paperless-ngx/paperless-ngx:latest
    # ... (your existing paperless-ngx configuration)

  paperless-gpt:
    image: icereed/paperless-gpt:latest
    environment:
      PAPERLESS_BASE_URL: 'http://paperless-ngx:8000'
      PAPERLESS_API_TOKEN: 'your_paperless_api_token'
      LLM_PROVIDER: 'openai' # or 'ollama'
      LLM_MODEL: 'gpt-4'     # or 'llama2'
      OPENAI_API_KEY: 'your_openai_api_key' # Required if using OpenAI
      LLM_LANGUAGE: 'English' # Optional, default is 'English'
    ports:
      - '8080:8080'
    depends_on:
      - paperless-ngx

Note: Replace the placeholder values with your actual configuration.

Manual Setup

If you prefer to run the application manually:

Clone the Repository:

git clone https://github.com/yourusername/paperless-gpt.git
cd paperless-gpt

Build the Docker Image:
```
docker build -t paperless-gpt .
```

Run the Container:

docker run -d \
  -e PAPERLESS_BASE_URL='http://your_paperless_ngx_url' \
  -e PAPERLESS_API_TOKEN='your_paperless_api_token' \
  -e LLM_PROVIDER='openai' \
  -e LLM_MODEL='gpt-4' \
  -e OPENAI_API_KEY='your_openai_api_key' \
  -e LLM_LANGUAGE='English' \
  -p 8080:8080 \
  paperless-gpt

Configuration

Environment Variables

Variable	Description	Required
`PAPERLESS_BASE_URL`	The base URL of your paperless-ngx instance (e.g., `http://paperless-ngx:8000`).	Yes
`PAPERLESS_API_TOKEN`	API token for accessing paperless-ngx. You can generate one in the paperless-ngx admin interface.	Yes
`LLM_PROVIDER`	The LLM provider to use (`openai` or `ollama`).	Yes
`LLM_MODEL`	The model name to use (e.g., `gpt-4`, `gpt-3.5-turbo`, `llama2`).	Yes
`OPENAI_API_KEY`	Your OpenAI API key. Required if using OpenAI as the LLM provider.	Cond.
`LLM_LANGUAGE`	The likely language of your documents (e.g., `English`, `German`). Default is `English`.	No

Note: When using Ollama, ensure that the Ollama server is running and accessible from the paperless-gpt container.

Usage

Tag Documents in paperless-ngx:
- Add the tag paperless-gpt to documents you want to process. This tag is configurable via the tagToFilter variable in the code (default is paperless-gpt).
Access the paperless-gpt Interface:
- Open your browser and navigate to http://localhost:8080.
Process Documents:
- Click on "Generate Suggestions" to let the LLM generate title suggestions based on the document content.
Review and Apply Titles:
- Review the suggested titles. You can edit them if necessary.
- Click on "Apply Suggestions" to update the document titles in paperless-ngx.

Contributing

Contributions are welcome! Please read the contributing guidelines before submitting a pull request.

Fork the Repository
Create a Feature Branch
```
git checkout -b feature/my-new-feature
```
Commit Your Changes
```
git commit -am 'Add some feature'
```
Push to the Branch
```
git push origin feature/my-new-feature
```
Create a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Disclaimer: This project is not affiliated with the official paperless-ngx project. Use at your own discretion.

6 KiB Raw Blame History