Abbrechen der Übersetzung

Referenz
Dienst: Azure KI-Dokumentübersetzung
API-Version: v1.1

Brechen Sie den derzeit ausgeführten oder einen in die Warteschlange eingereihten Auftrag ab. Ein Vorgang wird nicht abgebrochen, wenn abgeschlossen, fehlgeschlagen oder abgebrochen wird. Es wird eine Meldung vom Typ „Ungültige Anforderung“ zurückgegeben. Abgeschlossene Übersetzungen werden nicht storniert und berechnet. Alle ausstehenden Übersetzungen werden nach Möglichkeit abgebrochen.

Anfrage-URL

Sendet eine DELETE-Anforderung an:

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

Erfahren Sie, wie Sie Ihren benutzerdefinierten Domänennamenfinden.

Wichtig

• Für alle API-Anforderungen an den Dienst für die Dokumentübersetzung muss ein Endpunkt einer benutzerdefinierten Domäne verwendet werden.
• Zum Senden von HTTP-Anforderungen für die Dokumentübersetzung verwenden Sie nicht den Endpunkt, der im Azure-Portal auf der Ressourcenseite Schlüssel und Endpunkt angegeben ist, und auch nicht den globalen Übersetzungsendpunkt api.cognitive.microsofttranslator.com.

Anforderungsparameter

Die folgenden Anforderungsparameter werden in der Abfragezeichenfolge übergeben:

Query parameter (Abfrageparameter)	Erforderlich	BESCHREIBUNG
id	True	Vorgangs-ID

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 •Stornieren •Fehlgeschlagen • 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 •Unbefugte
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.

Erste Schritte bei der Dokumentübersetzung