Skip to content

3. Functions

Your friendly nerd edited this page Feb 8, 2025 · 3 revisions

Dashboard

  • Provides an overview of document processing status
  • Displays recent document activity

Manual Processing

  • Allows users to manually select and analyze specific documents

AI Chat

  • Enables interactive document queries using AI
  • Accessible via "/chat"

Playground

  • Testing environment for document analysis workflows
  • Accessible via "/playground"

History

  • Displays previously analyzed documents and their metadata
  • Accessible via "/history"

Settings

  • Configures API keys and model preferences
  • Accessible via "/settings"

Configuration Functions (Extracted from Settings Page)

Connection Settings

  • Configure Paperless-ngx API URL, API Token, and Username.
  • Validate the connection to Paperless-ngx.

AI Configuration

  • Choose between OpenAI API, Ollama, or a Custom AI Provider.
  • Configure API keys and select AI models (GPT-4o, Ollama, custom models).

Advanced Settings

  • Enable or disable using existing Correspondents and Tags from Paperless-ngx.
  • Define scan intervals for automatic document analysis.
  • Choose to process only predefined tagged documents.

AI Processing Options

  • Enable/disable specific AI functions:
    • Tag Assignment
    • Correspondent Detection
    • Document Type Classification
    • Title Generation
    • Custom Fields Processing
  • Option to disable automatic processing, allowing only manual scans.

Custom Fields

  • Add and manage custom fields for documents.
  • Supported data types: Text, Number, Integer, Currency.

System Prompt & AI Tags

  • Define specific tags for AI prompts.
  • Configure an AI-processed tag to mark analyzed documents.

Available Debug Endpoints

Endpoint Description
/debug/tags Lists all tags in the system
/debug/documents Shows processed document information
/debug/correspondents Displays correspondent data