Ottenere lo stato per un processo di traduzione specifico

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

• Usare il get translation status metodo per richiedere lo stato di un processo di traduzione specifico. La risposta include lo stato complessivo del processo e lo stato dei documenti che vengono tradotti come parte di tale processo.

Richiesta URL

Importante

Tutte le richieste API alla funzionalità Traduzione documenti richiedono un endpoint di dominio personalizzato che si trova nella pagina di panoramica delle risorse nella portale di Azure.

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

Parametri della richiesta

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

Query parameter (Parametro di query)	Obbligatorio	Descrizione
id	Vero	ID operazione.

Individuazione del valore id

È possibile trovare il processo id nel valore DELL'URL dell'intestazione Operation-Location della risposta del metodo POSTstart-batch-translation. La stringa alfanumerica che segue il /document/ parametro è il processo iddell'operazione :

Intestazione di risposta	URL di risposta
Operation-Location	{document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

• È anche possibile usare una richiesta get-translations-status per recuperare un elenco di processi di traduzione e i relativi idprocessi.

Intestazioni delle richieste

Le intestazioni della richiesta sono le seguenti:

Intestazioni	Descrizione	Condizione
Ocp-Apim-Subscription-Key	La chiave API del servizio Traduttore dal portale di Azure.	Richiesto
Ocp-Apim-Subscription-Region	Area in cui è stata creata la risorsa.	• Obbligatorio quando si usa una risorsa regionale (geografica) come Stati Uniti occidentali. &bullet.
Content-Type	Tipo di contenuto del payload. Il valore accettato è application/json o charset=UTF-8.	• Obbligatorio

Codici di stato della risposta

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

Codice di stato	Descrizione
200	OK. Richiesta riuscita e restituisce lo stato dell'operazione di conversione batch. HeadersRetry-After: integerETag: string
401	Non autorizzato. Controllare le credenziali.
404	La risorsa non viene trovata.
500	Errore interno del server.
Altri codici di stato	• Troppe richieste • Server temporaneo non disponibile

Ottenere la risposta dello stato di traduzione

Risposta dello stato della traduzione riuscita

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

Nome	Tipo	Descrzione
id	stringa	ID dell'operazione.
createdDateTimeUtc	string	L'operazione ha creato data e ora.
lastActionDateTimeUtc	string	Data di aggiornamento dello stato dell'operazione.
stato	String	Elenco degli stati possibili per il processo o il documento: • Annullata •Annullamento •Fallito • NotStarted •Corsa •Riuscito • ConvalidaFailed
riepilogo	StatusSummary	Riepilogo contenente i dettagli elencati.
summary.total	integer	Conteggio totale.
summary.failed	integer	Conteggio non riuscito.
summary.success	integer	Numero di operazioni riuscite.
summary.inProgress	integer	Numero di in corso.
summary.notYetStarted	integer	Numero di non ancora avviati.
summary.cancelled	integer	Numero di annullamenti.
summary.totalCharacterCharged	integer	Numero totale di caratteri addebitati dall'API.

Risposta con errore

Nome	Tipo	Descrizione
codice	string	Enumerazioni contenenti codici di errore di alto livello. Valori possibili: • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • Servizio Non disponibile • Non autorizzato
messaggio	string	Ottiene un messaggio di errore di alto livello.
bersaglio	string	Ottiene l'origine dell'errore. Ad esempio, sarebbe documents o document id per un documento non valido.
innerError	InnerTranslationError	Nuovo formato di errore interno conforme alle linee guida dell'API dei servizi di intelligenza artificiale di Azure. Questo messaggio di errore contiene le proprietà necessarie ErrorCode, message e proprietà facoltative target, details(coppia chiave-valore), errore interno(può essere annidato).
innerError.code	string	Ottiene la stringa di errore del codice.
innerError.message	string	Ottiene un messaggio di errore di alto livello.
innerError.target	string	Ottiene l'origine dell'errore. Ad esempio, sarebbe documents o document id per un documento non valido.

Esempi

Esempio di risposta riuscita

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

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

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

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

Passaggi successivi

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

Introduzione alla traduzione di documenti