Teilen über

Abrufen des Status eines bestimmten Dokuments

  • Artikel

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

Diese Methode gibt den Status für ein bestimmtes Dokument in einem Auftrag zurück, wie in der Anforderung durch die id Parameter und documentId Abfrageparameter angegeben.

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}/documents/{documentId}?api-version={date}"

Anforderungsparameter

Die folgenden Anforderungsparameter werden in der Abfragezeichenfolge übergeben:

Query parameter (Abfrageparameter) Erforderlich BESCHREIBUNG
documentId True Dokument-ID
id True Dem Batch zugewiesene ID.

Auffinden der id Werte documentId

  • Sie finden die Auftrags-id im URL-Wert Operation-Location des Antwortheaders der POST-Methode start-batch-translation. Der letzte Parameter der URL ist die Auftrags-ID ( id ) des Vorgangs:
Antwortheader Ergebnis-URL
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

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. Die Anforderung wurde erfolgreich ausgeführt und vom Dienst akzeptiert. Die Vorgangs Details werden zurückgegeben. Headersretry-after: integeretag: Zeichenfolge
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

Antwort zum Status des Dokuments

Erfolgreiche Antwort zum Get-Dokument Status

Name Typ Beschreibung
path Zeichenfolge Speicherort des Dokuments oder des Ordners.
sourcePath Zeichenfolge Speicherort des Quelldokuments.
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
Bis Zeichenfolge Sprachcode von Zielsprache mit zwei Buchstaben. Weitere Informationen finden Sie in der Liste der Sprachen.
Fortschritt number Der Fortschritt der Übersetzung, falls verfügbar
id Zeichenfolge Dokument-ID.
characterCharged 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.
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.

{
  "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
  "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Running",
  "to": "fr",
  "progress": 0.1,
  "id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
  "characterCharged": 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