E-Rechnung/README.md

82 lines
2.7 KiB
Markdown

# README
## Description
Dieses Tool konvertiert Rechnungen im PDF-Format vollautomatisch in das offizielle XRechnung-XML-Format (UBL-Standard, Version 3.0). Das Tool verarbeitet sensible Finanzdaten vollständig lokal.
## Supported Model
Das System ist auf das folgende Modell optimiert, welches sich im Verzeichnis `models/` befinden muss:
* **Modell:** Qwen3.5-4B-Instruct
* **Format:** GGUF
* **Quantisierung:** Q8_0
## Installation
### 1. Verzeichnisstruktur vorbereiten
Erstellen Sie im Projektverzeichnis den Ordner für das lokale KI-Modell:
```cmd
mkdir models
```
### 2. Virtuelle Umgebung (venv) erstellen und aktivieren
Erstellen Sie eine isolierte Python-Umgebung und aktivieren Sie diese über die Windows-Eingabeaufforderung (CMD):
```cmd
python -m venv venv
.\venv\Scripts\activate.bat
```
### 3. Modell platzieren
Laden Sie die Modelldatei `Qwen3.5-4B-Instruct-Q8_0.gguf` herunter und platzieren Sie diese im erstellten Ordner. Der Pfad muss exakt wie folgt lauten:
`models/Qwen3.5-4B-Instruct-Q8_0.gguf`
### 4. Abhängigkeiten installieren
**A: Mit GPU-Beschleunigung (Nvidia CUDA)**
Falls Sie die GPU-Beschleunigung nutzen möchten, müssen vorab folgende Komponenten auf dem System installiert sein:
* **Nvidia CUDA Toolkit**
* **Visual Studio Build Tools**
```cmd
set GGML_CUDA=1
pip install -r requirements.txt --force-reinstall --no-cache-dir
```
**B: Reiner CPU-Modus (Keine Nvidia-Grafikkarte vorhanden)**
```cmd
pip install -r requirements.txt --force-reinstall --no-cache-dir
```
## Use
Starten Sie die Applikation über die aktivierte Eingabeaufforderung:
```cmd
streamlit run app.py
```
Der Konversionsprozess gliedert sich in folgende Schritte:
1. **Dokumenten-Upload:** Laden Sie die Rechnungs-PDF über die Weboberfläche hoch.
2. **Extraktion:** Starten Sie die Analyse über den dafür vorgesehenen Button.
3. **Validierung:** Prüfen Sie die extrahierten Kopfdaten und die Positionstabelle in der Benutzeroberfläche. Da alle Felder editierbar sind, können Korrekturen direkt vorgenommen werden.
4. **Export:** Generieren Sie die finale XML-Datei über die Export-Funktion und starten Sie den Download.
## Notes
### Human-in-the-Loop
Das Tool dient als Automations-Assistent. Vor dem finalen XML-Export ist eine visuelle Endkontrolle der extrahierten Daten (insbesondere Rechnungsnummer und Empfängeradresse) durch den Sachbearbeiter zwingend erforderlich, um KI-Fehlinterpretationen auszuschließen.
### GoBD-Konformität
Das Tool generiert ausschließlich das strukturierte XML-Format. Für die Einhaltung der GoBD-Richtlinien (u. a. die revisionssichere Archivierung der Original-PDF sowie der generierten XML-Datei über den gesetzlichen Zeitraum von 10 Jahren) ist der Betreiber der Software selbst verantwortlich.