Wiki › API-Katalog › datasources

datasources

13 Funktionen in dieser Kategorie.

datasource.list GET /api/admin/datasources

Alle Datenquellen auflisten

Hilfe

Listet alle konfigurierten Datenquellen mit Status, Typ und Ingestion-Informationen auf. Liest aus der Cache-Tabelle.

Beispiel-Prompts

  • Zeig mir alle Datenquellen
  • Welche Datenquellen gibt es?
  • Liste der Datenquellen
raw_response: Ja
datasource.status GET /api/admin/datasources/{ds_id}/status

Status einer einzelnen Datenquelle

Hilfe

Zeigt Pfad, Erreichbarkeit und Dateianzahl einer Datenquelle.

Parameter

Name Typ Required Default Beschreibung
ds_id integer Ja — ID der Datenquelle

Beispiel-Prompts

  • Status von Datenquelle 1
  • Ist DS 5 erreichbar?
raw_response: Ja
datasource.groups GET /api/admin/datasources/{ds_id}/groups

Zugeordnete Gruppen einer Datenquelle

Hilfe

Zeigt welche Benutzergruppen Zugriff auf eine Datenquelle haben.

Parameter

Name Typ Required Default Beschreibung
ds_id integer Ja — ID der Datenquelle

Beispiel-Prompts

  • Welche Gruppen hat DS 3?
  • Gruppen von Datenquelle 1
raw_response: Ja
datasource.users GET /api/admin/datasources/{ds_id}/users

Zugeordnete Benutzer einer Datenquelle

Hilfe

Zeigt welche Benutzer direkt einer Datenquelle zugeordnet sind.

Parameter

Name Typ Required Default Beschreibung
ds_id integer Ja — ID der Datenquelle

Beispiel-Prompts

  • Welche Benutzer hat DS 2?
  • User von Datenquelle 5
raw_response: Ja
datasource.connector_types GET /api/admin/connector-types

Verfügbare Konnektor-Typen mit Schema

Hilfe

Listet alle registrierten Konnektor-Typen (local, smb, webdav, imap, exchange, sql, ...) mit ihrem Konfigurationsschema auf.

Beispiel-Prompts

  • Welche Konnektor-Typen gibt es?
  • Verfügbare Datenquellen-Typen
raw_response: Ja
datasource.ingestion_status GET /api/admin/datasources/{ds_id}/ingestion-status

Ingestion-Status einer Datenquelle

Hilfe

Zeigt den aktuellen Ingestion-Status (idle, running, paused, error), Fortschritt und letzte Fehler einer Datenquelle.

Parameter

Name Typ Required Default Beschreibung
ds_id integer Ja — ID der Datenquelle

Beispiel-Prompts

  • Ingestion-Status von DS 1
  • Läuft bei Datenquelle 3 eine Indexierung?
raw_response: Ja
datasource.create POST /api/admin/datasources

Neue Datenquelle erstellen

Hilfe

Erstellt eine neue Datenquelle mit Konnektor-Konfiguration und Indexierungs-Einstellungen. Konnektor-Typen und ihre Pflichtfelder sind via datasource.connector_types abrufbar. Passwörter werden automatisch verschlüsselt gespeichert.

Parameter

Name Typ Required Default Beschreibung
name string Ja — Anzeigename der Datenquelle
type string Ja — Konnektor-Typ
connector_config object Ja — Konnektor-spezifische Konfiguration (Schema via datasource.connector_types)
ds_chunk_strategy string Nein — Chunking-Strategie (Default: auto)
ds_chunk_size integer Nein — Chunk-Größe in Zeichen
ds_chunk_overlap integer Nein — Chunk-Überlappung in Zeichen
ds_file_types array Nein — Erlaubte Dateitypen (leer = alle)
ds_exclude_patterns array Nein — Ausschluss-Muster (Glob-Syntax)
ds_ddu_enabled boolean Nein — Document Understanding aktivieren
ds_ddu_ocr_images boolean Nein — OCR für Bilder (Default: true)
ds_vlm_enabled boolean Nein — Vision Language Model aktivieren
ds_accept_all_text boolean Nein — Alle Textdateien akzeptieren
ds_index_attachments boolean Nein — E-Mail-Anhänge indexieren (Default: true)
sync_interval string Nein — Sync-Intervall (Default: global)

Beispiel-Prompts

  • Erstelle eine neue WebDAV-Datenquelle
  • Neue lokale Datenquelle für /data/dokumente
  • SMB-Share als Datenquelle hinzufügen

Changelog

Area: datasources | Action: create

raw_response: Ja | PK-Param: name
datasource.update PUT /api/admin/datasources/{ds_id}

Datenquelle aktualisieren

Hilfe

Aktualisiert Name, Konnektor-Konfiguration oder Indexierungs-Einstellungen einer bestehenden Datenquelle. Nur übergebene Felder werden geändert (Partial Update). Passwort-Felder mit dem Wert '••••••••' behalten den bestehenden Wert bei.

Parameter

