Documentación de la API de revisión gramatical y ortográfica
La API de TextGears le permite integrar las últimas tecnologías de análisis de texto prácticamente en cualquier producto. La API le permite comprobar el texto en busca de todo tipo de errores de forma flexible, determinar la legibilidad del texto, evaluar el vocabulario aproximado del autor y mucho más.
¿Busca un complemento para un sitio web?
Puede agregar fácilmente la verificación de texto a su sitio web. Puede encontrar más información sobre el complemento y el código de muestra en la página de documentación.
¿Qué puede hacer la API?
Documentos para Postman
Puede descargar el archivo de documentación de la API para Postman o cualquier otro programa de depuración HTTP. En Postman puede establecer una clave en la pestaña Variables de la colección..
Dónde empezar
Es simple y fácil. La API está disponible para peticiones regulares HTTP y HTTPS.Los datos de salida se envían en JSON. Todas las peticiones se realizan al servidor api.textgears.com
Para agilizar el acceso desde distintas partes del mundo, hemos colocado servidores en 3 países: Estados Unidos, Estonia y Singapur. Al enviar una solicitud a api.textgears.com
elegiremos el clúster más cercano. Pero puede hacer peticiones explícitamente al clúster situado cerca para reducir el retraso en la recepción de una respuesta.
https://eu.api.textgears.com
– Europe
https://us.api.textgears.com
– America
https://sg.api.textgears.com
– Asia
Todos los puntos finales de la API son clústeres de servidores independientes. Garantizamos un 99,9% de capacidad de servicio para cada uno de ellos. Si esto le parece insuficiente, puede cambiar el clúster cuando se produzca un error de conexión.
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 ha implementado una librería para trabajar con la API en otro lenguaje o para otro framework, sólo tiene que enviarnos un enlace en GitHub o GitLab, y nosotros lo publicaremos también.
Idiomas soportados
TextGears analiza el texto no sólo teniendo en cuenta el idioma del mismo, sino también el dialecto. Lista completa de idiomas compatibles: Inglés, francés, alemán, portugués, italiano, español, ruso, Árabe, japonés, chino, griego
Los dialectos soportados (tienen que ser enviados en el parámetro 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
Autorización y transferencia de parámetros
La solicitud se autoriza transfiriendo su clave, entre otros parámetros, de una de las siguientes maneras:
- POST parameter
key
-
GET parameter
key
?key=YOURKEY
-
Json-request
{ "key": "YOURKEY", // Other params }
-
HTTP Header
Donde YOURKEY es su clave.Authorization: Basic YOURKEY
Códigos de error
En caso de error, el parámetro status
tendrá un valor false
{
status : false,
error_code : 600, // API error code
description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
- 600 - Clave no válida
- 606 - Idioma no soportado
- 607 - Número de peticiones permitido superado
- 500 - Error de servicio interno desconocido
- 501 - La longitud del texto supera el límite de la tasa .
API de validación de texto
Revisando la gramática del texto
https://api.textgears.com/grammar
El método permite comprobar si el texto tiene errores gramaticales, ortográficos, de puntuación y de estilo.
Solicitar parámetros
Revisando la ortografía del texto
https://api.textgears.com/spelling
El método revisa el texto en busca de errores tipográficos utilizando el diccionario actualizado
Solicitar parámetros
Autocorrigiendo el texto
https://api.textgears.com/correct
Hay dos métodos para la corrección automática de texto. El método "correct" es notablemente más preciso, pero se aplica a las solicitudes de IA.
¡Importante!
Por el momento, el método solo funciona para el idioma inglés.
Solicitar parámetros
https://api.textgears.com/suggest
El sistema de verificación corrige automáticamente los errores del texto y sugiere la continuación de la última frase.
¡Importante!
Si se encuentra una errata, la palabra se sustituye por la más parecida del diccionario. Si hay varias palabras parecidas a la detectada, se elige la más común en el habla moderna. TextGears aún está lejos de la telepatía, por lo que si hay muchas erratas el significado del texto final puede cambiar.
Solicitar parámetros
Legibilidad del texto
https://api.textgears.com/readability
Cálculo de la legibilidad del texto según los algoritmos más comunes y sus adaptacionespara la mayoría de los idiomas. Puede obtener más información sobre las métricas de legibilidad leyendo nuestro artículo independiente.
¡Importante!
A la hora de determinar las métricas del texto, la precisión está directamente relacionada con el tamaño del mismo. Determinar la legibilidad u otros parámetros del texto para una frase de dos palabras no tiene sentido. Se recomienda comprobar los textos que tengan al menos 30 palabras. Cuantas más, mejor.
Solicitar parámetros
Análisis de Texto
https://api.textgears.com/analyze
Análisis exhaustivo del texto. Encuentra todo tipo de errores, calcula las métricas de legibilidad, califica la ortografía en una escala de 100 puntos y también evalúa el estado emocional del texto.
¡Importante!
A la hora de determinar las métricas del texto, la precisión está directamente relacionada con el tamaño del mismo. Determinar la legibilidad u otros parámetros del texto para una frase de dos palabras no tiene sentido. Se recomienda comprobar los textos que tengan al menos 30 palabras. Cuantas más, mejor.
Solicitar parámetros
Detección de idioma
https://api.textgears.com/detect
Determinación del idioma del texto y de la suposición de su dialecto.El método devuelve una matriz de opciones probables para cada idioma.Si no es posible identificar inequívocamente el idioma, el campo de language
se vuelve null
Solicitar parámetros
Resumir y extraer palabras clave
https://api.textgears.com/summarize
Solicitar parámetros
Admin API
Cuota del Plan
https://api.textgears.com/account/resourcequota
Recibir datos sobre la cuota actual del plan. El método puede utilizarse para saber cuántas solicitudes dentro del plan se han realizado ya, o cuántas solicitudes pueden realizarse todavía dentro del periodo de facturación
Solicitar parámetros
Estadísticas de Uso
https://api.textgears.com/account/usage
Obtención de estadísticas de uso de la API para su cuenta con un desglose por días
Solicitar parámetros
Crear y editar diccionarios
https://api.textgears.com/custom/createdictionary
Si necesita una configuración flexible para la comprobación de errores en el texto, utilice la configuración de excepciones personalizadas. Esto será especialmente útil para las empresas que trabajan con textos llenos de palabras de un vocabulario especial. Marque palabras o frases como "correctas" para que el sistema deje de considerarlas como errores. También puede utilizarlo para que el sistema encuentre errores según la lista de palabras específicas. Las reglas personalizadas pueden combinarse y transformarse en diccionarios. Este enfoque permite que las distintas funciones de su producto utilicen un conjunto de reglas diferente. Al mismo tiempo, cada usuario de su producto puede tener su propio conjunto de excepciones
Solicitar parámetros
https://api.textgears.com/custom/updatedictionary
https://api.textgears.com/custom/listdictionaries
https://api.textgears.com/custom/deletedictionary
Agregar una excepción
https://api.textgears.com/custom/addexception
Si está revisando textos con un vocabulario muy específico que está marcado como errores en nuestro sistema, puede añadir palabras o frases a las excepciones. Después, no se considerarán errores.
Solicitar parámetros
Lista de excepciones
https://api.textgears.com/custom/listexceptions
Lista de palabras de exclusión añadidas previamente
Solicitar parámetros
Eliminar excepción
https://api.textgears.com/custom/deleteexception
Elimine la palabra de excepción para su comprobación. Si se intenta eliminar una palabra previamente eliminada, no se produce ningún error.