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:

Código de Erro	Mensagem	Http Status
InvalidRequest	Pedido inválido.	400
InvalidArgument	Argumento inválido.	400
Proibido	Acesso proibido devido a política ou outra configuração.	403
NotFound	Recurso não encontrado.	404
MethodNotAllowed	O método HTTP solicitado não é permitido.	405
Conflito	O pedido não pôde ser concluído devido a um conflito.	409
UnsupportedMediaType	Não há suporte para o tipo de conteúdo de solicitação.	415
InternalServerError	Ocorreu um erro inesperado.	500
ServiceUnavailable	Ocorreu um erro transitório. Tente novamente.	503

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

Código de erro superior	Código de erro interno	Mensagem
Conflito	ModeloExiste	Já existe um modelo com o nome fornecido.
Proibido	AutorizaçãoFalhou	Falha na autorização: {details}
Proibido	InvalidDataProtectionKey	A chave de proteção de dados é inválida: {details}
Proibido	OutboundAccessForbidden	A solicitação contém um nome de domínio não permitido ou viola a política de controle de acesso atual.
InternalServerError	Desconhecido	Uma margem de erro desconhecida.
InvalidArgument	InvalidContentSourceFormat	Fonte de conteúdo inválida: {details}
InvalidArgument	InvalidParameter	O parâmetro {parameterName} é inválido: {details}
InvalidArgument	InvalidParameterLength	O comprimento do parâmetro {parameterName} não deve exceder {maxChars} caracteres.
InvalidArgument	InvalidSasToken	A assinatura de acesso compartilhado (SAS) é inválida: {details}
InvalidArgument	ParâmetroAusente	O parâmetro {parameterName} é obrigatório.
InvalidRequest	ContentSourceNotAccessible	O conteúdo não está acessível: {details}
InvalidRequest	ContentSourceTimeout	Tempo limite ao receber o arquivo do cliente.
InvalidRequest	DocumentModelLimit	A conta não pode criar mais do que modelos {maximumModels}.
InvalidRequest	DocumentModelLimitNeural	A conta não pode criar mais de 10 modelos neurais personalizados por mês. Entre em contato com o suporte para solicitar mais capacidade.
InvalidRequest	DocumentModelLimitComposed	A conta não pode criar um modelo com mais de {detalhes} modelos de componentes.
InvalidRequest	Conteúdo inválido	O arquivo está corrompido ou o formato não é suportado. Consulte a documentação para obter a lista de formatos suportados.
InvalidRequest	InvalidContentDimensions	As dimensões da imagem de entrada estão fora do intervalo. Consulte a documentação para obter as dimensões da imagem suportadas.
InvalidRequest	InvalidContentLength	A imagem de entrada é muito grande. Consulte a documentação para obter o tamanho máximo do arquivo.
InvalidRequest	InvalidFieldsDefinition	Campos inválidos: {details}
InvalidRequest	InvalidTrainingContentLength	O conteúdo de treinamento contém {bytes} bytes. O treinamento é limitado a {maxBytes} bytes.
InvalidRequest	InvalidTrainingContentPageCount	O conteúdo de treinamento contém {páginas} páginas. O treinamento é limitado a {páginas} páginas.
InvalidRequest	ModelAnalyzeError	Não foi possível analisar usando um modelo personalizado: {details}
InvalidRequest	ModelBuildError	Não foi possível construir o modelo: {details}
InvalidRequest	ModelComposeError	Não foi possível compor o modelo: {detalhes}
InvalidRequest	ModelNotReady	O modelo não está pronto para a operação solicitada. Aguarde a conclusão do treinamento ou verifique se há erros de operação.
InvalidRequest	ModelReadOnly	O modelo solicitado é somente leitura.
InvalidRequest	NotSupportedApiVersion	A operação solicitada requer {minimumApiVersion} ou posterior.
InvalidRequest	OperaçãoNotCancellable	A operação não pode mais ser cancelada.
InvalidRequest	FormaçãoConteúdoFalta	Dados de treinamento estão faltando: {details}
InvalidRequest	Conteúdo não suportado	O conteúdo não é suportado: {details}
NotFound	ModelNotFound	O modelo solicitado não foi encontrado. Ele é excluído ou ainda está em construção.
NotFound	OperaçãoNotFound	A operação solicitada não foi encontrada. O identificador é inválido ou a operação expirou.