## Overview Adds **AI document classification** and a **classification-aware Files sidebar**: uploaded documents are automatically tagged with document-type labels (Invoice, Contract, Lab report, …), and the sidebar groups files under editable parent categories so a large library stays navigable. > [!IMPORTANT] > **This feature only runs in the SaaS build.** Classification depends on the AI engine and team-scoped label storage, so it's gated to SaaS end-to-end: > - The sidebar grouping is a `saas/`-layer override of the `fileSidebarGrouping` seam; every other build (OSS core, self-hosted proprietary, desktop) gets the null stub and renders the **unchanged flat, recency-sorted list** — no categories, no "Other", no picker. > - The classify/labels backend endpoints are gated on `policies.enabled` (on in SaaS) and live in `app/proprietary`, so they're absent from pure OSS and dormant in self-hosted unless explicitly enabled. > - The Python classifier is reached only via that gated path. > > Shared-layer changes that do compile everywhere are inert without the engine (dormant schema/field additions) or intentional (`GetInfoOnPDF` surfacing custom metadata). ## What it does - **Classifier (engine):** reads the first/last two pages of a PDF and assigns document-type labels from an allowed vocabulary. Labels are deliberately document-*type* descriptors — no deep-content/PII detection, since only a page window is read. - **Team label vocabulary:** ~270 built-in defaults across ~15 families, seeded per team. Editable by team leaders/admins in the Classification policy settings (import/export/reset). Team-scoped and shared; **per-user personal labels are intentionally out of scope** — the vocabulary is team-level only. - **Sidebar categories:** files group under parent categories (Financial, Legal, Medical, …), busiest-first, collapsible, with a "Recent" group on top and an "Other" group for anything uncategorised. The category structure (names, icons, membership, custom categories) is **device-local and user-editable** via a "Customize" picker — the only per-user personalization; it never changes the team's label vocabulary. - Classification results are written to PDF metadata (`StirlingPDFClassification`), read back to keep files in their groups without re-parsing. ## Architecture Spans all three layers, mirroring the existing policy/source subsystem conventions: - **`frontend/editor`** — sidebar grouping seam + SaaS override, category manager, labels editor, icon palette, file grouping, tests, `en-US` i18n. - **`app/proprietary` + `app/common` + `app/core`** — `ClassifyLabelController`, team-scoped `ClassificationLabelStore` (Jpa + in-process impls, same shape as `PolicyStore`/`SourceStore`), metadata read/write. - **`engine`** — the document-classifier agent, contracts, routes, tests. ## Screenshots **Files sidebar — grouped by category (SaaS)** ### Loading view <img width="2056" height="1046" alt="Screenshot 2026-07-07 at 5 12 56 PM" src="https://github.com/user-attachments/assets/1d712da5-50ae-4349-b0cd-e62665c3ec0c" /> ### Organized in the sidebar <img width="2056" height="1045" alt="Screenshot 2026-07-07 at 5 14 05 PM" src="https://github.com/user-attachments/assets/3ea4fe21-da51-4cea-bc3a-18ce040d3d05" /> **Customize categories picker** ### Personal settings to change how labels are grouped in an individual users editor <img width="2056" height="1044" alt="Screenshot 2026-07-07 at 5 52 42 PM" src="https://github.com/user-attachments/assets/40be03ce-0f63-4d1e-b58b-cec045d01cb2" /> **Classification labels editor (team settings)** <img width="2056" height="1042" alt="Screenshot 2026-07-07 at 5 53 00 PM" src="https://github.com/user-attachments/assets/337b0739-15c9-4749-9c6b-22e3b20825b8" /> ## Testing - Frontend `task frontend:check` — green (editor + portal tests, typecheck across all flavors, lint, label-drift guard). - Backend `task backend:check` (proprietary) and `:saas:test` — green. - Engine `task engine:check` — green.
147 lines
5.5 KiB
Python
147 lines
5.5 KiB
Python
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import logging
|
|
from contextlib import asynccontextmanager
|
|
from typing import Annotated
|
|
|
|
from fastapi import Depends, FastAPI
|
|
from pydantic_ai import Agent
|
|
from pydantic_ai.models.instrumented import InstrumentationSettings
|
|
|
|
from stirling.agents import (
|
|
DocumentClassifierAgent,
|
|
ExecutionPlanningAgent,
|
|
OrchestratorAgent,
|
|
PdfEditAgent,
|
|
PdfQuestionAgent,
|
|
UserSpecAgent,
|
|
)
|
|
from stirling.agents.ledger import MathAuditorAgent
|
|
from stirling.agents.pdf_comment import PdfCommentAgent
|
|
from stirling.api.dependencies import enforce_required_user_id
|
|
from stirling.api.engine_auth import EngineSharedSecretMiddleware
|
|
from stirling.api.middleware import UserIdMiddleware
|
|
from stirling.api.routes import (
|
|
agent_capabilities_router,
|
|
agent_draft_router,
|
|
document_classifier_router,
|
|
document_router,
|
|
execution_router,
|
|
ledger_router,
|
|
orchestrator_router,
|
|
pdf_comments_router,
|
|
pdf_edit_router,
|
|
pdf_question_router,
|
|
)
|
|
from stirling.config import AppSettings, load_settings
|
|
from stirling.contracts import HealthResponse
|
|
from stirling.documents import DocumentService
|
|
from stirling.services import build_runtime, setup_posthog_tracking
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
async def _run_expired_doc_reaper(
|
|
documents: DocumentService,
|
|
interval_seconds: int,
|
|
) -> None:
|
|
"""Periodically delete documents whose ``expires_at`` has passed.
|
|
|
|
A reaped collection drops everything rooted at that document. Backstop
|
|
for the explicit logout purge: catches sessions that ended without a
|
|
clean logout (tab close, JWT expiry, engine restart). Persistent rows
|
|
(``expires_at`` null, the shape we use for org-shared docs) are never
|
|
touched. Runs until cancelled by the lifespan teardown.
|
|
"""
|
|
await _reap(documents)
|
|
while True:
|
|
await asyncio.sleep(interval_seconds)
|
|
await _reap(documents)
|
|
|
|
|
|
async def _reap(documents: DocumentService) -> None:
|
|
"""One reaper iteration. Logs the deleted count on success and the full
|
|
exception with traceback on failure; never re-raises non-cancel errors so
|
|
a bad iteration doesn't kill the loop. ``asyncio.CancelledError`` is
|
|
re-raised so the lifespan teardown can cancel the task cleanly.
|
|
"""
|
|
try:
|
|
deleted = await documents.reap_expired()
|
|
if deleted:
|
|
logger.info("Reaped %d expired document collection(s)", deleted)
|
|
except asyncio.CancelledError:
|
|
raise
|
|
except Exception:
|
|
logger.exception("Document reaper iteration failed; will retry on next interval")
|
|
|
|
|
|
def _load_startup_settings(fast_api: FastAPI) -> AppSettings:
|
|
override = fast_api.dependency_overrides.get(load_settings)
|
|
if override is not None:
|
|
return override()
|
|
return load_settings()
|
|
|
|
|
|
@asynccontextmanager
|
|
async def lifespan(fast_api: FastAPI):
|
|
# Load env vars on startup so we can immediately crash if required env vars aren't set
|
|
settings = _load_startup_settings(fast_api)
|
|
runtime = build_runtime(settings)
|
|
fast_api.state.settings = settings
|
|
fast_api.state.runtime = runtime
|
|
fast_api.state.orchestrator_agent = OrchestratorAgent(runtime)
|
|
fast_api.state.pdf_edit_agent = PdfEditAgent(runtime)
|
|
fast_api.state.pdf_question_agent = PdfQuestionAgent(runtime)
|
|
fast_api.state.user_spec_agent = UserSpecAgent(runtime)
|
|
fast_api.state.execution_planning_agent = ExecutionPlanningAgent(runtime)
|
|
fast_api.state.math_auditor_agent = MathAuditorAgent(runtime)
|
|
fast_api.state.pdf_comment_agent = PdfCommentAgent(runtime)
|
|
fast_api.state.document_classifier_agent = DocumentClassifierAgent(runtime)
|
|
tracer_provider = setup_posthog_tracking(settings)
|
|
if tracer_provider:
|
|
Agent.instrument_all(InstrumentationSettings(tracer_provider=tracer_provider))
|
|
reaper_task = asyncio.create_task(
|
|
_run_expired_doc_reaper(
|
|
runtime.documents,
|
|
interval_seconds=settings.documents_reaper_interval_seconds,
|
|
),
|
|
name="expired-document-reaper",
|
|
)
|
|
yield
|
|
reaper_task.cancel()
|
|
try:
|
|
await reaper_task
|
|
except asyncio.CancelledError:
|
|
pass
|
|
await runtime.documents.close()
|
|
if tracer_provider:
|
|
tracer_provider.shutdown()
|
|
|
|
|
|
app = FastAPI(title="Stirling AI Engine", lifespan=lifespan, version="0.1.0")
|
|
app.add_middleware(UserIdMiddleware)
|
|
app.add_middleware(EngineSharedSecretMiddleware)
|
|
# Every router gets the same configurable identity gate; /health stays open
|
|
# for liveness probes. See enforce_required_user_id for the policy.
|
|
_user_gate = [Depends(enforce_required_user_id)]
|
|
app.include_router(orchestrator_router, dependencies=_user_gate)
|
|
app.include_router(pdf_edit_router, dependencies=_user_gate)
|
|
app.include_router(pdf_question_router, dependencies=_user_gate)
|
|
app.include_router(agent_draft_router, dependencies=_user_gate)
|
|
app.include_router(execution_router, dependencies=_user_gate)
|
|
app.include_router(document_router, dependencies=_user_gate)
|
|
app.include_router(ledger_router, dependencies=_user_gate)
|
|
app.include_router(pdf_comments_router, dependencies=_user_gate)
|
|
app.include_router(agent_capabilities_router, dependencies=_user_gate)
|
|
app.include_router(document_classifier_router, dependencies=_user_gate)
|
|
|
|
|
|
@app.get("/health", response_model=HealthResponse)
|
|
async def healthcheck(settings: Annotated[AppSettings, Depends(load_settings)]) -> HealthResponse:
|
|
return HealthResponse(
|
|
status="ok",
|
|
smart_model=settings.smart_model_name,
|
|
fast_model=settings.fast_model_name,
|
|
)
|