Freigeben über

Abrufen des Status für alle Übersetzungsaufträge

  • Artikel

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

  • Verwenden Sie die get translations status Methode, um eine Liste und den Status aller vom Benutzer übermittelten Übersetzungsaufträge anzufordern (die der Ressource zugeordnet sind).

  • 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.

    • $top gibt die Gesamtanzahl der Datensätze an, die auf allen Seiten zurückgegeben werden sollen.
    • Mit $skip wird die Anzahl der Datensätze angegeben, die aus der Liste der Batches basierend auf der angegebenen Sortiermethode übersprungen werden sollen. 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.
    • Der Server berücksichtigt die Werte, die vom Client angegeben werden. Allerdings müssen Clients darauf vorbereitet sein, Antworten zu verarbeiten, die eine andere Seitengröße enthalten oder ein Fortsetzungstoken enthalten.
    • Wenn beide und $skip $top enthalten sind, wird der Server zuerst angewendet $skip und dann $top auf die Sammlung angewendet.

Hinweis

Wenn der Server $top und/oder $skip nicht berücksichtigt, muss er einen Fehler an den Client zurückgeben, der darüber informiert, anstatt nur die Abfrageoptionen zu ignorieren. Dadurch wird das Risiko verringert, dass der Client Annahmen über die zurückgegebenen Daten vornimmt.

  • $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) zurückgegebene und abgebrochene Vorgänge zu filtern.
    • 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).

Anforderungs-URL

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

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.

Anforderungsparameter

Die folgenden Anforderungsparameter werden in der Abfragezeichenfolge übergeben:

Query parameter (Abfrageparameter) Geben Sie in Erforderlich Type BESCHREIBUNG
$maxpagesize Abfrage False integer int32 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. Clients KÖNNEN servergesteuertes Paging mit einer bestimmten Seitengröße anfordern, indem sie eine $maxpagesize-Einstellung angeben. Der Server SOLLTE diese Einstellung berücksichtigen, wenn die angegebene Seitengröße kleiner als die Standardseitengröße des Servers ist.
$orderBy query False array Die Sortierungsabfrage für die Sammlung, z. B. CreatedDateTimeUtc asc, CreatedDateTimeUtc desc
$skip query False integer int32 Mit $skip wird die Anzahl der Datensätze angegeben, die aus der Liste der übersprungen werden sollen, die vom Server basierend auf der angegebenen Sortiermethode bereitgestellt wird. Standardmäßig wird nach absteigender Startzeit sortiert. Clients KÖNNEN die Abfrageparameter $top und $skip verwenden, um die Anzahl der Ergebnisse, die zurückgegeben werden sollen, und einen Offset für die Sammlung anzugeben. Wenn der Client sowohl $top als auch $skip zurückgibt, SOLLTE der Server zuerst $skip und dann $top auf die Sammlung anwenden. Hinweis: Wenn der Server $top und/oder $skip nicht berücksichtigen kann, MUSS der Server einen Fehler an den Client zurückgeben, der darüber informiert, anstatt nur die Abfrageoptionen zu ignorieren.
$top query False integer int32 Mit $top wird die Gesamtzahl der Datensätze angegeben, die auf Wunsch der Benutzer*innen auf allen Seiten zurückgegeben werden sollen. Clients KÖNNEN die Abfrageparameter $top und $skip verwenden, um die Anzahl der Ergebnisse, die zurückgegeben werden sollen, und einen Offset für die Sammlung anzugeben. Wenn der Client sowohl $top als auch $skip zurückgibt, SOLLTE der Server zuerst $skip und dann $top auf die Sammlung anwenden. Hinweis: Wenn der Server $top und/oder $skip nicht berücksichtigen kann, MUSS der Server einen Fehler an den Client zurückgeben, der darüber informiert, anstatt nur die Abfrageoptionen zu ignorieren.
createdDateTimeUtcEnd query False string Datum/Uhrzeit Der Endzeitpunkt (Datum/Uhrzeit), vor dem Elemente abgerufen werden sollen.
createdDateTimeUtcStart query False string Datum/Uhrzeit Der Startzeitpunkt (Datum/Uhrzeit), nach dem Elemente abgerufen werden sollen.
ids query False array IDs, die beim Filtern verwendet werden.
statuses query False array Statusangaben, die beim Filtern verwendet werden.

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. Die Anforderung wurde erfolgreich ausgeführt, und der Status aller Vorgänge wird zurückgegeben. HeadersRetry-After: integerETag: Zeichenfolge
400 Ungültige Anforderung; Ungültige Anforderung. Eingabeparameter prüfen.
401 Nicht autorisiert. Anmeldeinformationen prüfen.
500 Interner Serverfehler.
Andere Statuscodes • Zu viele Anforderungen
• Temporärer Server nicht verfügbar

„Abrufen des Übersetzungsstatus“-Antwort

Erfolgreiche „Abrufen des Übersetzungsstatus“-Antwort

Die folgenden Informationen werden bei erfolgreicher Antwort zurückgegeben.

Name Typ Beschreibung
@nextLink Zeichenfolge Die URL für die nächste Seite. Null, wenn keine weiteren Seiten verfügbar sind.
Wert TranslationStatus[] TranslationStatus[]-Array
value.id Zeichenfolge ID des Vorgangs.
value.createdDateTimeUtc Zeichenfolge Das Datum und die Uhrzeit des Vorgangs.
value.lastActionDateTimeUtc Zeichenfolge Datumszeit, zu der der Status des Vorgangs aktualisiert wurde.
value.status String Liste möglicher Status für Auftrag oder Dokument:
• Canceled
•Abblasend
•Misslungen
• NotStarted
•Ausgeführte
•Gelungen
• ValidationFailed
value.summary StatusSummary[] Zusammenfassung, die die aufgeführten Details enthält.
value.summary.total integer Gesamtanzahl der Dokumente.
value.summary.failed integer Anzahl der Dokumente mit Fehlern.
value.summary.success integer Anzahl der Dokumente, die erfolgreich übersetzt wurden.
value.summary.inProgress integer Zählung der Dokumente in Bearbeitung.
value.summary.notYetStarted integer Anzahl von Dokumenten, die noch nicht in Bearbeitung sind.
value.summary.cancelled integer Zählung der Dokumente abgebrochen.
value.summary.totalCharacterCharged integer Gesamtanzahl der geladenen Zeichen.

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. Würde im Fall eines ungültigen Dokuments z. B. documents oder document id lauten.
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

Tipp

Mit dieser Methode können Sie den Auftragsparameter id für die Abfragezeichenfolge "get-translation-status " abrufen.

Beispiel für erfolgreiche Antwort

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

{
    "value": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/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

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

Erste Schritte bei der Dokumentübersetzung