Name Typ Required Default Beschreibung
ds_id integer Ja — ID der Datenquelle
name string Nein — Neuer Anzeigename
connector_config object Nein — Neue Konnektor-Konfiguration
ds_chunk_strategy string Nein — Chunking-Strategie
ds_chunk_size integer Nein — Chunk-Größe
ds_chunk_overlap integer Nein — Chunk-Überlappung
ds_file_types array Nein — Dateifilter
ds_exclude_patterns array Nein — Ausschluss-Muster
ds_ddu_enabled boolean Nein — DDU aktivieren/deaktivieren
ds_ddu_ocr_images boolean Nein — OCR für Bilder
ds_vlm_enabled boolean Nein — VLM aktivieren/deaktivieren
ds_accept_all_text boolean Nein — Alle Textdateien akzeptieren
ds_index_attachments boolean Nein — E-Mail-Anhänge indexieren
sync_interval string Nein — Sync-Intervall

Beispiel-Prompts

  • Ändere den Namen von Datenquelle 5 zu 'Buchhaltung'
  • Aktualisiere das Passwort der WebDAV-Quelle 12
  • Deaktiviere DDU für Datenquelle 8

Confirmation

Diese Funktion erfordert eine Bestaetigung. Template: ds {ds_id} aktualisieren

Changelog

Area: datasources | Action: update

raw_response: Ja | PK-Param: ds_id
datasource.delete DELETE /api/admin/datasources/{ds_id}

Datenquelle und alle zugehörigen Daten löschen

Hilfe

Löscht eine Datenquelle vollständig: Qdrant-Vektoren (alle Collections), Elasticsearch-Einträge, File-Hash-Store, DB-Cascade (11 Tabellen: ingestion_file_logs, file_hashes, hash_mode_meta, chunk_datasources, datasource_embeddings, datasource_groups, datasource_users, ingestion_jobs, cache_datasources, cache_jobs, datasources), Mount-Points und Cron-Schedules. IRREVERSIBEL — erfordert Bestätigung.

Parameter

Name Typ Required Default Beschreibung
ds_id integer Ja — ID der Datenquelle

Beispiel-Prompts

  • Lösche Datenquelle 5
  • Datenquelle 'Altdaten' entfernen

Confirmation

Diese Funktion erfordert eine Bestaetigung. Template: ds {ds_id} löschen

Changelog

Area: datasources | Action: delete

raw_response: Ja | PK-Param: ds_id
datasource.test_connection POST /api/admin/datasources/test-connection

Verbindungstest für eine Datenquelle

Hilfe

Testet die Verbindung zu einer Datenquelle. Kann mit ad-hoc Konfiguration (type + config) oder mit einer bestehenden Datenquellen-ID (ds_id) aufgerufen werden. Bei ds_id werden PASSWORD_MASK-Felder automatisch aufgelöst.

Parameter

Name Typ Required Default Beschreibung
type string Ja — Konnektor-Typ
config object Ja — Verbindungsdaten
ds_id integer Nein — ID einer bestehenden Datenquelle (alternativ zu type+config)

Beispiel-Prompts

  • Teste die Verbindung zu Datenquelle 5
  • Teste WebDAV-Verbindung zu https://cloud.firma.de
raw_response: Ja
datasource.browse Chat-only

Verzeichnis-Inhalt einer Datenquelle auflisten

Hilfe

Listet Dateien und Ordner an einem Pfad auf. Dispatcht intern nach Typ: SMB (browse-share), WebDAV (browse-webdav), IMAP/Exchange (list-folders), Lokal (Dateisystem). Nützlich vor datasource.create zum Pfad-Erkunden.

Parameter

Name Typ Required Default Beschreibung
type string Ja — Konnektor-Typ (smb, webdav, imap, exchange, local)
config object Ja — Verbindungsdaten
path string Nein — Pfad zum Browsen (Default: Root)

Beispiel-Prompts

  • Zeig mir die Ordner auf dem SMB-Share
  • Was liegt im WebDAV-Verzeichnis /files/hr?
raw_response: Nein
Chat-only (kein HTTP-Mapping)
datasource.assign_groups POST /api/admin/datasources/{ds_id}/groups

Gruppen einer Datenquelle zuweisen

Hilfe

Setzt die Gruppen-Zuordnung einer Datenquelle. ACHTUNG: Ersetzt ALLE bestehenden Zuordnungen (Replace-All, nicht Append). Leere Liste entfernt alle Gruppenzuordnungen.

Parameter

Name Typ Required Default Beschreibung
ds_id integer Ja — ID der Datenquelle
group_ids array Ja — Gruppen-IDs (ersetzt alle bestehenden)

Beispiel-Prompts

  • Weise Datenquelle 5 den Gruppen 1 und 3 zu
  • Entferne alle Gruppenzuordnungen von DS 8

Confirmation

Diese Funktion erfordert eine Bestaetigung. Template: ds {ds_id} gruppen zuweisen

Changelog

Area: datasources | Action: update

raw_response: Ja | PK-Param: ds_id
datasource.assign_users POST /api/admin/datasources/{ds_id}/users

User einer Datenquelle zuweisen

Hilfe

Setzt die User-Zuordnung einer Datenquelle. ACHTUNG: Ersetzt ALLE bestehenden Zuordnungen (Replace-All, nicht Append).

Parameter

Name Typ Required Default Beschreibung
ds_id integer Ja — ID der Datenquelle
user_ids array Ja — User-IDs (ersetzt alle bestehenden)

Beispiel-Prompts

  • Weise Datenquelle 5 den Usern 2 und 7 zu

Confirmation

Diese Funktion erfordert eine Bestaetigung. Template: ds {ds_id} user zuweisen

Changelog

Area: datasources | Action: update

raw_response: Ja | PK-Param: ds_id