Hata kılavuzu v4.0, v3.1 ve v3.0

Belge Zekası, REST API'lerinde karşılaşılan tüm hataları temsil etmek için birleşik bir tasarım kullanır. Bir API işlemi 4xx veya 5xx durum kodu döndürdüğünde, yanıt JSON gövdesinde hatayla ilgili ek bilgiler aşağıdaki gibi döndürülür:

{
  "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."
    }
  }
}

Birden çok hatayla karşılaşıldığı uzun süre çalışan işlemler için en üst düzey hata kodu, error.details özelliği altında listelenen tek tek hatalar ile en ciddi hataya ayarlanır. Bu tür senaryolarda, her bir hatanın hedef özelliği hatanın tetikleyicisini belirtir.

{
    "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"
            }
        ]
    }
}

En üst düzey error.code özelliği aşağıdaki hata kodu iletilerinden biri olabilir:

Mümkün olduğunda, iç hata özelliğinde daha fazla ayrıntı belirtilir.