Share via


Ottenere lo stato della traduzione

Servizio di riferimento
: Versione dell'API Traduzione
documenti di Azure per intelligenza artificiale: v1.1

Il metodo Get translation status restituisce lo stato di una richiesta di traduzione di documenti. Lo stato include lo stato complessivo della richiesta e lo stato dei documenti che vengono tradotti come parte di tale richiesta.

Richiesta URL

Inviare una richiesta GET a:

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}

Informazioni su come trovare il nome di dominio personalizzato.

Importante

  • Tutte le richieste API al servizio traduzione documenti richiedono un endpoint di dominio personalizzato.
  • Non è possibile usare l'endpoint trovato nella pagina delle chiavi e dell'endpoint della risorsa portale di Azure né nell'endpoint traduttore globale,api.cognitive.microsofttranslator.com per effettuare richieste HTTP a Traduzione documenti.

Parametri della richiesta

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

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

Intestazioni delle richieste

Le intestazioni della richiesta sono le seguenti:

Intestazioni Descrizione
Ocp-Apim-Subscription-Key Intestazione della richiesta obbligatoria

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.