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

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

{
  "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 as operações de longa execução em que vários erros são encontrados, o código de erro de nível superior é definido para o erro mais grave, com os erros individuais listados na propriedade error.details. Nesses cenários, a propriedade target 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 do código de erro:

Código do Erro	Mensagem	Status Http
InvalidRequest	Solicitação inválida.	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	A solicitação não pôde ser concluída devido a um conflito.	409
UnsupportedMediaType	Não há suporte para o tipo de conteúdo da solicitação.	415
InternalServerError	Erro inesperado.	500
ServiceUnavailable	Ocorreu um erro transitório. Tente novamente.	503

Quando possível, mais detalhes são especificados na propriedade inner error.

Código do erro de nível superior	Código de erro interno	Mensagem
Conflito	ModelExists	Já existe um modelo com o nome fornecido.
Proibido	AuthorizationFailed	Falha na autorização: {detalhes}
Proibido	InvalidDataProtectionKey	A chave de proteção de dados é inválida: {detalhes}
Proibido	OutboundAccessForbidden	A solicitação contém um nome de domínio que não é permitido ou viola a política de controle de acesso atual.
InternalServerError	Unknown	Erro desconhecido.
InvalidArgument	InvalidContentSourceFormat	Fonte do conteúdo inválida: {detalhes}
InvalidArgument	InvalidParameter	O parâmetro {nomeParâmetro} é inválido: {detalhes}
InvalidArgument	InvalidParameterLength	O comprimento do parâmetro {nomeParâmetro} não deve exceder {caracMáx} caracteres.
InvalidArgument	InvalidSasToken	A SAS (assinatura de acesso compartilhado) é inválida: {detalhes}
InvalidArgument	ParameterMissing	O parâmetro {nomeParâmetro} é requerido.
InvalidRequest	ContentSourceNotAccessible	O conteúdo não está acessível: {details}
InvalidRequest	ContentSourceTimeout	Tempo limite excedido ao receber o arquivo do cliente.
InvalidRequest	DocumentModelLimit	A conta não pode criar mais de {maximumModels} modelos.
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 {details} modelos de componente.
InvalidRequest	InvalidContent	O arquivo está corrompido ou não há suporte para o formato. Consulte a documentação para obter a lista de formatos com suporte.
InvalidRequest	InvalidContentDimensions	As dimensões da imagem de entrada estão fora do intervalo. Consulte a documentação para obter as dimensões de imagem com suporte.
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: {detalhes}
InvalidRequest	InvalidTrainingContentLength	O conteúdo de treinamento contém {bytes} bytes. O treinamento está limitado a {bytesMáx} 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 compilar o modelo: {details}
InvalidRequest	ModelComposeError	Não foi possível compor o modelo: {details}
InvalidRequest	ModelNotReady	O modelo não está pronto para a operação solicitada. Aguarde até que o treinamento seja concluído ou verifique se há erros de operação.
InvalidRequest	ModelReadOnly	O modelo solicitado é de somente leitura.
InvalidRequest	NotSupportedApiVersion	A operação solicitada requer {versãoApiMínima} ou posterior.
InvalidRequest	OperationNotCancellable	A operação não pode mais ser cancelada.
InvalidRequest	TrainingContentMissing	Faltam dados de treinamento: {detalhes}
InvalidRequest	UnsupportedContent	Não há suporte para o conteúdo: {details}
NotFound	ModelNotFound	O modelo solicitado não foi encontrado. Ele foi excluído ou ainda está sendo compilado.
NotFound	OperationNotFound	A operação solicitada não foi encontrada. O identificador é inválido ou a operação pode ter expirado.