Translator 3.0 : Transliterate

  • Article

Convertit du texte dans une langue d’un script vers un autre script.

URL de la demande

Envoyez une demande POST à :

https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0

ConsultezPrise en charge de réseau virtuel du service Translator sélectionné pour la configuration et la prise en charge du point de terminaison privé et du réseau.

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. Description
api-version Paramètre obligatoire.
Version de l’API demandée par le client. La valeur doit être 3.0.
langage Paramètre obligatoire.
Spécifie la langue du texte à convertir d’un script à un autre. Les langues possibles sont répertoriées dans l’étendue transliteration obtenue en interrogeant le service pour connaître les langues prises en charge.
fromScript Paramètre obligatoire.
Spécifie le script utilisé par le texte d’entrée. Recherchez les langues prises en charge à l’aide de l’étendue transliteration, afin de trouver des scripts d’entrée disponibles pour la langue sélectionnée.
toScript Paramètre obligatoire.
Spécifie le script de sortie. Recherchez les langues prises en charge à l’aide de l’étendue transliteration, afin de trouver des scripts de sortie disponibles pour l’association de langue et de script d’entrée sélectionnée.

Les en-têtes de demande sont les suivants :

headers Description
En-tête(s) d’authentification En-tête de demande obligatoire.
Voir les options disponibles pour l’authentification.
Content-Type En-tête de demande obligatoire.
Spécifie le type de contenu de la charge utile. Les valeurs possibles sont les suivantes : application/json
Content-Length En-tête de demande obligatoire.
Longueur du corps de la demande.
X-ClientTraceId Facultatif.
GUID généré par le client pour identifier de façon unique la demande. Vous pouvez omettre cet en-tête si vous incluez l’ID de trace dans la chaîne de requête à l’aide d’un paramètre de requête appelé ClientTraceId.

Corps de la demande

Le corps de la demande est un tableau JSON. Chaque élément du tableau est un objet JSON avec une propriété de chaîne nommée Text, qui représente la chaîne à convertir.

[
    {"Text":"こんにちは"},
    {"Text":"さようなら"}
]

Les limites suivantes s'appliquent :

  • Le tableau ne peut pas compter plus de 10 éléments.
  • La valeur texte d’un élément de tableau ne peut pas dépasser 1 000 caractères, espaces compris.
  • L’intégralité du texte inclus dans la demande ne peut pas dépasser 5 000 caractères, espaces comprises.

Response body

Une réponse correcte est un tableau JSON avec un résultat pour chaque élément dans le tableau d’entrée. Un objet de résultat inclut les propriétés suivantes :

  • text : une chaîne qui est le résultat de la conversion de la chaîne d’entrée en script de sortie.

  • script: chaîne spécifiant le script utilisé dans la sortie.

Exemple de réponse JSON :

[
    {"text":"konnnichiha","script":"Latn"},
    {"text":"sayounara","script":"Latn"}
]

En-têtes de réponse

headers Description
X-RequestId Valeur générée par le service pour identifier la demande. Elle sert à des fins de dépannage.

Codes d’état de réponse

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

Code d’état Description
200 Réussite.
400 L’un des paramètres de requête est manquant ou non valide. Corrigez les paramètres de demande avant de réessayer.
401 Il n’a pas été possible d’authentifier la demande. Vérifiez que les informations d’identification sont spécifiées et valides.
403 La requête n’est pas autorisée. Vérifiez le message d’erreur détaillé. Ce code indique souvent que toutes les traductions gratuites fournies avec un abonnement d’essai ont été utilisées.
429 Le serveur a rejeté la requête, car le client a dépassé les limites de requête.
500 Une erreur inattendue s’est produite. Si l’erreur persiste, signalez-la en fournissant les informations suivantes : date et heure de la défaillance, identificateur de la demande dans l’en-tête de réponse,X-RequestId et identificateur du client dans l’en-tête de demande X-ClientTraceId.
503 Serveur temporairement indisponible. Relancez la requête. Si l’erreur persiste, signalez-la en fournissant les informations suivantes : date et heure de la défaillance, identificateur de la demande dans l’en-tête de réponse,X-RequestId et identificateur du client dans l’en-tête de demande X-ClientTraceId.

Si une erreur se produit, la requête renvoie également une réponse d'erreur JSON. Le code d’erreur est un nombre à 6 chiffres qui combine le code d’état HTTP à 3 chiffres et un nombre à 3 chiffres qui sert à catégoriser plus précisément l’erreur. Vous trouverez les codes d’erreur les plus courants sur la page Référence de Translator v3.

Exemples

L’exemple suivant montre comment convertir deux chaînes de japonais en japonais romanisé.

La charge utile JSON de la requête dans cet exemple :

[{"text":"こんにちは","script":"jpan"},{"text":"さようなら","script":"jpan"}]

Si vous utilisez cUrl dans une fenêtre de ligne de commande ne prenant pas en charge les caractères Unicode, utilisez la charge utile JSON suivante et enregistrez-la dans un fichier nommé request.txt. Veillez à enregistrer le fichier avec l’encodage UTF-8.

curl -X POST "https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latn" -H "X-ClientTraceId: 875030C7-5380-40B8-8A03-63DACCF69C11" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d @request.txt