Translator 3.0 : BreakSentence

Article
09/01/2024

Identifie le positionnement des limites de phrases dans du texte.

URL de la demande

Envoyez une demande POST à :

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

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

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 de requête obligatoire. Version de l’API demandée par le client. La valeur doit être `3.0`.
langage	Paramètre de requête facultatif. Balise de langue identifiant la langue du texte d’entrée. Si aucun code n’est spécifié, la détection automatique de la langue est appliquée.
script	Paramètre de requête facultatif. Balise de script qui identifie le script utilisé par le texte d’entrée. Si aucun script n’est spécifié, le script par défaut de la langue est supposé.

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

headers	Description
En-têtes 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	Facultatif. 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. Les limites de phrases sont calculées pour la valeur de la propriété Text. Un exemple de corps de demande avec un seul élément de texte se présente ainsi :

[
    { "Text": "How are you? I am fine. What did you do today?" }
]

Les limites suivantes s'appliquent :

Le tableau ne peut pas compter plus de 100 éléments.
La valeur texte d’un élément de tableau ne peut pas dépasser 50 000 caractères, espaces comprises.
L’intégralité du texte inclus dans la demande ne peut pas dépasser 50 000 caractères, espaces comprises.
Si le paramètre de requête language est spécifié, tous les éléments du tableau doivent être dans la même langue. Sinon, la détection automatique de la langue est appliquée indépendamment à chaque élément du tableau.

Response body

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

sentLen: tableau d’entiers représentant les longueurs des phrases dans l'élément de texte. La longueur du tableau correspond au nombre de phrases, et les valeurs sont les longueurs des phrases.
detectedLanguage: objet décrivant la langue détectée au moyen des propriétés suivantes :
- language: code de la langue détectée.
- score: valeur flottante indiquant le niveau de confiance dans le résultat. Le score est compris entre zéro (0) et un (1.0). Un score faible (<= 0.4) indique une confiance faible.

La propriété detectedLanguage n’est présente dans l’objet de résultat que quand la détection automatique de la langue est demandée.

Exemple de réponse JSON :

[
    {
        "detectedLanguage": {
            "language": "en",
            "score": 1.0
        },
        "sentLen": [
            13,
            11,
            22
        ]
    }
]

En-têtes de réponse

headers	Description
X-RequestId	Valeur générée par le service pour identifier la demande et utilisée à des fins de résolution des problèmes.

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 de réponse indique souvent que toutes les traductions gratuites fournies avec un abonnement d’évaluation sont utilisées.
429	Le serveur a rejeté la demande, 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 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 obtenir les limites d’une phrase unique. Le service détecte automatiquement la langue de la phrase.

curl -X POST "https://api.cognitive.microsofttranslator.com/breaksentence?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"

Partager via