Abbrechen der Übersetzung
Referenzfeature: Azure AI Translator → Dokumentübersetzungs-API-Version
: 2024-05-01
HTTP-Methode: DELETE
- Diese Methode bricht einen Übersetzungsauftrag ab, der zurzeit verarbeitet oder in die Warteschlange gestellt wird (ausstehend), wie in der Anforderung durch den
id
Abfrageparameter angegeben. - Ein Vorgang wird nicht abgebrochen, wenn bereits abgeschlossen, fehlgeschlagen oder noch abgebrochen wird. In diesen Fällen wird eine ungültige Anforderung zurückgegeben.
- Abgeschlossene Übersetzungen können nicht storniert werden und werden in Rechnung gestellt.
Anforderungs-URL
Wichtig
Für alle API-Anforderungen an das Feature „Dokumentübersetzung“ ist ein benutzerdefinierter Domänenendpunkt erforderlich, der sich auf der Seite „Ressourcenübersicht“ im Azure-Portal befindet.
curl -i -X DELETE "{document-translation-endpoint}/translator/document/batches/{id}?api-version={date}"
Anforderungsparameter
Die folgenden Anforderungsparameter werden in der Abfragezeichenfolge übergeben:
Query parameter (Abfrageparameter) | Erforderlich | BESCHREIBUNG |
---|---|---|
id |
True | Vorgangs-ID |
Ermitteln des Werts für id
Sie finden die Auftrags-id
im URL-Wert Operation-Location
des Antwortheaders der POST-Methode start-batch-translation
. Die alphanumerische Zeichenfolge nach dem /document/
Parameter ist die Auftrags-id
des Vorgangs:
Antwortheader | Antwort-URL |
---|---|
Operation-Location | {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec ?api-version=2024-05-01 |
- Sie können auch eine get-translation-status-Anforderung verwenden, um eine Liste der Übersetzungsaufträge und deren
id
s abzurufen.
Anforderungsheader
Anforderungsheader:
Header | BESCHREIBUNG |
---|---|
Ocp-Apim-Subscription-Key | Erforderlicher Anforderungsheader |
Antwortstatuscodes
Im Folgenden finden Sie die möglichen HTTP-Statuscodes, die eine Anforderung zurückgeben kann.
Statuscode | BESCHREIBUNG |
---|---|
200 | OK. Absenk der übermittelten Anforderung |
401 | Nicht autorisiert. Anmeldeinformationen prüfen. |
404 | Nicht gefunden: Die Ressource wurde nicht gefunden. |
500 | Interner Serverfehler. |
Andere Statuscodes | • Zu viele Anforderungen • Temporärer Server nicht verfügbar |
„Abbrechen der Übersetzung“-Antwort
Erfolgreiche Antwort
Die folgenden Informationen werden bei erfolgreicher Antwort zurückgegeben.
Name | Typ | Beschreibung |
---|---|---|
id |
string | ID des Vorgangs. |
createdDateTimeUtc | Zeichenfolge | Das Datum und die Uhrzeit des Vorgangs. |
lastActionDateTimeUtc | Zeichenfolge | Datumszeit, zu der der Status des Vorgangs aktualisiert wird. |
status | String | Liste der möglichen Status für Auftrag oder Dokument: • Abgebrochen •Abblasend •Misslungen • NotStarted •Ausgeführte •Gelungen • ValidationFailed |
Zusammenfassung | StatusSummary | Zusammenfassung mit einer Liste der Details. |
summary.total | integer | Gesamtanzahl der Dokumente. |
summary.failed | integer | Anzahl der Dokumente mit Fehlern. |
summary.success | integer | Anzahl der Dokumente, die erfolgreich übersetzt wurden. |
summary.inProgress | integer | Zählung der Dokumente in Bearbeitung. |
summary.notYetStarted | integer | Anzahl von Dokumenten, die noch nicht in Bearbeitung sind. |
summary.cancelled | integer | Anzahl der abgebrochenen. |
summary.totalCharacterCharged | integer | Zeichen, die von der API abgerechnet werden. |
Fehlerantwort
Name | Typ | BESCHREIBUNG |
---|---|---|
code | Zeichenfolge | Enumerationen, die High-Level-Fehlercodes enthalten. Mögliche Werte: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Unbefugt |
message | Zeichenfolge | Ruft High-Level-Fehlermeldung ab. |
target | Zeichenfolge | Ruft die Ursache des Fehlers ab. Dies wäre z. B. „Dokumente“ oder im Falle eines ungültigen Dokuments die document id . |
innerError | InnerTranslationError | Neues Format für innere Fehler, das den Richtlinien der Azure KI Services-API entspricht. Diese Fehlermeldung enthält die erforderlichen Eigenschaften „ErrorCode“ und „message“ sowie die optionalen Eigenschaften „target“, „details“ (Schlüssel-Wert-Paar) und „inner error“ (kann geschachtelt werden). |
innerError.code | Zeichenfolge | Ruft Code der Fehlerzeichenfolge ab. |
innerError.message | Zeichenfolge | Ruft High-Level-Fehlermeldung ab. |
innerError.target | Zeichenfolge | Ruft die Ursache des Fehlers ab. Würde im Fall eines ungültigen Dokuments z. B. documents oder document id lauten. |
Beispiele
Beispiel für erfolgreiche Antwort
Das folgende JSON-Objekt ist ein Beispiel für eine erfolgreiche Antwort.
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
}
}
Beispiel für Fehlerantwort
Das folgende JSON-Objekt ist ein Beispiel für eine Fehlerantwort. Das Schema für andere Fehlercodes ist identisch.
Statuscode: 500
{
"error": {
"code": "InternalServerError",
"message": "Internal Server Error",
"target": "Operation",
"innerError": {
"code": "InternalServerError",
"message": "Unexpected internal server error has occurred"
}
}
}
Nächste Schritte
Befolgen Sie unsere Schnellstartanleitung, um mehr über die Verwendung der Dokumentübersetzung und der Clientbibliothek zu erfahren.