Obtenir l’état des traductions

  • Article

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

La méthode get translations status retourne une liste des demandes de lots soumises et l’état de chaque demande. Cette liste contient uniquement les demandes de lots soumises par l’utilisateur (en fonction de la ressource).

Si le nombre de demandes dépasse notre limite de pagination, la pagination côté serveur est utilisée. Les réponses paginées indiquent un résultat partiel et incluent un jeton de continuation dans la réponse. L’absence de jeton de continuation signifie qu’aucune autre page n’est disponible.

Les paramètres de requête $top, $skip et $maxpagesize peuvent être utilisés pour spécifier un nombre de résultats à retourner et un décalage pour la collection.

$top indique le nombre total d’enregistrements que l’utilisateur souhaite voir retournés dans toutes les pages. $skip indique le nombre d’enregistrements à ignorer dans la liste des lots en fonction de la méthode de tri spécifiée. Par défaut, le tri est effectué par ordre décroissant de l’heure de début. $maxpagesize est le nombre maximal d’éléments retournés dans une page. Si davantage d’éléments sont demandés via $top (ou si $top n’est pas spécifié et qu’il y a plus d’éléments à retourner), @nextLink contient le lien vers la page suivante.

Le paramètre de requête $orderBy s’utilise pour trier la liste retournée (par exemple, « $orderBy=createdDateTimeUtc asc » ou « $orderBy=createdDateTimeUtc desc »). Le tri par défaut est effectué par ordre décroissant de l’heure de création (createdDateTimeUtc). Certains paramètres de requête peuvent être utilisés pour filtrer la liste retournée (par exemple : « status=Succeeded,Cancelled ») renvoie les opérations réussis et annulés. createdDateTimeUtcStart etcreatedDateTimeUtcEnd peuvent être utilisés conjointement ou séparément pour spécifier une plage de valeurs DateHeure selon laquelle filtrer la liste retournée. Les paramètres de requête de filtrage pris en charge sont (status, IDs, createdDateTimeUtcStart, createdDateTimeUtcEnd).

Le serveur honore les valeurs spécifiées par le client. Toutefois, les clients doivent être prêts à gérer les réponses qui contiennent une taille de page différente ou un jeton de continuation.

Lorsque $top et$skip sont tous deux inclus, le serveur doit d’abord appliquer $skip puis $top à la collection.

Remarque

Si le serveur ne peut pas honorer $top et/ou $skip, il doit retourner une erreur au client afin de l’en informer au lieu d’ignorer simplement les options de requête. Cela réduit le risque que le client émette des hypothèses quant aux données retournées.

URL de la demande

Envoyez une demande GET à :

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

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. Dans Obligatoire Type Description
$maxpagesize query Faux entier int32 $maxpagesize est le nombre maximal d’éléments retournés dans une page. Si davantage d’éléments sont demandés via $top (ou si $top n’est pas spécifié et qu’il y a plus d’éléments à retourner), @nextLink contient le lien vers la page suivante. Les clients PEUVENT demander une pagination basée sur le serveur avec une taille de page spécifique en spécifiant une préférence $maxpagesize. Le serveur DOIT respecter cette préférence si la taille de page spécifiée est inférieure à la taille de page par défaut du serveur.
$orderBy query Faux tableau La requête de tri pour la collection (ex : CreatedDateTimeUtc asc, CreatedDateTimeUtc desc)
$skip query Faux entier int32 $skip indique le nombre d’enregistrements à ignorer dans la liste des enregistrements détenus par le serveur en fonction de la méthode de tri spécifiée. Par défaut, le tri est effectué par ordre décroissant de l’heure de début. Les clients PEUVENT utiliser les paramètres de requête $top et $skip pour spécifier le nombre de résultats à retourner et un décalage dans la collection. Quand le client renvoie $top et $skip, le serveur DOIT appliquer $skip avant $top sur la collection. Remarque : si le serveur ne peut pas appliquer $top et/ou $skip, le serveur DOIT retourner une erreur au client afin de l’en informer au lieu d’ignorer simplement les options de requête.
$top query Faux entier int32 $top indique le nombre total d’enregistrements que l’utilisateur souhaite voir retournés dans toutes les pages. Les clients PEUVENT utiliser les paramètres de requête $top et $skip pour spécifier le nombre de résultats à retourner et un décalage dans la collection. Quand le client renvoie $top et $skip, le serveur DOIT appliquer $skip avant $top sur la collection. Remarque : si le serveur ne peut pas appliquer $top et/ou $skip, le serveur DOIT retourner une erreur au client afin de l’en informer au lieu d’ignorer simplement les options de requête.
createdDateTimeUtcEnd query Faux chaîne date-heure Date et heure de fin pour l’extraction des éléments.
createdDateTimeUtcStart query Faux chaîne date-heure Date et heure de début pour l’extraction des éléments.
ids query Faux tableau ID à utiliser pour le filtrage.
statuses query Faux tableau États à utiliser pour le filtrage.

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 toutes les opérations. HeadersRetry-After: integerETag: string
400 Demande incorrecte. Demande non valide. Vérifiez les paramètres d’entrée.
401 Non autorisé. Vérifiez vos informations d’identification.
500 Erreur interne du serveur.
Autres codes d’état • Trop de demandes
• Serveur temporaire indisponible

Réponse de get translations status

Réponse positive de get translations status

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

Nom Type Description
@nextLink string URL de la page suivante. Null s’il n’y a plus de page disponible.
value TranslationStatus[] TranslationStatus[] Tableau
value.id string ID de l'opération.
value.createdDateTimeUtc string Date et heure de création de l’opération.
value.lastActionDateTimeUtc string Date à laquelle l’état de l’opération a été mis à jour.
value.status String Liste des états possibles pour un travail ou un document.
• Annulé
•Annulation
•Échoué
• NotStarted
•Exécution
•Réussi
• Échec de la validation
value.summary StatusSummary[] Résumé contenant les détails listés.
value.summary.total entier Nombre total de documents.
value.summary.failed entier Nombre de documents ayant échoué.
value.summary.success entier Nombre de documents traduits avec succès.
value.summary.inProgress entier Nombre de documents en cours de traitement.
value.summary.notYetStarted entier Nombre de documents dont le traitement n’a pas encore commencé.
value.summary.cancelled entier Nombre de documents annulés.
value.summary.totalCharacterCharged entier Nombre total de caractères facturés.

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 s’il y avait 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.

{
    "value": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/documents?`$top`=5&`$skip`=15"
}

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