Guide d’erreur v4.0, v3.1 et v3.0

Intelligence documentaire utilise une conception unifiée pour représenter toutes les erreurs rencontrées dans les API REST. Chaque fois qu’une opération d’API renvoie un code d’état 4xx ou 5xx, des informations supplémentaires sur l’erreur sont retournées dans le corps JSON de la réponse comme suit :

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

Pour les opérations longues où plusieurs erreurs sont rencontrées, le code d’erreur de niveau supérieur est défini sur l’erreur la plus grave, et les erreurs individuelles sont listées sous la propriété error.details. Dans de tels scénarios, la propriété target de chaque erreur individuelle spécifie le déclencheur de l’erreur.

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

La propriété error.code de niveau supérieur peut être l’un des messages de code d’erreur suivants :

Code d'erreur	Message	État HTTP
InvalidRequest	Demande non valide.	400
InvalidArgument	Argument non valide.	400
Interdit	Accès interdit en raison d’une stratégie ou d’une autre configuration.	403
NotFound	La ressource est introuvable.	404
MethodNotAllowed	La méthode HTTP demandée n’est pas autorisée.	405
Conflit	La requête n’a pas pu aboutir en raison d’un conflit.	409
UnsupportedMediaType	Le type de contenu de la requête n’est pas pris en charge.	415
InternalServerError	Une erreur inattendue s’est produite.	500
ServiceUnavailable	Une erreur temporaire s’est produite. Réessayez.	503

Lorsque cela est possible, des détails supplémentaires sont spécifiés dans la propriété inner error.

Code d’erreur principal	Code d’erreur interne	Message
Conflit	ModelExists	Un modèle de ce nom existe déjà.
Interdit	AuthorizationFailed	Échec de l’autorisation : {details}
Interdit	InvalidDataProtectionKey	La clé de protection des données est incorrecte : {details}
Interdit	OutboundAccessForbidden	La requête contient un nom de domaine non autorisé ou viole la stratégie de contrôle d’accès actuelle.
InternalServerError	Unknown	Erreur inconnue.
InvalidArgument	InvalidContentSourceFormat	La source de contenu est incorrecte : {details}
InvalidArgument	InvalidParameter	Le paramètre {parameterName} est incorrect : {details}
InvalidArgument	InvalidParameterLength	La longueur du paramètre {parameterName} ne doit pas dépasser {maxChars} caractères.
InvalidArgument	InvalidSasToken	La signature d’accès partagé est incorrecte : {details}
InvalidArgument	ParameterMissing	Le paramètre {parameterName} est requis.
InvalidRequest	ContentSourceNotAccessible	Le contenu n’est pas accessible : {details}
InvalidRequest	ContentSourceTimeout	Délai d’expiration lors de la réception du fichier du client.
InvalidRequest	DocumentModelLimit	Le compte ne peut pas créer plus de {maximumModels} modèles.
InvalidRequest	DocumentModelLimitNeural	Le compte ne peut pas créer plus de 10 modèles neuraux personnalisés par mois. Contactez le support pour demander plus de capacité.
InvalidRequest	DocumentModelLimitComposed	Le compte ne peut pas créer un modèle avec plus de {details} modèles de composant.
InvalidRequest	InvalidContent	Le fichier est endommagé ou le format n’est pas pris en charge. Reportez-vous à la documentation pour consulter la liste des formats pris en charge.
InvalidRequest	InvalidContentDimensions	Les dimensions de l’image d’entrée sont hors limites. Reportez-vous à la documentation pour consulter les dimensions d’image prises en charge.
InvalidRequest	InvalidContentLength	L’image d’entrée est trop grande. Reportez-vous à la documentation pour consulter la taille de fichier maximale.
InvalidRequest	InvalidFieldsDefinition	Champs incorrects : {details}
InvalidRequest	InvalidTrainingContentLength	Le contenu d’entraînement contient {bytes} octets. L’entraînement est limité à {maxBytes} octets.
InvalidRequest	InvalidTrainingContentPageCount	Le contenu d’entraînement contient {pages} pages. L’entraînement est limité à {pages} pages.
InvalidRequest	ModelAnalyzeError	Impossible d’analyser à l’aide d’un modèle personnalisé : {details}
InvalidRequest	ModelBuildError	Impossible de générer le modèle : {details}
InvalidRequest	ModelComposeError	Impossible de composer le modèle : {details}
InvalidRequest	ModelNotReady	Le modèle n’est pas prêt pour l’opération demandée. Attendez la fin de l’entraînement ou recherchez des erreurs d’opération.
InvalidRequest	ModelReadOnly	Le modèle demandé est en lecture seule.
InvalidRequest	NotSupportedApiVersion	L’opération demandée requiert {minimumApiVersion} ou une version ultérieure.
InvalidRequest	OperationNotCancellable	L’opération ne peut plus être annulée.
InvalidRequest	TrainingContentMissing	Les données d’entraînement sont manquantes : {details}
InvalidRequest	UnsupportedContent	Le contenu n’est pas pris en charge : {details}
NotFound	ModelNotFound	Le modèle demandé est introuvable. Il a été supprimé ou est toujours en cours de génération.
NotFound	OperationNotFound	L’opération demandée est introuvable. L’identificateur est invalide ou l’opération a expiré.