Zum Inhalt

API-Referenz

Hier werden zwei sich ergänzende Referenzen veröffentlicht: die Python-SDK-Referenz, generiert aus dem Quellcode jeder Bibliothek in wittgenstein-core, und die OpenAPI-Endpunkte der Plattform.

Python-SDK-Referenz

Der Tab SDK Reference dokumentiert jede wittgenstein-*-Bibliothek: jedes öffentliche Modul, jede Klasse und jede Funktion, mit Signaturen und Docstrings direkt aus dem Quellcode. Es gibt keine von Hand gepflegte Kopie, die auseinanderlaufen könnte.

  • Authentifizierung

    JWT-Prüfung, Rollenchecks und der Token-Endpunkt im selben Origin.

    oidc_backend

  • LLM-Routing

    Anbieterunabhängiges Routing für Modellaufrufe.

    llm_router

  • Observability

    Tracing- und Telemetrie-Helfer, die von jedem Dienst genutzt werden.

    observability

  • Pipelines

    Komponierbare Daten- und Agenten-Pipelines.

    pipelines

So wird sie erzeugt

Bei jedem Build klont die Dokumentationsseite wittgenstein-core und führt mkapi über jede Bibliothek unter libs/ aus. Die Generierung wird pro Bibliothek gecacht: Jede Lib wird über den letzten Commit identifiziert, der ihr Verzeichnis berührt hat, und nur Libs mit neuen Commits werden neu erzeugt. Alles andere stammt aus dem vorherigen Lauf.

$ make build
[sync-core-api] fetching new wittgenstein-core commits
[sync-core-api] core@8f7bfa93: 21 libs, 2 to regenerate (oidc-backend, pipelines)
[sync-core-api] wrote 21 packages to docs/reference/
INFO    -  Building documentation to directory: site
INFO    -  Documentation built in 14.20 seconds
$ make build
[sync-core-api] wittgenstein-core has no new commits, skipping fetch
[sync-core-api] core@8f7bfa93: 21 libs, 0 to regenerate — everything served from cache
[sync-core-api] wrote 21 packages to docs/reference/

Für eine vollständige Neugenerierung setzen Sie FORCE_API_REBUILD=1. Es wird nur der Baum libs/ ausgecheckt, und die Bibliotheken werden geparst, nie importiert — der Docs-Build braucht also keine ihrer Laufzeitabhängigkeiten.

Schreiben Sie gute Docstrings

Die Referenz ist nur so gut wie die Docstrings, die sie liest. Dokumentieren Sie das Warum im Modul-Docstring, führen Sie Argumente und Rückgabewerte im Google-Stil auf und ergänzen Sie ein kurzes Beispiel für alles Nicht-Offensichtliche.

Plattform-OpenAPI

Die Spezifikation der Core-API wird dynamisch bereitgestellt.