Obtenir l’état d’un document
Service
de référence : Traduction de documentation Azure AI
Version de l’API : v1.1
La méthode Get Document Status retourne l’état d’un document spécifique. La méthode retourne l’état de traduction d’un document spécifique en fonction de l’ID de la requête et de l’ID du document.
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/{documentId}
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 |
|---|---|---|
| documentId | Vrai | ID du document. |
id |
True | L'ID de traitement. |
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. Requête réussie et acceptée par le service. Les détails de l’opération sont retournés. HeadersRetry-After: integerETag: string |
| 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 get document status
Réponse positive de get document status
| Nom | Type | Description |
|---|---|---|
| path | string | Emplacement du document ou du dossier. |
| sourcePath | string | Emplacement du document source. |
| 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 |
| à | string | Code de langue à deux lettres de la langue cible. Voir la liste des langues. |
| progress | nombre | Progression de la traduction, si elle est disponible. |
id |
string | ID du document. |
| 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. |
| 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.
{
"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
}
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.