Obtenir l’état d’un travail de traduction spécifique

Fonctionnalité de référence
: Api traduction de documents
Azure AI Traducteur → version : méthode HTTP 2024-05-01
: GET

• Utilisez la get translation status méthode pour demander l’état d’un travail de traduction spécifique. La réponse inclut l’état global du travail et l’état des documents traduits dans le cadre de ce travail.

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 GET "{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	Condition
Ocp-Apim-Subscription-Key	Votre clé API de service Traducteur à partir du Portail Azure.	Requis
Ocp-Apim-Subscription-Region	Région dans laquelle votre ressource a été créée.	• Obligatoire lors de l’utilisation d’une ressource régionale (géographique) comme usa Ouest. &puce.
Content-Type	Type de contenu de la charge utile. Les valeurs acceptées sont application/json ou charset=UTF-8.	• 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