Condividi tramite

Ottenere lo stato per tutti i documenti

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

Importante

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

  • Usare il get documents status metodo per richiedere lo stato di tutti i documenti in un processo di traduzione.

  • $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 che l'utente desidera restituire in tutte le pagine.
    • $skip indica il numero di record da ignorare dall'elenco di stato del documento mantenuto dal server 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.
    • Se il numero di documenti nella risposta supera il limite di paging, viene usato il paging sul lato server.
    • Le risposte impaginate indicano un risultato parziale e includono un token di continuazione nella risposta. L'assenza di un token di continuazione significa che non sono disponibili altre pagine.

Nota

Se il server non può rispettare $top e/o $skip, il server deve restituire un errore al client informandolo invece di ignorare solo le opzioni di query. Questa azione riduce il rischio che il cliente presenti presupposti sui dati restituiti.

  • $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 solo documenti riusciti e annullati.
  • I createdDateTimeUtcStart parametri di query e createdDateTimeUtcEnd possono essere combinati o usati separatamente per specificare un intervallo di datetime per filtrare l'elenco restituito.
  • I parametri di query di filtro supportati sono (status, id, createdDateTimeUtcStarte createdDateTimeUtcEnd).
  • Quando vengono inclusi sia $top che $skip , il server deve prima applicare $skip e quindi $top nella raccolta.

Richiesta URL

Inviare una richiesta GET a:

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

Individuazione del valore id

  • Il id del processo viene trovato nell’intestazione della risposta del metodo start-batch-translation POST, in corrispondenza del valore URL Operation-Location. La stringa alfanumerica che segue il parametro /document/ è il id del processo dell'operazione:
Intestazione di risposta URL di risposta
Posizione operativa {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01
  • È usare anche una richiesta get-translations-status anche per recuperare un elenco dei processi di traduzione e dei relativi id.

Parametri della richiesta

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

Query parameter (Parametro di query) In Richiesto TIPO Descrizione
id sentiero Vero corda ID operazione.
$maxpagesize quesito Falso integer int32 $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. I client possono richiedere il paging basato su server con dimensioni di pagina specifiche specificando una $maxpagesize preferenza. Il server DEVE rispettare questa preferenza se le dimensioni della pagina specificate sono inferiori alle dimensioni predefinite della pagina del server.
$orderBy quesito Falso elenco Query di ordinamento per la raccolta ,ad esempio CreatedDateTimeUtc asc, CreatedDateTimeUtc desc.
$skip quesito Falso integer int32 $skip indica il numero di record da ignorare dall'elenco di record contenuti dal server in base al metodo di ordinamento specificato. Per impostazione predefinita, l'ordinamento viene eseguito in base all'ora di inizio decrescente. I client POSSONO utilizzare $top e $skip parametri di query per specificare il numero di risultati da restituire e un offset nella raccolta. Quando il client restituisce sia $top e $skip, il server DEVE prima applicare $skip e quindi $top nella raccolta. Se il server non può rispettare $top e/o $skip, il server DEVE restituire un errore al client informandolo invece di ignorare solo le opzioni di query.
$top quesito Falso integer int32 $top indica il numero totale di record che l'utente desidera restituire in tutte le pagine. I client possono usare $top i parametri di query e $skip per specificare il numero di risultati da restituire e un offset nella raccolta. Quando il client restituisce sia $top e $skip, il server DEVE prima applicare $skip e quindi $top nella raccolta. Se il server non può rispettare $top e/o $skip, il server DEVE restituire un errore al client informandolo invece di ignorare solo le opzioni di query.
createdDateTimeUtcEnd quesito Falso stringa data e ora Data/ora di fine per ottenere gli elementi prima.
createdDateTimeUtcStart quesito Falso stringa data e ora Data/ora di inizio per ottenere gli elementi dopo.
ids quesito Falso elenco ID da usare nei filtri.
stati quesito Falso elenco Stati da usare nel filtro.

Intestazioni delle richieste

Le intestazioni della richiesta sono le seguenti:

Intestazioni Descrizione Condizione
Ocp-Apim-Subscription-Key La chiave API del servizio Translator dal portale di Azure. Obbligatorio
Ocp-Apim-Subscription-Region Area in cui è stata creata la risorsa. Obbligatorio quando si usa una risorsa regionale (geografica) come Stati Uniti occidentali
Tipo di contenuto 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 dei documenti. HeadersRetry-After: integerETag: string
400 Richiesta non valida. Controllare i parametri di input.
401 Non autorizzato. Controllare le credenziali.
404 La risorsa non viene trovata.
500 Errore interno del server.
Altri codici di stato • Troppe richieste
• Il server non è temporaneamente disponibile

Ottenere la risposta sullo stato dei documenti

Risposta dello stato dei documenti completata

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

Nome TIPO Descrizione
@nextLink corda URL per la pagina successiva. Null se non sono disponibili altre pagine.
valore DocumentStatus [] Elenco di stato dei dettagli dei singoli documenti.
value.path corda Posizione del documento o della cartella.
value.sourcePath corda Posizione del documento di origine.
value.createdDateTimeUtc corda L'operazione ha creato data e ora.
value.lastActionDateTimeUtc corda Data di aggiornamento dello stato dell'operazione.
value.status stato Elenco dei possibili stati per il processo o il documento.
• Annullata
•Obliterazione
•Fallito
• NotStarted
•Corsa
•Riuscito
• ConvalidaFailed
value.to corda Lingua.
value.progress numero Avanzamento della traduzione, se disponibile.
value.id corda ID documento.
value.characterCharged numero intero Caratteri addebitati dall'API.

Risposta con errore

Nome TIPO Descrizione
codice corda Enumerazioni contenenti codici di errore di alto livello. Valori accettati:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• Servizio Non disponibile
•Non autorizzato
messaggio corda Ottiene un messaggio di errore di alto livello.
bersaglio corda Ottiene l'origine dell'errore. Ad esempio, sarebbe documents o document id per un documento non valido.
errore interno 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 di destinazione, dettagli (coppia chiave-valore), errore interno (può essere annidato).
innerError.code corda Ottiene la stringa di errore del codice.
innerError.messaggio corda Ottiene un messaggio di errore di alto livello.
innerError.target corda Ottiene l'origine dell'errore. Ad esempio, sarebbe documents o document id se fosse presente un documento non valido.

Esempi

Suggerimento

Utilizzare questo metodo per recuperare il documentId parametro per la stringa di query get-document-status .

Esempio di risposta riuscita

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

{
  "value": [
    {
      "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
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/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.

Introduzione alla traduzione dei documenti