Obtenir l’état de tous les documents

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

• Utilisez la get documents status méthode pour demander l’état de tous les documents d’un travail de traduction.

• 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, les enregistrements sont triés par heure de début décroissante.
  • $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.
  • 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.

• $orderBy le paramètre de requête peut être utilisé pour trier la liste retournée (par exemple : $orderBy=createdDateTimeUtc asc ou $orderBy=createdDateTimeUtc desc).
• Le tri par défaut est décroissant par createdDateTimeUtc. Certains paramètres de requête peuvent être utilisés pour filtrer la liste retournée (par exemple) status=Succeeded,Cancelledrenvoie uniquement les documents réussis et annulés.
• Les createdDateTimeUtcStart paramètres de createdDateTimeUtcEnd requête peuvent être combinés ou séparément pour spécifier une plage de datetime pour filtrer la liste retournée.
• Les paramètres de requête de filtrage pris en charge sont (status, , idcreatedDateTimeUtcStartet createdDateTimeUtcEnd).
• Lorsque $top et$skip sont tous deux inclus, le serveur doit d’abord appliquer $skip puis $top à la collection.

URL de la demande

Envoyez une demande GET à :

  curl -i -X GET "{document-translation-endpoint}/translator/document/batches/{id}/documents?api-version={date}"

Recherche de la valeur id

• L’id de travail se trouve dans la valeur d’URL Operation-Location de l’en-tête de réponse de la méthode start-batch-translation POST. La chaîne alphanumérique qui suit le paramètre /document/ est l’id de travail de l’opération :

• Vous pouvez également utiliser une requête get-translations-status pour récupérer une liste de travaux de traduction et leurs id.

Paramètres de la demande

Les paramètres de demande transmis à la chaîne de requête sont les suivants :

En-têtes de requête

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

Codes d’état de réponse

Voici les codes d’état HTTP qu’une demande peut retourner.

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.

Réponse d’erreur

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.