例外

TypeSafe API のエラー、レート制限、接続失敗、タイムアウトを扱います。

基底の例外

typesafe_sdk.TypeSafeError

基底：Exception

SDK の失敗に対する基底の例外。

HTTP エラー

typesafe_sdk.TypeSafeAPIError

基底：TypeSafeError

成功しなかった HTTP 応答。本文とリクエストのメタデータを伴います。

status

instance-attribute

status = status

HTTP 応答のステータスコード。

body

instance-attribute

body = body

サーバーが返す JSON のエラー本文、プレーンな応答テキスト、本文が空の場合は None。

headers

instance-attribute

headers = headers

HTTP 応答ヘッダー。

endpoint

instance-attribute

endpoint = endpoint

利用可能な場合の、リクエストのメソッドと URL。認証情報、クエリパラメーター、フラグメントは含みません。

request_id

property

request_id: str | None

応答ヘッダー x-typesafe-request-id。存在しない場合は None。

typesafe_sdk.TypeSafeBadRequestError

基底：TypeSafeAPIError

リクエストが無効でした（400）。

typesafe_sdk.TypeSafeAuthenticationError

基底：TypeSafeAPIError

認証に失敗しました（401）。

typesafe_sdk.TypeSafePermissionDeniedError

基底：TypeSafeAPIError

アクセスが拒否されました（403）。

typesafe_sdk.TypeSafeNotFoundError

基底：TypeSafeAPIError

リソースが見つかりませんでした（404）。

typesafe_sdk.TypeSafeUnprocessableEntityError

基底：TypeSafeAPIError

リクエストがサーバー側の検証に失敗しました（422）。

typesafe_sdk.TypeSafeRateLimitError

基底：TypeSafeAPIError

レート制限を超えました（429）。

retry_after_ms

instance-attribute

retry_after_ms = parse_retry_after(headers)

サーバーが要求する待機時間（ミリ秒）。利用できない場合は None。

typesafe_sdk.TypeSafeInternalServerError

基底：TypeSafeAPIError

サーバーがリクエストの処理に失敗しました（5xx）。

接続エラー

typesafe_sdk.TypeSafeAPIConnectionError

基底：TypeSafeError, ConnectionError

HTTP 応答なしでリクエストが失敗しました。

typesafe_sdk.TypeSafeAPITimeoutError

基底：TypeSafeAPIConnectionError, TimeoutError

リクエストが設定されたタイムアウトを超えました。

timeout

instance-attribute

timeout = timeout

リクエストに使われたタイムアウト設定。秒数、または httpx2.Timeout。

応答の検証

typesafe_sdk.TypeSafeAPIResponseValidationError

基底：TypeSafeAPIError

成功した HTTP 応答ですが、本文に必須データが欠けているか、構造的に不正でした。

field_path

instance-attribute

field_path = field_path

問題のあるフィールドへのドット区切りパス（例：answers.tone.confidence）。

args

instance-attribute

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