Freigeben über

Abrufen des Status für einen bestimmten Übersetzungsauftrag

  • Artikel

Referenzfeature: Azure AI Translator → Version der Dokumentübersetzungs-API
: 2024-05-01
 HTTP-Methode: GET

  • Verwenden Sie die get translation status Methode, um den Status eines bestimmten Übersetzungsauftrags anzufordern. Die Antwort enthält den Gesamtauftragsstatus und den Status für Dokumente, die als Teil dieses Auftrags übersetzt werden.

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 GET "{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 ids abzurufen.

Anforderungsheader

Anforderungsheader:

Header Beschreibung Bedingung
Ocp-Apim-Subscription-Key Ihr Übersetzerdienst-API-Schlüssel aus dem Azure-Portal. Erforderlich
Ocp-Apim-Subscription-Region Die Region, in der Ihre Ressource erstellt wurde. Erforderlich bei Verwendung einer regionalen (geografischen) Ressource wie West-USA.
&aufzählungszeichen.
Content-Type Der Inhaltstyp der Nutzdaten. Die akzeptierten Werte sind application/json oder charset=UTF-8. Erforderlich

Antwortstatuscodes

Im Folgenden finden Sie die möglichen HTTP-Statuscodes, die eine Anforderung zurückgeben kann.

Statuscode BESCHREIBUNG
200 OK. Erfolgreiche Anforderung und gibt den Status des Batchübersetzungsvorgangs zurück. HeadersRetry-After: integerETag: Zeichenfolge
401 Nicht autorisiert. Anmeldeinformationen prüfen.
404 Die Ressource wurde nicht gefunden.
500 Interner Serverfehler.
Andere Statuscodes • Zu viele Anforderungen
• Temporärer Server nicht verfügbar

Antwort auf den Übersetzungsstatus abrufen

Erfolgreiche „Abrufen des Übersetzungsstatus“-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 wurde.
status String Liste der möglichen Status für Auftrag oder Dokument:
• Canceled
•Abblasend
•Misslungen
• NotStarted
•Ausgeführte
•Gelungen
• ValidationFailed
Zusammenfassung StatusSummary Zusammenfassung, die die aufgeführten Details enthält.
summary.total integer Gesamtanzahl.
summary.failed integer Fehlgeschlagene Zählung.
summary.success integer Anzahl der erfolgreichen Ausführungen.
summary.inProgress integer Anzahl der Dokumente in Bearbeitung.
summary.notYetStarted integer Anzahl noch nicht gestartet.
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. documents oder document id im Falle eines ungültigen Dokuments.
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, Meldung und optionale Eigenschaftenziel, Details(Schlüsselwertpaar), inneren Fehler (es 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. Dies wäre z. B. documents oder document id im Falle eines ungültigen Dokuments.

Beispiele

Beispiel für erfolgreiche Antwort

Das folgende JSON-Objekt ist ein Beispiel für eine erfolgreiche Antwort.

{
  "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: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

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