Verlaufs-API

Endpoints zum Zugriff auf den Konvertierungsverlauf.

Konvertierungsverlauf abrufen

GET /api/history

Abfrageparameter

Name	Typ	Standard	Beschreibung
`limit`	int	50	Maximale Anzahl zurückzugebender Einträge
`offset`	int	0	Anzahl zu überspringender Einträge
`status`	string	-	Nach Status filtern

Antwort

{
  "entries": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "filename": "document_abc123.pdf",
      "original_filename": "My Document.pdf",
      "input_format": "pdf",
      "status": "completed",
      "confidence": 0.92,
      "file_size": 1048576,
      "created_at": "2024-01-15T10:00:00Z",
      "completed_at": "2024-01-15T10:00:30Z"
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

Kürzlichen Verlauf abrufen

GET /api/history/recent

Abfrageparameter

Name	Typ	Standard	Beschreibung
`limit`	int	10	Maximale Anzahl zurückzugebender Einträge

Verlaufseintrag abrufen

GET /api/history/{job_id}

Antwort

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "filename": "document_abc123.pdf",
  "original_filename": "My Document.pdf",
  "input_format": "pdf",
  "status": "completed",
  "confidence": 0.92,
  "error_message": null,
  "output_path": "/outputs/550e8400.../document.md",
  "document_json_path": "/outputs/550e8400.../document.json",
  "settings": {
    "ocr": {"enabled": true}
  },
  "file_size": 1048576,
  "created_at": "2024-01-15T10:00:00Z",
  "completed_at": "2024-01-15T10:00:30Z"
}

Dokument aus dem Verlauf laden

GET /api/history/{job_id}/load

Lädt ein zuvor konvertiertes Dokument aus dem Verlauf und gibt es als Konvertierungsergebnis zurück. Dieser Endpunkt lädt das DoclingDocument aus der gespeicherten JSON-Datei und gibt es im gleichen Format wie ein frisches Konvertierungsergebnis zurück.

Pfadparameter

Name	Typ	Erforderlich	Beschreibung
`job_id`	string	Ja	Die Job-Kennung (muss `[A-Za-z0-9_-]+` entsprechen)

Antwort

Gibt ein ConversionResult-Objekt zurück, das dem Format einer frischen Konvertierung entspricht:

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "document": {
    "title": "Mein Dokument",
    "content": "...",
    "metadata": {...}
  },
  "formats_available": ["markdown", "html", "json"],
  "images_count": 5,
  "tables_count": 2,
  "preview": "# Dokumentinhalt-Vorschau..."
}

Fehlerantworten

404 Not Found: Verlaufseintrag existiert nicht

{
  "error": "History entry {job_id} not found"
}

400 Bad Request: Konvertierung nicht abgeschlossen

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "pending",
  "message": "Conversion not completed"
}

Hinweise

Funktioniert nur für abgeschlossene Konvertierungen
Wenn die gespeicherte Dokument-JSON-Datei nicht verfügbar ist, versucht der Endpunkt, das Ergebnis aus den Ausgabedateien zu rekonstruieren
Dokumente werden automatisch nach jeder erfolgreichen Konvertierung gespeichert
Das Feld document_json_path in Verlaufseinträgen gibt an, wo das Dokument-JSON gespeichert ist

Verlauf von Datenträger abgleichen

POST /api/history/reconcile

Durchsucht das Ausgabeverzeichnis nach Konvertierungen, die auf dem Datenträger existieren, aber keinen Datenbankeintrag haben (z. B. nach DB-Verlust oder -Neustart). Erstellt fehlende Verlaufseinträge, damit sie in der Oberfläche erscheinen und neu geladen werden können.

Die Abgleichung erfolgt außerdem automatisch beim Anwendungsstart.

Antwort

{
  "message": "Reconciled 3 entries from disk",
  "added_count": 3,
  "added_ids": [
    "550e8400-e29b-41d4-a716-446655440000",
    "660e8400-e29b-41d4-a716-446655440001",
    "770e8400-e29b-41d4-a716-446655440002"
  ]
}

Hinweise

Nur Ausgabeverzeichnisse mit gültigen UUID-Namen und mindestens einer Ausgabedatei (.md, .html, .json oder .document.json) werden abgeglichen
Bereits vorhandene Einträge werden übersprungen

Verlaufseintrag löschen

DELETE /api/history/{job_id}

Antwort

{
  "message": "Entry deleted",
  "job_id": "550e8400-e29b-41d4-a716-446655440000"
}

Verlaufsstatistiken abrufen

GET /api/history/stats

Antwort

{
  "total": 150,
  "completed": 142,
  "failed": 5,
  "pending": 2,
  "processing": 1,
  "success_rate": 94.7,
  "format_breakdown": {
    "pdf": 100,
    "docx": 30,
    "image": 20
  }
}

Verlauf durchsuchen

GET /api/history/search

Abfrageparameter

Name	Typ	Erforderlich	Beschreibung
`q`	string	Ja	Suchanfrage
`limit`	int	Nein	Maximale Ergebnisse (Standard: 20)

Antwort

{
  "entries": [...],
  "query": "invoice",
  "count": 5
}

Verlauf exportieren

GET /api/history/export

Antwort: JSON-Datei-Download mit allen Verlaufseinträgen

Gesamten Verlauf löschen

DELETE /api/history

Antwort

{
  "message": "All history entries deleted",
  "count": 150
}