Condividi tramite

Ottenere lo stato per un documento specifico

  • Articolo

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

Questo metodo restituisce lo stato di un documento specifico in un processo, come indicato nella richiesta dai id parametri di query e documentId .

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}/documents/{documentId}?api-version={date}"

Parametri della richiesta

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

Query parameter (Parametro di query) Obbligatorio Descrizione
documentId Vero ID documento.
id Vero ID batch.

Individuazione dei id valori e documentId

  • È possibile trovare il processo id nel valore DELL'URL dell'intestazione Operation-Location della risposta del metodo POSTstart-batch-translation. L'ultimo parametro dell'URL è il processo dell'operazione id:
Intestazione di risposta URL dei risultati
Operation-Location {document-translation-endpoint}/translator/document/batches/{id}?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

  • È anche possibile usare una richiesta di stato delle traduzioni GET per recuperare i parametri del processo id per la stringa di query.

  • È possibile trovare il documentId parametro nella risposta al metodo get-documents-status.

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 number 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