Obtenir l’état de la traduction

  • Article

Service
de référence : Traduction de documentation Azure AI
Version de l’API : v1.1

La méthode get translation status retourne l’état d’une demande de traduction de document. L’état comprend l’état global de la demande et l’état des documents en cours de traduction dans le cadre de cette demande.

URL de la demande

Envoyez une demande GET à :

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}

Découvrez comment déterminer votre nom de domaine personnalisé.

Important

  • Toutes les requêtes d’API adressées au service Traduction de documentation nécessitent un point de terminaison de domaine personnalisé.
  • Vous ne pouvez pas utiliser le point de terminaison qui se trouve dans la page Clés et point de terminaison de votre ressource du portail Azure, ni le point de terminaison du traducteur global (api.cognitive.microsofttranslator.com) pour soumettre des requêtes HTTP au service Traduction de documentation.

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

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. Demande réussie, et retourne l’état de l’opération de traduction par lot. HeadersRetry-After: integerETag: string
401 Non autorisé. Vérifiez vos informations d’identification.
404 La ressource est introuvable.
500 Erreur interne du serveur.
Autres codes d’état • Trop de demandes
• Serveur temporaire indisponible

Réponse de get translation status

Réponse positive de get translation status

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 a été 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 les détails listés.
summary.total entier Nombre total.
summary.failed entier Nombre d’échecs.
summary.success entier Nombre de réussites.
summary.inProgress entier Nombre de demandes en cours de traitement.
summary.notYetStarted entier Nombre de demandes n’ayant pas encore démarré.
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, ce serait 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 requises ErrorCode, message et cible de propriétés facultatives, détails(paire clé valeur), erreur interne(il peut être imbriqué).
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 pour un document non valide.

Exemples

Exemple de réponse positive

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

{
  "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 : 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

É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