Annullare la traduzione

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

• Questo metodo annulla un processo di traduzione che sta elaborando o accodato (in sospeso) come indicato nella richiesta dal parametro di id query.
• Un'operazione non viene annullata se è già stata completata, non è riuscita o viene comunque annullata. In questi casi viene restituita una richiesta non valida.
• Le traduzioni completate non possono essere annullate e vengono addebitate le spese.

Richiesta URL

Importante

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

  curl -i -X  DELETE "{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

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
Operation-Location	{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.

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. Annullare la richiesta inviata
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

Annullare la risposta alla traduzione

Risposta con esito positivo

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

Nome	Tipo	Descrizione
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 dei possibili stati per il processo o il documento: • Annullata •Obliterazione •Fallito • NotStarted •Corsa •Riuscito • ConvalidaFailed
riepilogo	StatusSummary	Riepilogo contenente un elenco di dettagli.
summary.total	integer	Conteggio dei documenti totali.
summary.failed	integer	Numero di documenti non riusciti.
summary.success	integer	Conteggio dei documenti tradotti correttamente.
summary.inProgress	integer	Numero di documenti in corso.
summary.notYetStarted	integer	Numero di documenti non ancora avviati per l'elaborazione.
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 "documenti" 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 di destinazione, dettagli (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 se fosse presente un documento non valido.

Esempi

Esempio di risposta riuscita

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

Codice di stato: 200

{
  "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: 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 di documenti