Ottenere lo stato del documento

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

Il metodo Get Document Status restituisce lo stato di un documento specifico. Il metodo restituisce lo stato di traduzione per un documento specifico in base all'ID richiesta e all'ID documento.

Richiesta URL

Inviare una richiesta GET a:

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

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
documentId	Vero	ID documento.
id	Vero	ID batch.

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 accettata dal servizio. Vengono restituiti i dettagli dell'operazione. HeadersRetry-After: integerETag: string
401	Non autorizzato. Controllare le credenziali.
404	Non trovato. La risorsa non viene trovata.
500	Errore interno del server.
Altri codici di stato	• Troppe richieste • Server temporaneo non disponibile

Ottenere la risposta sullo stato del documento

Risposta di stato del documento completata

Nome	Tipo	Descrizione
path	string	Posizione del documento o della cartella.
Sourcepath	string	Posizione del documento di origine.
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
to	string	Codice linguistico a due lettere di To Language. Vedere l'elenco delle lingue.
Avanzamento	Numero	Avanzamento della traduzione, se disponibile
id	string	ID documento.
characterCharged	integer	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.
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.

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

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