Dokumentation

Ausnahmen

Behandle TypeSafe API-Fehler, Ratenbegrenzungen, Verbindungsfehler und Zeitüberschreitungen.

Basis-Ausnahme

typesafe_sdk.TypeSafeError

Basisklasse: Exception

Basis-Ausnahme für SDK-Fehler.

HTTP-Fehler

typesafe_sdk.TypeSafeAPIError

Basisklasse: TypeSafeError

Eine erfolglose HTTP-Antwort mit ihrem Body und den Anfrage-Metadaten.

status

instance-attribute

status = status

HTTP-Antwortstatuscode.

body

instance-attribute

body = body

Der JSON-Fehlerbody des Servers, der reine Antworttext oder None bei leerem Body.

headers

instance-attribute

headers = headers

HTTP-Antwortheader.

endpoint

instance-attribute

endpoint = endpoint

HTTP-Methode und URL der Anfrage, ohne Anmeldedaten, Query-Parameter oder Fragment, sofern verfügbar.

request_id

property

request_id: str | None

Der Antwortheader x-typesafe-request-id oder None, wenn er fehlt.

typesafe_sdk.TypeSafeBadRequestError

Basisklasse: TypeSafeAPIError

Die Anfrage war ungültig (400).

typesafe_sdk.TypeSafeAuthenticationError

Basisklasse: TypeSafeAPIError

Die Authentifizierung ist fehlgeschlagen (401).

typesafe_sdk.TypeSafePermissionDeniedError

Basisklasse: TypeSafeAPIError

Der Zugriff wurde verweigert (403).

typesafe_sdk.TypeSafeNotFoundError

Basisklasse: TypeSafeAPIError

Die Ressource wurde nicht gefunden (404).

typesafe_sdk.TypeSafeUnprocessableEntityError

Basisklasse: TypeSafeAPIError

Die Anfrage hat die Servervalidierung nicht bestanden (422).

typesafe_sdk.TypeSafeRateLimitError

Basisklasse: TypeSafeAPIError

Die Ratenbegrenzung wurde überschritten (429).

retry_after_ms

instance-attribute

retry_after_ms = parse_retry_after(headers)

Die vom Server angeforderte Wartezeit in Millisekunden oder None, wenn sie nicht verfügbar ist.

typesafe_sdk.TypeSafeInternalServerError

Basisklasse: TypeSafeAPIError

Der Server konnte die Anfrage nicht verarbeiten (5xx).

Verbindungsfehler

typesafe_sdk.TypeSafeAPIConnectionError

Basisklasse: TypeSafeError, ConnectionError

Eine Anfrage ist ohne HTTP-Antwort fehlgeschlagen.

typesafe_sdk.TypeSafeAPITimeoutError

Basisklasse: TypeSafeAPIConnectionError, TimeoutError

Eine Anfrage hat ihr konfiguriertes Zeitlimit überschritten.

timeout

instance-attribute

timeout = timeout

Die für die Anfrage verwendete Zeitlimit-Einstellung, in Sekunden oder als httpx2.Timeout.

Antwortvalidierung

typesafe_sdk.TypeSafeAPIResponseValidationError

Basisklasse: TypeSafeAPIError

Eine erfolgreiche HTTP-Antwort, deren Body erforderliche Daten fehlten oder strukturell ungültig waren.

field_path

instance-attribute

field_path = field_path

Gepunkteter Pfad zum fehlerhaften Feld, etwa answers.tone.confidence.

args

instance-attribute

args = (
    status,
    body,
    headers,
    field_path,
    endpoint,
)