freescoutAI/README.md

# FreeScoutAI Modul - Dokumentation

## Übersicht
FreeScoutAI ist ein Modul für das E-Mail-Ticket-System FreeScout, das KI-Funktionen zur Verbesserung des E-Mail-Managements bietet. Das Modul ermöglicht die automatische Priorisierung von E-Mails, generiert Antwortvorschläge, bietet Textmodifikationen und erstellt Zusammenfassungen von Konversationen.

## Funktionen
- **E-Mail-Priorisierung**: Automatische Kategorisierung eingehender E-Mails in Prioritäten A, B und C basierend auf Inhalt und Kundendaten
- **Antwortvorschläge**: Generierung kontextbezogener Antwortvorschläge für eingehende E-Mails
- **Textmodifikationen**: Funktionen zum Kürzen, Erweitern, förmlicher oder persönlicher Gestalten von Texten
- **Textzusammenfassung**: Erstellung prägnanter Zusammenfassungen von E-Mail-Konversationen
- **Anpassbare Prompts**: Möglichkeit, die KI-Prompts für alle Funktionen individuell anzupassen

## KI-Provider
Das Modul unterstützt verschiedene KI-Provider:
- **Ollama**: Lokale KI-Verarbeitung ohne Datenaustausch mit externen Diensten
- **OpenAI**: Integration mit GPT-Modellen (erfordert API-Schlüssel)
- **Anthropic**: Integration mit Claude-Modellen (erfordert API-Schlüssel)
- **Mistral**: Integration mit Mistral-Modellen (erfordert API-Schlüssel)
- **OpenRouter**: Integration mit verschiedenen Modellen über einen einheitlichen Zugang (erfordert API-Schlüssel)

## Installation

### Voraussetzungen
- FreeScout 1.8 oder höher
- PHP 7.4 oder höher
- Für lokale KI: Ollama-Installation

### Installationsschritte
1. Laden Sie das Modul herunter und entpacken Sie es in das Verzeichnis `/Modules` Ihrer FreeScout-Installation
2. Navigieren Sie in der FreeScout-Administration zu "Modules"
3. Aktivieren Sie das Modul "FreeScoutAI"
4. Die Datenbanktabellen werden automatisch erstellt

## Konfiguration

### Allgemeine Einstellungen
1. Navigieren Sie zu "Mailboxes" > [Ihre Mailbox] > "FreeScoutAI"
2. Aktivieren Sie das Modul mit dem Schalter "Modul aktivieren"
3. Wählen Sie den gewünschten KI-Provider aus dem Dropdown-Menü

### Provider-Konfiguration
- **Ollama**: Geben Sie die URL Ihres Ollama-Servers ein (Standard: http://localhost:11434)
- **OpenAI, Anthropic, Mistral, OpenRouter**: Geben Sie Ihren API-Schlüssel ein

### Modellauswahl
Nach Eingabe der Provider-Informationen werden verfügbare Modelle automatisch geladen. Wählen Sie das gewünschte Modell aus dem Dropdown-Menü.

### Datenschutzhinweis
Bei Verwendung von Online-KI-Diensten (OpenAI, Anthropic, Mistral, OpenRouter) müssen Sie den Datenschutzhinweis bestätigen, der Sie daran erinnert, in Ihrer Datenschutzerklärung auf die Nutzung von Online-KI hinzuweisen.

### Funktionsaktivierung
Aktivieren oder deaktivieren Sie einzelne Funktionen nach Bedarf:
- E-Mail-Priorisierung
- Antwortvorschläge
- Textmodifikationen
- Textzusammenfassung

### Anpassbare Prompts
1. Wechseln Sie zum Tab "Prompts" in den FreeScoutAI-Einstellungen
2. Passen Sie die Prompts für die verschiedenen Funktionen nach Ihren Wünschen an:
   - Priorisierungs-Prompt
   - Antwortvorschlags-Prompt
   - Textmodifikations-Prompts (Kürzen, Erweitern, Förmlicher, Persönlicher)
   - Zusammenfassungs-Prompt
3. Verwenden Sie die "Auf Standard zurücksetzen"-Funktion, um zu den Standardprompts zurückzukehren

## Verwendung

### E-Mail-Priorisierung
Die Priorisierung erfolgt automatisch für neue eingehende E-Mails. Die Priorität (A, B oder C) wird in der Konversationsübersicht neben der Konversationsnummer angezeigt.

### Antwortvorschläge
1. Öffnen Sie eine Konversation
2. Klicken Sie im Thread-Menü auf "Antwort generieren (KI)"
3. Ein Antwortvorschlag wird generiert und angezeigt
4. Klicken Sie auf "Vorschlag übernehmen", um den Vorschlag in das Antwortfeld zu übernehmen

### Textmodifikationen
1. Geben Sie Text in das Antwortfeld ein oder wählen Sie einen Teil des Textes aus
2. Klicken Sie auf "Text modifizieren (KI)" und wählen Sie eine der Optionen:
   - Text kürzen
   - Text erweitern
   - Förmlicher gestalten
   - Persönlicher gestalten
3. Der modifizierte Text ersetzt den ausgewählten Text oder den gesamten Inhalt des Antwortfelds

### Textzusammenfassung
1. Öffnen Sie eine Konversation
2. Klicken Sie im Thread-Menü auf "Konversation zusammenfassen (KI)"
3. Ein Modal-Dialog zeigt die generierte Zusammenfassung an
4. Klicken Sie auf "Kopieren", um die Zusammenfassung in die Zwischenablage zu kopieren

## Fehlerbehebung

### API-Verbindungsprobleme
- Überprüfen Sie, ob der API-Schlüssel korrekt eingegeben wurde
- Stellen Sie sicher, dass der API-Dienst verfügbar ist
- Bei Ollama: Überprüfen Sie, ob der Ollama-Server läuft und erreichbar ist

### Leistungsprobleme
- Verwenden Sie schnellere Modelle für bessere Reaktionszeiten
- Bei lokaler Nutzung: Stellen Sie sicher, dass ausreichend Systemressourcen verfügbar sind

### Fehler bei der Modellauswahl
- Aktualisieren Sie die Seite und versuchen Sie erneut, die Modelle zu laden
- Überprüfen Sie, ob der API-Schlüssel die erforderlichen Berechtigungen hat

## Datenschutz
- Bei Verwendung lokaler Modelle (Ollama) werden keine Daten an externe Dienste gesendet
- Bei Verwendung von Online-Diensten werden E-Mail-Inhalte an die entsprechenden API-Dienste übermittelt
- Stellen Sie sicher, dass Ihre Datenschutzerklärung die Nutzung von KI-Diensten angemessen dokumentiert

## Technische Details
- Das Modul verwendet die Laravel-Struktur von FreeScout
- Die KI-Funktionalität ist modular aufgebaut und kann leicht erweitert werden
- Alle API-Anfragen werden über sichere HTTPS-Verbindungen durchgeführt
- API-Schlüssel werden verschlüsselt in der Datenbank gespeichert
- Anpassbare Prompts werden global für alle Mailboxen gespeichert