Guida agli errori v4.0, v3.1 e v3.0

Informazioni sui documenti usa un approccio unificato per rappresentare tutti gli errori rilevati nelle API REST. Ogni volta che un'operazione API restituisce un codice di stato 4xx o 5xx, nel corpo JSON della risposta vengono restituite informazioni aggiuntive sull'errore come indicato di seguito:

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

Per le operazioni a esecuzione prolungata in cui possono verificarsi più errori, il codice errore di primo livello viene impostato come l’errore più grave ed i singoli errori sono elencati nella proprietà error.details. In questi scenari la proprietà target di ogni singolo errore specifica il trigger dell'errore.

{
    "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 proprietà error.code di primo livello può essere uno dei messaggi di codice errore seguenti:

Codice di errore	Message	Stato HTTP
InvalidRequest	Richiesta non valida.	400
InvalidArgument	Argomento non valido.	400
Non consentito	Accesso negato a causa di criteri o altre configurazioni.	403
NotFound	La risorsa non è stata trovata.	404
MethodNotAllowed	Non è consentito l’uso del metodo HTTP.	405
Conflitto	Non è stato possibile completare la richiesta a causa di un conflitto.	409
UnsupportedMediaType	Il tipo di contenuto della richiesta non è supportato.	415
InternalServerError	Errore imprevisto.	500
ServiceUnavailable	Si è verificato un errore temporaneo. Riprovare.	503

Quando possibile, nella proprietà inner error vengono specificati altri dettagli.

Codice errore principale	Codice errore interno	Message
Conflitto	ModelExists	Esiste già un modello con il nome specificato.
Non consentito	AuthorizationFailed	Autorizzazione non riuscita: {details}
Non consentito	InvalidDataProtectionKey	Chiave di protezione dati non valida: {details}
Non consentito	OutboundAccessForbidden	La richiesta contiene un nome di dominio non consentito o viola i criteri di controllo di accesso correnti.
InternalServerError	Sconosciuto	Errore sconosciuto.
InvalidArgument	InvalidContentSourceFormat	Origine contenuto non valida: {details}
InvalidArgument	InvalidParameter	Il parametro {parameterName} non è valido: {details}
InvalidArgument	InvalidParameterLength	La lunghezza del parametro {parameterName} non deve superare {maxChars} caratteri.
InvalidArgument	InvalidSasToken	La firma di accesso condiviso (SAS) non è valida: {details}
InvalidArgument	ParameterMissing	Il parametro {parameterName} è obbligatorio.
InvalidRequest	ContentSourceNotAccessible	Il contenuto non è accessibile: {details}
InvalidRequest	ContentSourceTimeout	Timeout durante la ricezione del file dal client.
InvalidRequest	DocumentModelLimit	L'account non può creare più di {maximumModels} modelli.
InvalidRequest	DocumentModelLimitNeural	L'account non può creare più di 10 modelli neurali personalizzati al mese. Contattare il supporto tecnico per richiedere un aumento della capacità.
InvalidRequest	DocumentModelLimitComposed	L'account non può creare un modello con più di {details} modelli di componenti.
InvalidRequest	InvalidContent	Il file è danneggiato o il formato non è supportato. Vedere la documentazione per l'elenco dei formati supportati.
InvalidRequest	InvalidContentDimensions	Le dimensioni dell'immagine di input non sono comprese nell'intervallo. Per le dimensioni dell'immagine supportate, vedere la documentazione.
InvalidRequest	InvalidContentLength	L'immagine di input è troppo grande. Per informazioni sulle dimensioni massime del file, vedere la documentazione.
InvalidRequest	InvalidFieldsDefinition	Campi non validi: {details}
InvalidRequest	InvalidTrainingContentLength	Il contenuto del training contiene {byte} byte. Il training è limitato a {maxBytes} byte.
InvalidRequest	InvalidTrainingContentPageCount	Il contenuto del training contiene {pages} pagine. Il training è limitato a {pages} pagine.
InvalidRequest	ModelAnalyzeError	Non è stato possibile eseguire l'analisi con un modello personalizzato: {details}
InvalidRequest	ModelBuildError	Impossibile compilare il modello: {details}
InvalidRequest	ModelComposeError	Impossibile comporre il modello: {details}
InvalidRequest	ModelNotReady	Il modello non è pronto per l'operazione richiesta. Attendere il completamento del training o verificare la presenza di errori nell'operazione.
InvalidRequest	ModelReadOnly	Il modello richiesto è di sola lettura.
InvalidRequest	NotSupportedApiVersion	L'operazione richiesta richiede {minimumApiVersion} o una versione successiva.
InvalidRequest	OperationNotCancellable	L'operazione non può più essere annullata.
InvalidRequest	TrainingContentMissing	Dati di training mancanti: {details}
InvalidRequest	UnsupportedContent	Il contenuto non è supportato: {details}
NotFound	ModelNotFound	Il modello richiesto non è stato trovato. È stato eliminato o è ancora in fase di compilazione.
NotFound	OperationNotFound	L'operazione richiesta non è stata trovata. L'identificatore non è valido o l'operazione è scaduta.