Delen via

Vertaling annuleren

  • Artikel

Referentiefunctie: Azure AI Translator → API-versie van documentomzetting
: 2024-05-01
 HTTP-methode: DELETE

  • Met deze methode wordt een vertaaltaak geannuleerd die momenteel wordt verwerkt of in de wachtrij staat (in behandeling), zoals aangegeven in de aanvraag door de id queryparameter.
  • Een bewerking wordt niet geannuleerd als deze al is voltooid, mislukt of nog steeds wordt geannuleerd. In deze gevallen wordt een ongeldige aanvraag geretourneerd.
  • Voltooide vertalingen kunnen niet worden geannuleerd en worden in rekening gebracht.

Aanvraag-URL

Belangrijk

Voor alle API-aanvragen voor de functie Documentvertaling is een aangepast domeineindpunt vereist dat zich op de overzichtspagina van uw resource in Azure Portal bevindt.

  curl -i -X  DELETE "{document-translation-endpoint}/translator/document/batches/{id}?api-version={date}"

Aanvraagparameters

Aanvraagparameters die worden doorgegeven aan de queryreeks zijn:

Queryparameter Vereist Beschrijving
id Waar De bewerkings-id.

id De waarde zoeken

U vindt de taak id in de URL-waarde van de POST-methode-antwoordheader start-batch-translation Operation-Location . De alfanumerieke tekenreeks na de /document/ parameter is de taak idvan de bewerking:

Antwoordheader Antwoord-URL
Operation-Location {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

Aanvraagheaders

Aanvraagheaders zijn:

Kopteksten Beschrijving
Ocp-Apim-Subscription-Key Vereiste aanvraagheader

Antwoordstatuscodes

Hier volgen de mogelijke HTTP-statuscodes die een aanvraag retourneert.

Statuscode Beschrijving
200 OK. Verzonden aanvraag annuleren
401 Onbevoegd. Controleer uw referenties.
404 Niet gevonden De resource is niet gevonden.
500 Interne serverfout.
Overige statuscodes • Te veel aanvragen
• Server tijdelijk niet beschikbaar

Antwoord voor vertaling annuleren

Succesvolle respons

De volgende informatie wordt geretourneerd in een geslaagd antwoord.

Name Type Omschrijving
id tekenreeks Id van de bewerking.
createdDateTimeUtc tekenreeks Bewerking gemaakt datum/tijd.
lastActionDateTimeUtc tekenreeks Datum/tijd waarin de status van de bewerking wordt bijgewerkt.
status String Lijst met mogelijke statussen voor taak of document: • Geannuleerd
•Annuleren
•Mislukt
• Niet gestart
•Lopend
•Geslaagd
• Validatiefailed
samenvatting StatusSamenvatting Samenvatting met een lijst met details.
summary.total geheel getal Het aantal totale documenten.
summary.failed geheel getal Het aantal documenten is mislukt.
summary.success geheel getal Het aantal documenten is vertaald.
summary.inProgress geheel getal Het aantal documenten dat wordt uitgevoerd.
summary.notYetStarted geheel getal Het aantal documenten dat nog niet is verwerkt.
summary.cancelled geheel getal Aantal geannuleerd.
summary.totalCharacterCharged geheel getal Totaal aantal tekens dat door de API wordt in rekening gebracht.

Foutrespons

Name Type Description
code tekenreeks Opsommingen met foutcodes op hoog niveau. Mogelijke waarden:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Ongeoorloofd
bericht tekenreeks Hiermee wordt een foutbericht op hoog niveau weergegeven.
doel tekenreeks Hiermee haalt u de bron van de fout op. Dit is bijvoorbeeld 'documenten' of document id voor een ongeldig document.
innerError InnerTranslationError Nieuwe interne foutindeling die voldoet aan api-richtlijnen voor Azure AI-services. Dit foutbericht bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (deze kan worden genest).
innerError.code tekenreeks Hiermee haalt u de codefoutreeks op.
innerError.message tekenreeks Hiermee wordt een foutbericht op hoog niveau weergegeven.
innerError.target tekenreeks Hiermee haalt u de bron van de fout op. Dit kan bijvoorbeeld het zijn documents of document id als er een ongeldig document is.

Voorbeelden

Voorbeeld van geslaagde reactie

Het volgende JSON-object is een voorbeeld van een geslaagd antwoord.

Statuscode: 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
  }
}

Voorbeeld van een foutbericht

Het volgende JSON-object is een voorbeeld van een foutreactie. Het schema voor andere foutcodes is hetzelfde.

Statuscode: 500

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

Volgende stappen

Volg onze quickstart voor meer informatie over het gebruik van documentomzetting en de clientbibliotheek.

Aan de slag met de documentvertaling