Abrufen des Status für alle Dokumente

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

• Verwenden Sie die get documents status Methode, um den Status für alle Dokumente in einem Übersetzungsauftrag anzufordern.

• Die Abfrageparameter $top, $skip und $maxpagesize können verwendet werden, um die Ergebnisse, die zurückgegeben werden sollen, und einen Offset für die Sammlung anzugeben.

  • Mit $top wird die Gesamtzahl der Datensätze angegeben, die auf Wunsch der Benutzer*innen auf allen Seiten zurückgegeben werden sollen.
  • Mit $skip wird die Anzahl der Datensätze angegeben, die in der Liste der Dokumentstatusangaben übersprungen werden sollen, die vom Server basierend auf der angegebenen Sortiermethode bereitgestellt wird. Standardmäßig werden Datensätze nach absteigender Startzeit sortiert.
  • Mit $maxpagesize wird die maximale Anzahl der Elemente angegeben, die auf einer Seite zurückgegeben werden.
  • Wenn über $top weitere Elemente angefordert werden oder $top nicht angegeben ist und weitere Elemente zurückgegeben werden sollen, enthält @nextLink den Link zur nächsten Seite.
  • Wenn die Anzahl der Dokumente in der Antwort das Paging-Limit überschreitet, wird serverseitiges Paging verwendet.
  • Paging-Antworten geben ein Teilergebnis an und enthalten ein Fortsetzungstoken in der Antwort. Das Fehlen eines Fortsetzungstokens bedeutet, dass keine weiteren Seiten verfügbar sind.

• $orderBy Der Abfrageparameter kann verwendet werden, um die zurückgegebene Liste (z $orderBy=createdDateTimeUtc asc . B. oder $orderBy=createdDateTimeUtc desc) zu sortieren.
• Die Standardsortierung ist absteigend nach createdDateTimeUtc. Einige Abfrageparameter können verwendet werden, um die zurückgegebene Liste (z. B. status=Succeeded,Cancelled) nur erfolgreiche und abgebrochene Dokumente zurückzugeben.
• Die createdDateTimeUtcStart Parameter und createdDateTimeUtcEnd Abfrageparameter können kombiniert oder separat verwendet werden, um einen Datumsbereich anzugeben, um die zurückgegebene Liste zu filtern.
• Die unterstützten Filterabfrageparameter sind (status, id, und createdDateTimeUtcStartcreatedDateTimeUtcEnd).
• Wenn sowohl $top als auch $skip enthalten sind, sollte der Server zuerst $skip und dann $top auf die Sammlung anwenden.

Anfrage-URL

Sendet eine GET-Anforderung an:

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

Ermitteln des Werts für id

• Sie finden die Auftrags-id im URL-Wert start-batch-translation des Antwortheaders der POST-Methode Operation-Location. Die alphanumerische Zeichenfolge nach dem /document/ Parameter ist die Auftrags-id des Vorgangs:

• Sie können auch eine get-translation-status-Anforderung verwenden, um eine Liste der Übersetzungsaufträge und deren ids abzurufen.

Anforderungsparameter

Die folgenden Anforderungsparameter werden in der Abfragezeichenfolge übergeben:

Anforderungsheader

Anforderungsheader:

Antwortstatuscodes

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

„Abrufen des Dokumentstatus“-Antwort

Erfolgreiche „Abrufen des Dokumentstatus“-Antwort

Die folgenden Informationen werden bei erfolgreicher Antwort zurückgegeben.

Fehlerantwort

Beispiele

Beispiel für erfolgreiche Antwort

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

{
  "value": [
    {
      "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
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15"
}

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

Folgen Sie unserer Schnellstartanleitung, um mehr über die Verwendung der Dokumentübersetzung und der Clientbibliothek zu erfahren.