Ottenere lo stato per tutti i processi di traduzione

Funzionalità di riferimento
: Azure AI Translator → versione dell'API traduzione
documenti: metodo HTTP 2024-05-01
: GET

• Usare il get translations status metodo per richiedere un elenco e lo stato di tutti i processi di traduzione inviati dall'utente (associato alla risorsa).

• $topI parametri di query , $skipe $maxpagesize possono essere usati per specificare il numero di risultati da restituire e un offset per la raccolta.

  • $top indica il numero totale di record da restituire in tutte le pagine.
  • $skip indica il numero di record da ignorare dall'elenco di batch in base al metodo di ordinamento specificato. Per impostazione predefinita, i record vengono ordinati in base all'ora di inizio decrescente.
  • $maxpagesize è il numero massimo di elementi restituiti in una pagina.
  • Se vengono richiesti più elementi tramite $top (o $top non viene specificato e sono presenti più elementi da restituire), @nextLink conterrà il collegamento alla pagina successiva.
  • Il server rispetta i valori specificati dal client. Tuttavia, i client devono essere preparati a gestire le risposte che contengono dimensioni di pagina diverse o che contengono un token di continuazione.
  • Quando vengono inclusi sia $top che $skip , il server verrà prima applicato $skip e quindi $top nella raccolta.

• $orderBy Il parametro di query può essere usato per ordinare l'elenco restituito (ad esempio, $orderBy=createdDateTimeUtc asc o $orderBy=createdDateTimeUtc desc).
  • L'ordinamento predefinito è decrescente in createdDateTimeUtcbase a . Alcuni parametri di query possono essere usati per filtrare l'elenco restituito (ad esempio: status=Succeeded,Cancelled) restituisce le operazioni riuscite e annullate.
  • I createdDateTimeUtcStart parametri di query e createdDateTimeUtcEnd possono essere usati in combinazione o separatamente per specificare un intervallo di datetime per filtrare l'elenco restituito.
  • I parametri di query di filtro supportati sono (status, id, createdDateTimeUtcStarte createdDateTimeUtcEnd).

Richiesta URL

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

Parametri della richiesta

I parametri della richiesta inviati a una stringa di query sono:

Intestazioni delle richieste

Le intestazioni della richiesta sono le seguenti:

Codici di stato della risposta

Di seguito sono riportati i possibili codici di stato HTTP restituiti da una richiesta.

Ottenere la risposta dello stato delle traduzioni

Risposta di stato di recupero delle traduzioni riuscita

Le informazioni seguenti vengono restituite in una risposta con esito positivo.

Risposta con errore

Esempi

Esempio di risposta riuscita

L'oggetto JSON seguente è un esempio di risposta riuscita.

{
    "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"
}

Esempio di risposta di errore

L'oggetto JSON seguente è un esempio di risposta di errore. Lo schema per altri codici di errore è lo stesso.

Codice di stato: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Passaggi successivi

Seguire la guida introduttiva per altre informazioni sull'uso della traduzione dei documenti e della raccolta client.