Skip to main content
Das Python SDK erfordert Python 3.9+.

Installation

Schnellstart

Konto erstellen

Die Funktion signup erstellt ein neues Avala-Konto und gibt einen API Key zurück. Sie erfordert keine Authentifizierung.
Eine asynchrone Variante ist ebenfalls verfügbar:

Authentifizierung

Das SDK authentifiziert sich mit Ihrem Avala API Key, der über den X-Avala-Api-Key Header bei jeder Anfrage gesendet wird. Sie können den Key direkt übergeben oder das SDK ihn aus der Umgebung lesen lassen. Option 1: Key direkt übergeben
Option 2: Umgebungsvariable verwenden

Async-Unterstützung

Das SDK enthält einen vollständig asynchronen Client, der auf httpx basiert. Verwenden Sie AsyncClient für nicht-blockierende I/O in asynchronen Anwendungen.
Verwendung des Async Context Managers:

Arbeiten mit Datensätzen

Das Python SDK ist derzeit schreibgeschützt für Datensätze — Sie können auflisten, abrufen und Elemente durchsuchen, aber keine Datensätze erstellen oder löschen. Verwenden Sie die REST API für Uploads und Mutationen.

Datensätze auflisten

Datensatz abrufen

Arbeiten mit Projekten

Projekte auflisten

Projekt abrufen

Arbeiten mit Aufgaben

Aufgaben auflisten

Aufgabe abrufen

Arbeiten mit Exporten

Das Python SDK unterstützt vollständige CRUD-Operationen für Agents, Webhooks, Speicherkonfigurationen, Inferenz-Provider, Qualitätsziele, Konsenskonfiguration und Organisationen. Datensätze und Projekte sind derzeit schreibgeschützt — verwenden Sie die REST API für Mutationen bei diesen Ressourcen.

Export erstellen

Auf Fertigstellung warten

Arbeiten mit Organisationen

Organisationen auflisten

Organisation erstellen

Mitglieder verwalten

Arbeiten mit Slices

Slices auflisten

Datensatz-Elemente durchsuchen

Elemente in einem Datensatz auflisten

Sequenzen auflisten

Type Hints

Das SDK ist vollständig typisiert. Alle Antwortobjekte sind Pydantic-Modelle mit vollständigen Typannotationen, die Ihnen Autovervollständigung und Typprüfung sofort ermöglichen.

Fehlerbehandlung

Das SDK wirft typisierte Exceptions, sodass Sie verschiedene Fehlermodi präzise behandeln können.

Paginierung

Listen-Methoden geben ein CursorPage-Objekt zurück. Sie können direkt über Elemente iterieren oder die Paginierung manuell steuern.

Flottenmanagement

Flottenmanagement ist in der Vorschau. Die hier beschriebenen APIs können sich ändern.
Der fleet-Namespace bietet Zugriff auf Geräteregister, Aufnahmen, Events, Regeln und Warnungen.
Siehe den Fleet Dashboard Guide für vollständige Beispiele.

Konfiguration

Sie können das Client-Verhalten bei der Initialisierung anpassen.