Annuler la traduction

Fonctionnalité de référence
: Azure AI Traducteur → version de l’API Traduction
de documents : méthode HTTP 2024-05-01
: DELETE

• Cette méthode annule un travail de traduction en cours de traitement ou mis en file d’attente (en attente), comme indiqué dans la requête par le id paramètre de requête.
• Une opération n’est pas annulée si elle est déjà terminée, a échoué ou est toujours annulée. Dans ces cas, une demande incorrecte est retournée.
• Les traductions terminées ne peuvent pas être annulées et sont facturées.

URL de la requête

Important

Toutes les demandes d’API adressées à la fonctionnalité traduction de documents nécessitent un point de terminaison de domaine personnalisé situé sur la page vue d’ensemble de votre ressource dans le Portail Azure.

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

Paramètres de la demande

Les paramètres de demande transmis à la chaîne de requête sont les suivants :

Paramètre de requête.	Obligatoire	Description
id	True	ID de l’opération.

Recherche de la valeur id

Vous pouvez trouver le travail id dans la valeur d’URL d’en-tête Operation-Location de réponse de la méthode POSTstart-batch-translation. La chaîne alphanumérique qui suit le /document/ paramètre est le travail idde l’opération :

En-tête de réponse	URL de réponse
Operation-Location	{document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec ?api-version=2024-05-01

• Vous pouvez également utiliser une demande get-translation-status pour récupérer une liste de travaux de traduction et leurs ids.

En-têtes de requête

Les en-têtes de requête sont les suivants :

headers	Description
Ocp-Apim-Subscription-Key	En-tête de requête obligatoire

Codes d’état de réponse

Voici les codes d’état HTTP qu’une demande peut retourner.

Code d’état	Description
200	OK. Annuler la demande envoyée
401	Non autorisé. Vérifiez vos informations d’identification.
404	Introuvable. La ressource est introuvable.
500	Erreur interne du serveur.
Autres codes d’état	• Trop de demandes • Serveur temporaire indisponible

Réponse de cancel translation

Réponse correcte

Les informations suivantes sont retournées dans une réponse positive.

Nom	Type	Description
id	string	ID de l'opération.
createdDateTimeUtc	string	Date et heure de création de l’opération.
lastActionDateTimeUtc	string	Date à laquelle l’état de l’opération est mis à jour.
statut	Chaîne	Liste des états possibles pour le travail ou le document : • Annulé •Annulation •Échoué • NotStarted •Exécution •Réussi • Échec de la validation
résumé	StatusSummary	Résumé contenant une liste de détails.
summary.total	entier	Nombre total de documents.
summary.failed	entier	Nombre de documents ayant échoué.
summary.success	entier	Nombre de documents traduits avec succès.
summary.inProgress	entier	Nombre de documents en cours de traitement.
summary.notYetStarted	entier	Nombre de documents dont le traitement n’a pas encore commencé.
summary.cancelled	entier	Nombre de documents annulés.
summary.totalCharacterCharged	entier	Nombre total de caractères facturés par l’API.

Réponse d’erreur

Nom	Type	Description
code	string	Enums contenant des codes d’erreur généraux. Valeurs possibles : • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Non autorisée
message	string	Obtient un message d’erreur général.
target	string	Obtient la source de l’erreur. Par exemple, il s’agirait de « documents » ou document id pour un document non valide.
innerError	InnerTranslationError	Nouveau format d’erreur interne conforme aux instructions de l’API Azure AI services. Ce message d'erreur contient les propriétés obligatoires ErrorCode, le message et la cible de propriétés facultatives, les détails (paire clé-valeur) et l’erreur interne (qui peut être imbriquée).
innerError.code	string	Obtient la chaîne d’erreur de code.
innerError.message	string	Obtient un message d’erreur général.
innerError.target	string	Obtient la source de l’erreur. Par exemple, ce serait documents ou document id s’il y avait un document non valide.

Exemples

Exemple de réponse positive

L’objet JSON suivant est un exemple de réponse positive.

Code d’état : 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
  }
}

Exemple de réponse d’erreur

L’objet JSON suivant est un exemple de réponse d’erreur. Le schéma des autres codes d’erreur est le même.

Code d’état : 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Étapes suivantes

Suivez notre guide de démarrage rapide pour en savoir plus sur l’utilisation du service Traduction de document et de la bibliothèque de client.

Bien démarrer avec la traduction de documentation