Annullare la traduzione

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

Annullare un'operazione di elaborazione o accodamento corrente. Un'operazione non viene annullata se è stata completata, non è riuscita o annullata. Viene restituita una richiesta non valida. Le traduzioni completate non vengono annullate e vengono addebitate. Se possibile, tutte le traduzioni in sospeso vengono annullate.

Richiesta URL

Inviare una richiesta DELETE a:

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. 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 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 dei possibili stati per il processo o il documento: • Annullata •Annullamento •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