Guia de erros v4.0, v3.1 e v3.0

O Document Intelligence usa um design unificado para representar todos os erros encontrados nas APIs REST. Sempre que uma operação de API retorna um código de status 4xx ou 5xx, informações adicionais sobre o erro são retornadas no corpo JSON de resposta da seguinte maneira:

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

Para operações de longa duração em que vários erros são encontrados, o código de erro de nível superior é definido como o erro mais grave, com os erros individuais listados na propriedade error.details . Nesses cenários, a propriedade de destino de cada erro individual especifica o gatilho do erro.

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

A propriedade error.code de nível superior pode ser uma das seguintes mensagens de código de erro:

Quando possível, mais detalhes são especificados na propriedade de erro interno.