Avbryt översättning

  • Artikel

Referenstjänst
: Azure AI Document Translation
API-version: v1.1

Avbryt en aktuell bearbetnings- eller köåtgärd. En åtgärd avbryts inte om den har slutförts, misslyckats eller avbrutits. En felaktig begäran returneras. Slutförda översättningar avbryts inte och debiteras. Alla väntande översättningar avbryts om möjligt.

Begärans-URL

Skicka en DELETE-begäran till:

https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}

Lär dig hur du hittar ditt anpassade domännamn.

Viktigt!

  • Alla API-begäranden till dokumentöversättningstjänsten kräver en anpassad domänslutpunkt.
  • Du kan inte använda slutpunkten som finns på azure-portalens resursnycklar och slutpunktssida eller den globala translator-slutpunkten –api.cognitive.microsofttranslator.com för att göra HTTP-begäranden till dokumentöversättning.

Parametrar för begäran

Begärandeparametrar som skickas på frågesträngen är:

Frågeparameter Obligatoriskt Beskrivning
id Sant Åtgärds-ID.

Begärandehuvuden

Begärandehuvuden är:

Sidhuvuden beskrivning
Ocp-Apim-Subscription-Key Obligatoriskt begärandehuvud

Svarsstatuskoder

Följande är de möjliga HTTP-statuskoder som en begäran returnerar.

Statuskod beskrivning
200 OK. Avbryt begäran som skickats
401 Behörighet saknas. Kontrollera dina autentiseringsuppgifter.
404 Hittades inte. Det går inte att hitta resursen.
500 Internt serverfel.
Andra statuskoder • För många förfrågningar
• Servern är tillfälligt otillgänglig

Avbryt översättningssvar

Lyckat svar

Följande information returneras i ett lyckat svar.

Namn Type Description
id sträng ID för åtgärden.
createdDateTimeUtc sträng Åtgärden skapade datumtid.
lastActionDateTimeUtc sträng Datum då åtgärdens status uppdateras.
status String Lista över möjliga statusar för jobb eller dokument: • Avbröts
•Avbryta
•Misslyckades
• Ej startad
•Kör
•Lyckades
• ValidationFailed
Sammanfattning StatusSumma Sammanfattning som innehåller en lista med information.
summary.total integer Antal dokument totalt.
summary.failed integer Antalet dokument misslyckades.
summary.success integer Antal dokument som har översatts.
summary.inProgress integer Antal dokument som pågår.
summary.notYetStarted integer Antalet dokument som ännu inte har börjat bearbetas.
summary.cancelled integer Antal avbrutna.
summary.totalCharacterCharged integer Totalt antal tecken som debiteras av API:et.

Felsvar

Namn Type Beskrivning
kod sträng Uppräkningar som innehåller felkoder på hög nivå. Möjliga värden:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Obehörig
meddelande sträng Hämtar felmeddelande på hög nivå.
mål sträng Hämtar källan till felet. Det skulle till exempel vara "dokument" eller document id för ett ogiltigt dokument.
innerError InnerTranslationError Nytt format för inre fel som överensstämmer med API-riktlinjerna för Azure AI-tjänster. Det här felmeddelandet innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper, information (nyckelvärdespar), inre fel (det kan kapslas).
innerError.code sträng Hämtar kodfelsträngen.
innerError.message sträng Hämtar felmeddelande på hög nivå.
innerError.target sträng Hämtar källan till felet. Det skulle till exempel vara documents eller document id om det fanns ett ogiltigt dokument.

Exempel

Exempel på lyckat svar

Följande JSON-objekt är ett exempel på ett lyckat svar.

Statuskod: 200

{
  "id": "727bf148-f327-47a0-9481-abae6362f11e",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Succeeded",
  "summary": {
    "total": 10,
    "failed": 1,
    "success": 9,
    "inProgress": 0,
    "notYetStarted": 0,
    "cancelled": 0,
    "totalCharacterCharged": 0
  }
}

Exempel på felsvar

Följande JSON-objekt är ett exempel på ett felsvar. Schemat för andra felkoder är detsamma.

Statuskod: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Nästa steg

Följ vår snabbstart om du vill veta mer om hur du använder dokumentöversättning och klientbiblioteket.

Kom igång med dokumentöversättning