次の方法で共有


エラー ガイド v4.0、v3.1、v3.0

Document Intelligence では、統一された設計を使用して、REST API で発生するすべてのエラーを表します。 API 操作から 4xx または 5xx の状態コードが返されるときは常に、エラーに関する追加情報が次のように応答 JSON の本文で返されます。

{
  "error": {
    "code": "InvalidRequest",
    "message": "Invalid request.",
    "innererror": {
      "code": "InvalidContent",
      "message": "The file format is unsupported or corrupted. Refer to documentation for the list of supported formats."
    }
  }
}

複数のエラーが発生する実行時間の長い操作の場合、最上位レベルのエラー コードが最も重大なエラーに設定され、個々のエラーは error.details プロパティの下の一覧に表示されます。 このようなシナリオでは、個々のエラーの target プロパティによってエラーのトリガーが指定されます。

{
    "status": "failed",
    "createdDateTime": "2021-07-14T10:17:51Z",
    "lastUpdatedDateTime": "2021-07-14T10:17:51Z",
    "error": {
        "code": "InternalServerError",
        "message": "An unexpected error occurred.",
        "details": [
            {
                "code": "InternalServerError",
                "message": "An unexpected error occurred."
            },
            {
                "code": "InvalidContentDimensions",
                "message": "The input image dimensions are out of range. Refer to documentation for supported image dimensions.",
                "target": "2"
            }
        ]
    }
}

最上位の error.code プロパティには、次のいずれかのエラー コード メッセージが設定される可能性があります。

エラー コード Message HTTP の状態
InvalidRequest 無効な要求です。 400
InvalidArgument 引数が無効です。 400
Forbidden ポリシーまたは他の構成のためにアクセスが禁止されました。 403
NotFound リソースが見つかりません。 404
MethodNotAllowed 要求された HTTP メソッドは許可されません。 405
競合 競合のため、要求を完了できませんでした。 409
UnsupportedMediaType 要求のコンテンツ タイプはサポートされていません。 415
InternalServerError 予期しないエラーが発生しました。 500
ServiceUnavailable 一時的なエラーが発生しました。 やり直してください。 503

可能であれば、"内部エラー" プロパティで詳細が指定されています。

最上位のエラー コード 内部エラー コード Message
競合 ModelExists 指定された名前のモデルは既に存在します。
Forbidden AuthorizationFailed 承認に失敗しました: <詳細>
Forbidden InvalidDataProtectionKey データ保護キーが無効です: <詳細>
Forbidden OutboundAccessForbidden 要求に、許可されていないドメイン名または現在のアクセス制御ポリシーに違反するドメイン名が含まれます。
InternalServerError Unknown 不明なエラー。
InvalidArgument InvalidContentSourceFormat 無効なコンテンツ ソース: <詳細>
InvalidArgument InvalidParameter パラメーター <パラメーター名> が無効です: <詳細>
InvalidArgument InvalidParameterLength パラメーター <パラメーター名> の長さは <最大文字数> 文字を超えることはできません。
InvalidArgument InvalidSasToken Shared Access Signature (SAS) が無効です: <詳細>
InvalidArgument ParameterMissing パラメーター <パラメーター名> は必須です。
InvalidRequest ContentSourceNotAccessible コンテンツにアクセスできません: <詳細>
InvalidRequest ContentSourceTimeout クライアントからのファイルの受信中のタイムアウト。
InvalidRequest DocumentModelLimit アカウントで <最大モデル数> 個より多くのモデルを作成することはできません。
InvalidRequest DocumentModelLimitNeural アカウントで 1 か月あたり 10 を超えるカスタム ニューラル モデルを作成することはできません。 容量の追加依頼は、サポートに連絡してください。
InvalidRequest DocumentModelLimitComposed アカウントで <詳細> 個より多くのコンポーネント モデルを含むモデルを作成することはできません。
InvalidRequest InvalidContent ファイルが破損しているか、サポートされてない形式です。 サポートされる形式の一覧については、ドキュメントを参照してください。
InvalidRequest InvalidContentDimensions 入力画像の寸法が範囲を超えています。 サポートされている画像の寸法については、ドキュメントを参照してください。
InvalidRequest InvalidContentLength 入力画像が大きすぎます。 ファイルの最大サイズについては、ドキュメントを参照してください。
InvalidRequest InvalidFieldsDefinition 無効なフィールド: <詳細>
InvalidRequest InvalidTrainingContentLength トレーニング コンテンツには <バイト数> バイトが含まれます。 トレーニングは <最大バイト数> バイトに制限されます。
InvalidRequest InvalidTrainingContentPageCount トレーニング コンテンツには <ページ数> ページが含まれます。 トレーニングは <ページ数> ページに制限されます。
InvalidRequest ModelAnalyzeError カスタム モデルを使用して分析できませんでした: <詳細>
InvalidRequest ModelBuildError モデルをビルドできませんでした: <詳細>
InvalidRequest ModelComposeError モデルを作成できませんでした: <詳細>
InvalidRequest ModelNotReady モデルは、要求された操作の準備ができていません。 トレーニングが完了するまで待つか、操作のエラーを確認してください。
InvalidRequest ModelReadOnly 要求されたモデルは読み取り専用です。
InvalidRequest NotSupportedApiVersion 要求された操作には 以降が必要です。
InvalidRequest OperationNotCancellable 操作を取り消すことはもうできません。
InvalidRequest TrainingContentMissing トレーニング データがありません: <詳細>
InvalidRequest UnsupportedContent コンテンツはサポートされていません: <詳細>
NotFound ModelNotFound 要求されたモデルは見つかりませんでした。 削除されたか、まだビルドされています。
NotFound OperationNotFound 要求された操作は見つかりませんでした。 識別子が無効であるか、操作の有効期限が切れています。