Obtenir l’état des documents
Service
de référence : Traduction de documentation Azure AI
Version de l’API : v1.1
Si le nombre de documents dans la réponse 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 états de documents 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. $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 ») retourne uniquement les documents 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).
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/{id}/documents
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 |
---|---|---|---|---|
id |
path | True | string | ID de l’opération. |
$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 pilotée par le serveur avec une taille de page spécifique en spécifiant une $maxpagesize préférence. 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 un nombre de résultats à retourner et un décalage dans la collection. Lorsque le client retourne à la fois $top et$skip , le serveur DOIT d’abord appliquer $skip puis $top à la collection. Si le serveur ne peut pas respecter $top et/ou $skip , le serveur DOIT renvoyer une erreur au client en l’informant 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 $top et $skip interroger des paramètres pour spécifier le nombre de résultats à retourner et un décalage dans la collection. Lorsque le client retourne à la fois $top et$skip , le serveur DOIT d’abord appliquer $skip puis $top à la collection. Si le serveur ne peut pas respecter $top et/ou $skip , le serveur DOIT renvoyer une erreur au client en l’informant 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 des documents. HeadersRetry-After: integerETag: string |
400 | Demande non valide. Vérifiez les paramètres d’entrée. |
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 • Le serveur n’est pas disponible temporairement |
Réponse de la méthode get documents status
Réponse positive de la méthode get documents 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 | DocumentStatus [] | Liste d’états détaillée des documents individuels. |
value.path | string | Emplacement du document ou du dossier. |
value.sourcePath | string | Emplacement du document source. |
value.createdDateTimeUtc | string | Date et heure de création de l’opération. |
value.lastActionDateTimeUtc | string | Date à laquelle l’état de l’opération est mis à jour. |
value.status | status | Liste des états possibles pour un travail ou un document. • Annulé •Annulation •Échoué • NotStarted •Exécution •Réussi • Échec de la validation |
value.to | string | Langue cible. |
value.progress | nombre | Progression de la traduction, si elle est disponible. |
value.id | string | Document ID. |
value.characterCharged | entier | 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 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": [
{
"path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
"sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
"createdDateTimeUtc": "2020-03-26T00:00:00Z",
"lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
"status": "Running",
"to": "fr",
"progress": 0.1,
"id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
"characterCharged": 0
}
],
"@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/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.