Przewodnik po błędach w wersji 4.0, 3.1 i 3.0

Analiza dokumentów używa ujednoliconego projektu do reprezentowania wszystkich błędów napotkanych w interfejsach API REST. Za każdym razem, gdy operacja interfejsu API zwraca kod stanu 4xx lub 5xx, dodatkowe informacje o błędzie są zwracane w treści odpowiedzi JSON w następujący sposób:

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

W przypadku długotrwałych operacji, w których napotkano wiele błędów, kod błędu najwyższego poziomu jest ustawiony na najbardziej poważny błąd z pojedynczymi błędami wymienionymi we właściwości error.details . W takich scenariuszach właściwość docelowa każdego pojedynczego błędu określa wyzwalacz błędu.

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

Właściwość error.code najwyższego poziomu może być jednym z następujących komunikatów kodu błędu:

Kod błędu	Komunikat	Stan http
InvalidRequest	Nieprawidłowa prośba.	400
InvalidArgument	Nieprawidłowy argument.	400
Dostęp zabroniony	Dostęp zabroniony ze względu na zasady lub inną konfigurację.	403
Nie znaleziono	Nie znaleziono zasobu.	404
MethodNotAllowed	Żądana metoda HTTP nie jest dozwolona.	405
Konflikt	Nie można ukończyć żądania z powodu konfliktu.	409
Nieobsługiwany typMediaType	Typ zawartości żądania nie jest obsługiwany.	415
InternalServerError	Wystąpił nieoczekiwany błąd.	500
ServiceUnavailable	Wystąpił błąd przejściowy. Spróbuj ponownie.	503

Jeśli to możliwe, więcej szczegółów jest określonych we właściwości błędu wewnętrznego.

Kod błędu najwyższego poziomu	Kod błędu wewnętrznego	Komunikat
Konflikt	ModelExists	Model o podanej nazwie już istnieje.
Dostęp zabroniony	AuthorizationFailed	Autoryzacja nie powiodła się: {details}
Dostęp zabroniony	InvalidDataProtectionKey	Klucz ochrony danych jest nieprawidłowy: {details}
Dostęp zabroniony	OutboundAccessForbidden	Żądanie zawiera niedozwoloną nazwę domeny lub narusza bieżące zasady kontroli dostępu.
InternalServerError	Nieznane	Nieznany błąd.
InvalidArgument	InvalidContentSourceFormat	Nieprawidłowe źródło zawartości: {details}
InvalidArgument	InvalidParameter	Parametr {parameterName} jest nieprawidłowy: {details}
InvalidArgument	InvalidParameterLength	Długość parametru {parameterName} nie może przekraczać {maxChars}znaków.
InvalidArgument	InvalidSasToken	Sygnatura dostępu współdzielonego (SAS) jest nieprawidłowa: {details}
InvalidArgument	ParametrMissing	Parametr {parameterName} jest wymagany.
InvalidRequest	ContentSourceNotAccessible	Zawartość nie jest dostępna: {details}
InvalidRequest	ContentSourceTimeout	Limit czasu podczas odbierania pliku od klienta.
InvalidRequest	DocumentModelLimit	Konto nie może utworzyć więcej niż {maximumModels} modeli.
InvalidRequest	DocumentModelLimitNeural	Konto nie może tworzyć więcej niż 10 niestandardowych modeli neuronowych miesięcznie. Skontaktuj się z pomocą techniczną, aby zażądać większej pojemności.
InvalidRequest	DocumentModelLimitComposed	Konto nie może utworzyć modelu z więcej niż {details} modelami składników.
InvalidRequest	InvalidContent	Plik jest uszkodzony lub format jest nieobsługiwany. Zapoznaj się z dokumentacją, aby uzyskać listę obsługiwanych formatów.
InvalidRequest	InvalidContentDimensions	Wymiary obrazu wejściowego są poza zakresem. Zapoznaj się z dokumentacją dotyczącą obsługiwanych wymiarów obrazów.
InvalidRequest	InvalidContentLength	Obraz wejściowy jest za duży. Zapoznaj się z dokumentacją dotyczącą maksymalnego rozmiaru pliku.
InvalidRequest	InvalidFieldsDefinition	Nieprawidłowe pola: {details}
InvalidRequest	InvalidTrainingContentLength	Zawartość szkoleniowa zawiera {bajty} bajtów. Trenowanie jest ograniczone do {maxBytes} bajtów.
InvalidRequest	InvalidTrainingContentPageCount	Zawartość szkoleniowa zawiera strony {pages}. Trenowanie jest ograniczone do stron {pages}.
InvalidRequest	ModelAnalyzeError	Nie można przeanalizować przy użyciu modelu niestandardowego: {details}
InvalidRequest	ModelBuildError	Nie można skompilować modelu: {details}
InvalidRequest	ModelComposeError	Nie można utworzyć modelu: {details}
InvalidRequest	ModelNotReady	Model nie jest gotowy do żądanej operacji. Poczekaj na ukończenie trenowania lub sprawdź błędy operacji.
InvalidRequest	ModelReadOnly	Żądany model jest tylko do odczytu.
InvalidRequest	NotSupportedApiVersion	Żądana operacja wymaga {minimumApiVersion} lub nowszej.
InvalidRequest	OperationNotCancellable	Nie można już anulować operacji.
InvalidRequest	TrainingContentMissing	Brak danych szkoleniowych: {details}
InvalidRequest	Nieobsługiwanecontent	Zawartość nie jest obsługiwana: {details}
Nie znaleziono	ModelNotFound	Nie można odnaleźć żądanego modelu. Został usunięty lub nadal budowany.
Nie znaleziono	OperationNotFound	Żądana operacja nie została znaleziona. Identyfikator jest nieprawidłowy lub operacja wygasła.