Wiki › API-Katalog › system

system

9 Funktionen in dieser Kategorie.

system.ping GET /api/admin/chat/ping

Prüft ob der Admin-Chat-Service antwortet

Hilfe

Einfacher Health-Check. Gibt 'pong' zurück.

Beispiel-Prompts

  • Ping
  • Bist du da?
raw_response: Ja
system.health Chat-only

Vollständiger Systemstatus (Degradation-Mode)

Hilfe

Zeigt den Gesundheitszustand aller Subsysteme: DB, Qdrant, Ollama, Embeddings. Gibt auch den Degradation-Modus an.

Beispiel-Prompts

  • Wie gesund ist das System?
  • Systemstatus prüfen
  • Health-Check
raw_response: Nein
Chat-only (kein HTTP-Mapping)
system.health_ready Chat-only

Readiness-Probe (alle Subsysteme bereit?)

Hilfe

Prüft ob alle kritischen Subsysteme bereit sind. Wird von Orchestrierern wie Kubernetes genutzt.

Beispiel-Prompts

  • Ist das System bereit?
  • Readiness prüfen
raw_response: Nein
Chat-only (kein HTTP-Mapping)
system.health_live Chat-only

Liveness-Probe (Service läuft?)

Hilfe

Einfacher Check ob der Service-Prozess noch antwortet.

Beispiel-Prompts

  • Lebt der Service?
  • Liveness prüfen
raw_response: Nein
Chat-only (kein HTTP-Mapping)
system.changelog GET /api/admin/system/changelog

Config-Changelog (paginiert)

Hilfe

Zeigt die Änderungshistorie aller Konfigurationsänderungen. Filterbar nach Bereich, paginiert und sortierbar.

Parameter

Name Typ Required Default Beschreibung
page integer Nein — Seite (Default: 1)
page_size integer Nein — Einträge pro Seite (Default: 50, max: 200)
area string Nein — Filter nach Bereich
source string Nein — Filter nach Quelle (gui, chat)
sort_field string Nein — Sortierfeld (Default: created_at)
sort_dir string Nein — Sortierrichtung: asc/desc (Default: desc)

Beispiel-Prompts

  • Zeig mir das Changelog
  • Letzte Konfigurationsänderungen
  • Changelog für datasources
raw_response: Ja
system.changelog_areas GET /api/admin/system/changelog/areas

Verfügbare Changelog-Bereiche

Hilfe

Listet alle vorhandenen Bereiche im Config-Changelog auf (z.B. datasources, ki, users). Nützlich für Filter-Dropdowns.

Beispiel-Prompts

  • Welche Changelog-Bereiche gibt es?
  • Changelog-Kategorien
raw_response: Ja
system.settings.read GET /api/admin/settings

Zentrale Konfiguration laden

Hilfe

Liest die aktuelle kiara.yaml-Konfiguration und gibt sie als strukturiertes Objekt zurück.

Beispiel-Prompts

  • Zeig mir die Konfiguration
  • Welche Einstellungen sind aktiv?
  • Was steht in der kiara.yaml?
raw_response: Ja
system.settings.update POST /api/admin/settings

Zentrale Konfiguration speichern

Hilfe

Ändert die zentrale Konfigurationsdatei /etc/kiara/kiara.yaml. Manche Änderungen erfordern einen Service-Neustart.

Parameter

Name Typ Required Default Beschreibung
config object Ja — Vollständiges Konfigurations-Objekt

Beispiel-Prompts

  • Ändere die Konfiguration
  • Setze den Ollama-URL auf http://10.0.12.16:11434

Confirmation

Diese Funktion erfordert eine Bestaetigung. Template: konfiguration speichern

Changelog

Area: settings | Action: update

raw_response: Ja
system.vectordb.test POST /api/admin/vectordb/test-connection

VektorDB-Verbindungstest

Hilfe

Testet die Verbindung zur Vektor-Datenbank (Qdrant). Prüft Erreichbarkeit und listet vorhandene Collections.

Parameter

Name Typ Required Default Beschreibung
backend string Nein qdrant VektorDB-Backend (aktuell nur 'qdrant')
path string Nein Pfad (für lokale Backends)
qdrant_url string Nein Qdrant-URL (z.B. http://localhost:6333)
qdrant_api_key string Nein Qdrant API-Key (optional)
vector_size integer Nein — Vektordimension

Beispiel-Prompts

  • Teste die VektorDB-Verbindung
  • Ist Qdrant erreichbar?
  • Prüfe die Qdrant-Verbindung auf localhost:6333
raw_response: Ja