Foutenhandleiding v4.0, v3.1 en v3.0

Document Intelligence maakt gebruik van een geïntegreerd ontwerp om alle fouten weer te geven die zijn opgetreden in de REST API's. Wanneer een API-bewerking een 4xx- of 5xx-statuscode retourneert, wordt als volgt aanvullende informatie over de fout geretourneerd in de antwoord-JSON-hoofdtekst:

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

Voor langlopende bewerkingen waarbij meerdere fouten optreden, wordt de foutcode op het hoogste niveau ingesteld op de ernstigste fout, waarbij de afzonderlijke fouten worden vermeld onder de eigenschap error.details . In dergelijke scenario's geeft de doeleigenschap van elke afzonderlijke fout de trigger van de fout op.

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

De eigenschap error.code op het hoogste niveau kan een van de volgende foutberichten zijn:

Foutcode	Bericht	Http-status
InvalidRequest	Ongeldige aanvraag.	400
InvalidArgument	Ongeldig argument.	400
Verboden	Toegang verboden vanwege beleid of andere configuratie.	403
NotFound	Resource niet gevonden.	404
MethodNotAllowed	De aangevraagde HTTP-methode is niet toegestaan.	405
Conflict	De aanvraag kan niet worden voltooid vanwege een conflict.	409
Niet-ondersteundMediaType	Het inhoudstype Aanvraag wordt niet ondersteund.	415
InternalServerError	Er is een onverwachte fout opgetreden.	500
ServiceUnavailable	Er is een tijdelijke fout opgetreden. Probeer het opnieuw.	503

Indien mogelijk worden er meer details opgegeven in de interne fouteigenschap .

Belangrijkste foutcode	Interne foutcode	Bericht
Conflict	ModelExists	Er bestaat al een model met de opgegeven naam.
Verboden	AuthorizationFailed	Autorisatie is mislukt: {details}
Verboden	InvalidDataProtectionKey	De sleutel voor gegevensbeveiliging is ongeldig: {details}
Verboden	UitgaandeAccessForbidden	De aanvraag bevat een niet-toegestane domeinnaam of schendt het huidige toegangsbeheerbeleid.
InternalServerError	Onbekend	Onbekende fout.
InvalidArgument	InvalidContentSourceFormat	Ongeldige inhoudsbron: {details}
InvalidArgument	InvalidParameter	De parameter {parameterName} is ongeldig: {details}
InvalidArgument	InvalidParameterLength	De lengte van de parameter {parameterName} mag niet langer zijn dan {maxChars}-tekens.
InvalidArgument	InvalidSasToken	De Shared Access Signature (SAS) is ongeldig: {details}
InvalidArgument	ParameterMissing	De parameter {parameterName} is vereist.
InvalidRequest	ContentSourceNotAccessible	Inhoud is niet toegankelijk: {details}
InvalidRequest	ContentSourceTimeout	Time-out tijdens het ontvangen van het bestand van de client.
InvalidRequest	DocumentModelLimit	Account kan niet meer dan {maximumModels}-modellen maken.
InvalidRequest	DocumentModelLimitNeural	Account kan niet meer dan 10 aangepaste neurale modellen per maand maken. Neem contact op met de ondersteuning om meer capaciteit aan te vragen.
InvalidRequest	DocumentModelLimitComposed	Account kan geen model maken met meer dan {details}-onderdeelmodellen.
InvalidRequest	InvalidContent	Het bestand is beschadigd of de indeling wordt niet ondersteund. Raadpleeg de documentatie voor de lijst met ondersteunde indelingen.
InvalidRequest	InvalidContentDimensions	De afmetingen van de invoerafbeelding vallen buiten het bereik. Raadpleeg de documentatie voor ondersteunde afbeeldingsdimensies.
InvalidRequest	InvalidContentLength	De invoerafbeelding is te groot. Raadpleeg de documentatie voor de maximale bestandsgrootte.
InvalidRequest	InvalidFieldsDefinition	Ongeldige velden: {details}
InvalidRequest	InvalidTrainingContentLength	Trainingsinhoud bevat {bytes} bytes. Training is beperkt tot {maxBytes} bytes.
InvalidRequest	InvalidTrainingContentPageCount	Trainingsinhoud bevat {pages}-pagina's. Training is beperkt tot {pages}-pagina's.
InvalidRequest	ModelAnalyzeError	Kan niet analyseren met behulp van een aangepast model: {details}
InvalidRequest	ModelBuildError	Kan het model niet bouwen: {details}
InvalidRequest	ModelComposeError	Kan het model niet opstellen: {details}
InvalidRequest	ModelNotReady	Het model is niet gereed voor de aangevraagde bewerking. Wacht tot de training is voltooid of controleer op bewerkingsfouten.
InvalidRequest	ModelReadOnly	Het aangevraagde model heeft het kenmerk Alleen-lezen.
InvalidRequest	NotSupportedApiVersion	Voor de aangevraagde bewerking is {minimumApiVersion} of hoger vereist.
InvalidRequest	OperationNotCancellable	De bewerking kan niet meer worden geannuleerd.
InvalidRequest	TrainingContentMissing	Trainingsgegevens ontbreken: {details}
InvalidRequest	Niet-ondersteunde inhoud	Inhoud wordt niet ondersteund: {details}
NotFound	ModelNotFound	Het aangevraagde model is niet gevonden. Het wordt verwijderd of wordt nog steeds gebouwd.
NotFound	OperationNotFound	De aangevraagde bewerking is niet gevonden. De id is ongeldig of de bewerking is verlopen.