Loslegen
DokumentationKonzepte

Plattform-Konzepte

Layerum ist für produktives RAG entwickelt: strukturierte Workspaces, sicherer API-Key-Zugriff, zuverlässige Ingestion und kontrollierbare Kapazität vom Upload bis zur Abfrage.

Was ist Layerum

Layerum ist eine gehostete RAG-Plattform für Teams, die Wissen ingestieren, Zugriff über Workspaces steuern und zuverlässige Antworten über API oder SDK bereitstellen müssen.

  • Gehosteter Endpoint: https://api.layerum.com.
  • Öffentliche API-Struktur: /v1/*.
  • Authentifizierung: Workspace-API-Keys (lyr_wk_...).

Workspace-Modell

Jedes Team arbeitet in isolierten Workspaces. Berechtigungen, Modelle, Entitäten, Dokumente und API-Keys werden auf Workspace-Ebene verwaltet.

  • Mehrere Workspaces pro Account je nach Tarif.
  • Teammitglieder, Rollen und operative Grenzen bleiben innerhalb eines Workspaces.
  • API-Keys können auf Entitäten und Modellkonfigurationen eingeschränkt werden.

Datenmodell

Wissen wird so organisiert, dass sowohl Governance als auch präzises Retrieval unterstützt werden.

  • Entity Types definieren übergeordnete Kategorien.
  • Entities bilden Hierarchie und Retrieval-Kontext.
  • Dokumente sind Entitäten zugeordnet und werden in Chunks/Vektoren indexiert.

Ingestion-Lebenszyklus

Dokumente durchlaufen einen klar definierten Prozess: Upload, Parsing, Chunking, Embedding, Indexierung und Statusverfolgung.

  • Kleine Dateien: direkter Multipart-Upload.
  • Große Dateien: presigned Flow (init → S3 POST → complete).
  • Status: pending, processing, completed, failed.
  • SDK-Helfer ingestion.waitUntilReady übernimmt Polling.

Kapazitätskontrolle

Kapazität ist kontoabhängig und wird dynamisch auf Workspaces verteilt. Durchsetzung erfolgt serverseitig.

  • Gezählt: Entitäten, Dokumentgröße, Chunks, S3-Dateien, Upload-Reservierungen.
  • Nicht gezählt: Logs, API-Key-Metadaten, Modell-Metadaten.
  • Uploads sind abgesichert: Reservierung, Validierung, Cleanup.

Sicherheit und Governance

Zugriff ist explizit, granular und jederzeit widerrufbar.

  • API-Keys werden nur im UI erstellt.
  • Capabilities: query:read, data:ingest, config:manage.
  • Kontrollen: Scope, Limits, Ablaufdatum.
  • Rotation und Widerruf wirken sofort.

Retrieval-Qualität

Abfragen liefern kontrollierbare und nachvollziehbare Antworten.

  • Entity-Scopes halten Kontext relevant.
  • Top-K und Parent-Scopes steuern Breite.
  • Zitate ermöglichen Rückverfolgbarkeit.
  • Debug-Endpoint für Analyse.

Developer Experience

Integration über SDK oder HTTP mit identischem API-Vertrag.

  • SDK: @layerum-team/rag-sdk.
  • API: https://api.layerum.com/v1.
  • Gleiche Auth- und Limit-Logik.
ts

Betrieb und Zuverlässigkeit

Fokus auf stabile Produktion und nachvollziehbare Fehler.

  • Fehler werden persistiert.
  • Retry-Endpunkte vorhanden.
  • Indexierung folgt Dokument-Lifecycle.
  • Kapazitätschecks verhindern Overuse.

Typische Anwendungsfälle

  • Support-Knowledge-Assistenten.
  • Interne Dokumentensuche.
  • Compliance-Abfragen mit Zitaten.
  • Team-spezifische Copilots.

Erste Schritte

  • 1. Workspace erstellen.
  • 2. API-Key erzeugen.
  • 3. Entitäten & Dokumente anlegen.
  • 4. Nach Ingestion Queries ausführen.

Siehe Referenz für Details. Referenz.