parzivAI

ParzivAI: KI-basierter Assistent für Mittelalterliche Geschichte und Mittelhochdeutsche Sprache

License: MIT GitHub Workflow Status codecov Quality Gate Status Language Open In Colab

Dieses Projekt befindet sich aktuell unter aktiver Entwicklung!

ParzivAI ist ein interaktiver Chatbot, der entwickelt wurde, um Fragen zur mittelalterlichen Geschichte und zur mittelhochdeutschen Sprache und Literatur zu beantworten. Neben der Chat-Funktion bietet ParzivAI linguistische Analysetools, eine Bildersuchfunktion und ein interaktives Quiz zu historischen Themen.

Installationsanweisungen

Stelle sicher, dass Python 3.8 oder höher installiert ist. Es ist empfohlen, conda Umgebungen zu nutzen. In deiner conda (oder anderer Python) Umgebung, installiere parzivAI vom GitHub Repository:

pip install pip install git+https://github.com/ssciwr/parzivAI

parzivAI nutzt spaCy für die Textverarbeitung. Lade die benötigten spaCy Modelle herunter mit

python -m spacy download de_core_news_sm

Für Mittelhochdeutsch muss ein speziell trainiertes Modell geladen und der Pfad in den Code integriert werden.

Playwright Setup

Wenn Du die Playwright-Bibliothek für die Bildersuche verwendest, führe diesen Befehl aus:

playwright install

Verwendung

Starte die Anwendung mit dem folgenden Befehl:

streamlit run app.py

Öffne Deinen Browser und navigiere zu http://localhost:8501.

API-Schlüssel

Stelle sicher, dass Dein Tavily API-Schlüssel als Umgebungsvariable gesetzt ist:

export TAVILY_API_KEY='your_api_key_here'

Projektstruktur

ParzivAI/
│
├── parzivai/main.py           # Hauptanwendung für Streamlit
├── pyproject.toml             # Installationsdatei und Abhängigkeiten
├── requirements-dev.txt       # Entwickler-Abhängigkeiten
├── README.md                  # Übersicht
├── example_notebooks/         # Verwendungsbeispiele
├── docs/                      # Dokumentation

Lizenz

Dieses Projekt steht unter der MIT-Lizenz. Siehe die LICENSE-Datei für weitere Details.