Obtenir l’état d’une documentation spécifique

Fonctionnalité de référence
: Azure AI Translator → Version de l’API traduction de documents
: méthode HTTP 2024-05-01
: GET

Cette méthode retourne l’état d’un document spécifique dans un travail, comme indiqué dans la requête par les id paramètres de requête.documentId

URL de la requête

Important

Toutes les demandes d’API adressées à la fonctionnalité de 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}/documents/{documentId}?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	Descriptif
documentId	Vrai	ID du document.
id	Vrai	L'ID de traitement.

Localisation des valeurs et id des documentId valeurs

• L’id de travail se trouve dans la valeur d’URL start-batch-translation de l’en-tête de réponse de la méthode Operation-Location POST. Le dernier paramètre de l’URL est l’ id de tâche de l’opération :

En-tête de réponse	URL de résultat
Operation-Location	{document-translation-endpoint}/translator/document/batches/{id} ?api-version={date}/ 9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec/

• Vous pouvez également utiliser une demande d’état de traduction GET pour récupérer les paramètres de travail id de la chaîne de requête.

• Vous trouverez le documentId paramètre dans la réponse de la méthode get-documents-status.

En-têtes de requête

Les en-têtes de requête sont les suivants :

headers	Descriptif
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	Descriptif
200	D’ACCORD. 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	Catégorie	Descriptif
chemin	ficelle	Emplacement du document ou du dossier.
chemin_source	ficelle	Emplacement du document source.
createdDateTimeUtc	ficelle	Date et heure de création de l’opération.
lastActionDateTimeUtc	ficelle	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 •Raté • NotStarted •Course •Réussi • Échec de la validation
à	ficelle	Code de langue à deux lettres de la langue cible. Voir la liste des langues.
progrès	nombre	Progression de la traduction, si elle est disponible.
id	ficelle	ID du document.
characterCharged	entier	Caractères facturés par l’API.

Réponse d’erreur

Nom	Catégorie	Descriptif
code	ficelle	Enums contenant des codes d’erreur généraux. Valeurs acceptées : • InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable •Non autorisée
Message	ficelle	Obtient un message d’erreur général.
erreur interne	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	ficelle	Obtient la chaîne d’erreur de code.
innerError.message	ficelle	Obtient un message d’erreur général.
innerError.target	ficelle	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 de la traduction de documents et de la bibliothèque cliente.

Prise en main de la traduction de documents