Documentation de l'API de vérification de la grammaire et de l'orthographe
L'API de TextGears vous permet d'intégrer les dernières technologies d'analyse de texte à n'importe quel produit, qu'il s'agisse de simples applications mobiles ou de développements d'entreprise volumineux. L'API vous permet de rechercher toutes sortes d'erreurs dans un texte de manière flexible, de déterminer la lisibilité du texte, d'évaluer le vocabulaire approximatif de l'auteur, et bien plus encore.
Vous recherchez un plugin pour un site Web?
Vous pouvez facilement ajouter une vérification de texte à votre site Web. Plus d'informations sur le plugin et un exemple de code peuvent être trouvés sur la page de documentation.
Que peut faire l'API ?
Documents pour Postman
Vous pouvez télécharger le fichier de documentation API pour Postman ou tout autre programme de débogage HTTP. Dans Postman, vous pouvez définir une clé dans l'onglet Variables de la collection..
Où commencer
C'est simple et facile. L'API est disponible pour les demandes régulières HTTP et HTTPS. Les données de sortie sont envoyées en JSON. Toutes les demandes sont faites au api.textgears.com
serveur
Pour accélérer l'accès depuis différentes parties du monde, nous avons placé des serveurs dans 3 pays : États-Unis, Estonie et Singapour. Lorsque vous soumettez une requête à api.textgears.com
, nous choisissons le cluster le plus proche. Mais vous pouvez explicitement faire des demandes au cluster situé à proximitépour réduire le délai de réception d'une réponse.
https://eu.api.textgears.com
– Europe
https://us.api.textgears.com
– America
https://sg.api.textgears.com
– Asia
Tous les points de terminaison de l'API sont des grappes indépendantes de serveurs. Nous garantissons une serviceabilité à 99,9 % pour chacune d'entre elles. Si cela vous semble insuffisant, vous pouvez changer de grappe lorsqu'une erreur de connexion se produit.
import textgears from 'textgears-api';
const textgearsApi = textgears('YOUR_KEY', {language: 'en-US'});
textgearsApi.checkGrammar('I is a engineer')
.then((data) => {
for (const error of data.errors) {
console.log('Error: %s. Suggestions: %s', error.bad, error.better.join(', '));
}
})
.catch((err) => {});
Si vous avez implémenté une bibliothèque pour travailler avec l'API dans un autre langage ou pour un autre framework, vous n'avez qu'à nous envoyer un lien sur GitHub ou GitLab, tandis que nous le publierons également.
Langues prises en charge
TextGears analyse le texte non seulement en tenant compte de la langue du texte, mais aussi en gardant à l'esprit le dialecte. Liste complète des langues prises en charge: Anglais, français, allemand, portugais, italien, espagnol, russe, arabe, japonais, chinois, grec
Dialectes supportés (doivent être envoyés dans le paramètre language
) : en-US, en-GB, en-ZA, en-AU, en-NZ, fr-FR, de-DE, de-AT, de-CH, pt-PT, pt-BR, it-IT, ar-AR, ru-RU, es-ES, ja-JP, zh-CN, el-GR
Transfert d'autorisations et de paramètres
La demande est autorisée par le transfert de votre clé parmi d'autres paramètres de l'une des manières suivantes:
- POST parameter
key
-
GET parameter
key
?key=YOURKEY
-
Json-request
{ "key": "YOURKEY", // Other params }
-
HTTP Header
Où YOURKEY est votre cléAuthorization: Basic YOURKEY
Codes d'erreur
En cas d'erreur, le paramètre status
aura la valeur false
{
status : false,
error_code : 600, // API error code
description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
- 600 - Clé invalide
- 606 - Langue non supportée
- 607 - Nombre autorisé de requêtes dépassé
- 500 - Erreur de service interne inconnu
- 501 - La longueur du texte dépasse la limite de débit
API de validation de texte
Vérifier la grammaire du texte
https://api.textgears.com/grammar
Cette méthode vous permet de vérifier que le texte ne contient pas de fautes de grammaire, d'orthographe, de ponctuation et de style.
Paramètres de la requête
Vérification de l'orthographe du texte
https://api.textgears.com/spelling
La méthode vérifie la présence de fautes de frappe dans le texte en utilisant le dictionnaire mis à jour
Paramètres de la requête
Auto-correction du texte
https://api.textgears.com/correct
Il existe deux méthodes de correction automatique du texte. La méthode "correct" est sensiblement plus précise, mais elle s'applique aux requêtes d'IA.
Important !
Pour le moment, la méthode ne fonctionne que pour la langue anglaise.
Paramètres de la requête
https://api.textgears.com/suggest
Le système de vérification corrige automatiquement les erreurs dans le texte et propose une suite à la dernière phrase.
Important !
Si une faute de frappe est trouvée, le mot est remplacé par le mot le plus proche du dictionnaire. TextGears est encore loin de la télépathie, donc s'il y a beaucoup de fautes de frappe, le sens du texte final peut changer.
Paramètres de la requête
Lisibilité du texte
https://api.textgears.com/readability
Calcul de la lisibilité du texte selon les algorithmes les plus courants et leurs adaptations pour la plupart des langues. Vous pouvez en savoir plus sur les mesures de lisibilité.en lisant notre article séparé.
Important !
Lors de la détermination des métriques du texte, la précision est directement liée à la taille du texte.Déterminer la lisibilité ou d'autres paramètres du texte pour une phrase de deux mots n'a aucun sens.Il est recommandé de vérifier les textes qui ont au moins 30 mots. Plus il y en a, mieux c'est.\N
Paramètres de la requête
Analyse de texte
https://api.textgears.com/analyze
Analyse complète du texte. Il trouve toutes sortes d'erreurs, calcule les métriques de lisibilité, note l'orthographe sur une échelle de 100 points et évalue également l'humeur émotionnelle du texte.
Important !
Lors de la détermination des métriques du texte, la précision est directement liée à la taille du texte.Déterminer la lisibilité ou d'autres paramètres du texte pour une phrase de deux mots n'a aucun sens.Il est recommandé de vérifier les textes qui ont au moins 30 mots. Plus il y en a, mieux c'est.\N
Paramètres de la requête
Détection de la langue
https://api.textgears.com/detect
Détermination de la langue du texte et de l'hypothèse de son dialecte.La méthode renvoie un tableau d'options probables pour chaque langue. S'il n'est pas possible d'identifier sans ambiguïté la langue, le champ language
renvoie null
Paramètres de la requête
Résumés et extraction de mots-clés
https://api.textgears.com/summarize
Paramètres de la requête
Admin API
Planifier le quota
https://api.textgears.com/account/resourcequota
Réception de données sur le quota actuel du plan. Cette méthode peut être utilisée pour savoir combien de demandes ont déjà été faites dans le cadre du plan, ou combien de demandes peuvent encore être faites pendant la période de facturation.
Paramètres de la requête
Statistiques d'utilisation
https://api.textgears.com/account/usage
Obtenir des statistiques d'utilisation de l'API pour votre compte avec une répartition par jour
Paramètres de la requête
Créer et éditer des dictionnaires
https://api.textgears.com/custom/createdictionary
Si vous avez besoin d'un paramètre flexible pour vérifier les erreurs dans le texte, utilisez le paramètre des exceptions personnalisées. Cela sera particulièrement utile pour les entreprises qui travaillent avec des textes contenant des mots issus d'un vocabulaire particulier. Marquez les mots ou les phrases comme étant "corrects" afin que le système cesse de les considérer comme des erreurs. Vous pouvez également l'utiliser pour permettre au système de trouver des erreurs en fonction de la liste de mots spécifiques.Les règles personnalisées peuvent être combinées et transformées en dictionnaires. Une telle approche permet aux différentes fonctions de votre produit d'utiliser un ensemble de règles différent. En même temps, chaque utilisateur de votre produit peut disposer de son propre ensemble d'exceptions
Paramètres de la requête
https://api.textgears.com/custom/updatedictionary
https://api.textgears.com/custom/listdictionaries
https://api.textgears.com/custom/deletedictionary
Ajouter une exception
https://api.textgears.com/custom/addexception
Si vous vérifiez des textes au vocabulaire très spécifique qui sont marqués comme des erreurs dans notre système, vous pouvez ajouter des mots ou des phrases aux exceptions. Après cela, ils ne seront plus considérés comme des erreurs.
Paramètres de la requête
Liste des exceptions
https://api.textgears.com/custom/listexceptions
Liste des mots d'exclusion précédemment ajoutés
Paramètres de la requête
Retirer l'exception
https://api.textgears.com/custom/deleteexception
Supprimez le mot d'exception pour vérification. Si vous essayez de supprimer un mot précédemment supprimé, aucune erreur ne se produit.