Dela via


Felguide v4.0, v3.1 och v3.0

Dokumentinformation använder en enhetlig design för att representera alla fel som påträffas i REST-API:erna. När en API-åtgärd returnerar statuskoden 4xx eller 5xx returneras ytterligare information om felet i svarets JSON-brödtext enligt följande:

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

För långvariga åtgärder där flera fel påträffas anges felkoden på den översta nivån till det allvarligaste felet, med de enskilda felen som anges under egenskapen error.details . I sådana scenarier anger målegenskapen för varje enskilt fel utlösaren för felet.

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

Egenskapen error.code på den översta nivån kan vara ett av följande felmeddelanden:

Felkod Meddelande Http-status
InvalidRequest Ogiltig begäran 400
InvalidArgument Ogiltigt argument. 400
Förbjudet Åtkomst förbjuden på grund av princip eller annan konfiguration. 403
NotFound Det gick inte att hitta resursen. 404
MethodNotAllowed Den begärda HTTP-metoden är inte tillåten. 405
Konflikt Det gick inte att slutföra begäran på grund av en konflikt. 409
MediaType stöds inte Innehållstypen Förfrågning stöds inte. 415
InternalServerError Ett oväntat fel har uppstått. 500
ServiceUnavailable Ett tillfälligt fel uppstod. Försök igen. 503

När det är möjligt anges mer information i den inre felegenskapen.

Kod för toppfel Inre felkod Meddelande
Konflikt ModelExists Det finns redan en modell med det angivna namnet.
Förbjudet AuthorizationFailed Auktoriseringen misslyckades: {details}
Förbjudet InvalidDataProtectionKey Dataskyddsnyckeln är ogiltig: {details}
Förbjudet OutboundAccessForbidden Begäran innehåller ett otillåtet domännamn eller bryter mot den aktuella principen för åtkomstkontroll.
InternalServerError Okänt Ett okänt fel.
InvalidArgument InvalidContentSourceFormat Ogiltig innehållskälla: {details}
InvalidArgument InvalidParameter Parametern {parameterName} är ogiltig: {details}
InvalidArgument InvalidParameterLength Parametern {parameterName} får inte överskrida {maxChars}-tecken.
InvalidArgument InvalidSasToken Signaturen för delad åtkomst (SAS) är ogiltig: {details}
InvalidArgument ParameterMissing Parametern {parameterName} krävs.
InvalidRequest ContentSourceNotAccessible Innehållet är inte tillgängligt: {details}
InvalidRequest ContentSourceTimeout Tidsgräns vid mottagning av filen från klienten.
InvalidRequest DocumentModelLimit Kontot kan inte skapa fler än {maximumModels}-modeller.
InvalidRequest DocumentModelLimitNeural Kontot kan inte skapa fler än 10 anpassade neurala modeller per månad. Kontakta supporten för att begära mer kapacitet.
InvalidRequest DocumentModelLimitComposed Kontot kan inte skapa en modell med fler än {details} komponentmodeller.
InvalidRequest InvalidContent Filen är skadad eller så stöds inte formatet. Se dokumentationen för listan över format som stöds.
InvalidRequest InvalidContentDimensions Indatabildens dimensioner ligger utom räckhåll. Se dokumentationen för bilddimensioner som stöds.
InvalidRequest InvalidContentLength Indatabilden är för stor. Se dokumentationen för den maximala filstorleken.
InvalidRequest InvalidFieldsDefinition Ogiltiga fält: {details}
InvalidRequest InvalidTrainingContentLength Träningsinnehållet innehåller {byte} byte. Träningen är begränsad till {maxBytes}-byte.
InvalidRequest InvalidTrainingContentPageCount Träningsinnehållet innehåller {pages}-sidor. Träningen är begränsad till {pages}-sidor.
InvalidRequest ModelAnalyzeError Det gick inte att analysera med en anpassad modell: {details}
InvalidRequest ModelBuildError Det gick inte att skapa modellen: {details}
InvalidRequest ModelComposeError Det gick inte att skriva modellen: {details}
InvalidRequest ModelNotReady Modellen är inte redo för den begärda åtgärden. Vänta tills träningen har slutförts eller sök efter åtgärdsfel.
InvalidRequest ModelReadOnly Den begärda modellen är skrivskyddad.
InvalidRequest NotSupportedApiVersion Den begärda åtgärden kräver {minimumApiVersion} eller senare.
InvalidRequest OperationNotCancellable Åtgärden kan inte längre avbrytas.
InvalidRequest TrainingContentMissing Träningsdata saknas: {details}
InvalidRequest UnsupportedContent Innehållet stöds inte: {details}
NotFound ModelNotFound Den begärda modellen hittades inte. Den togs bort eller byggdes fortfarande.
NotFound OperationNotFound Den begärda åtgärden hittades inte. Identifieraren är ogiltig eller så har åtgärden upphört att gälla.