Documentação da API de verificação gramatical e ortográfica
A API TextGears permite-lhe integrar as mais recentes tecnologias para análise de texto, virtualmente a qualquer produto. De aplicações móveis simples até desenvolvimentos corporativos volumosos. A API permite-lhe verificar o texto para todos os tipos de erros de forma flexível, determinar a legibilidade do texto, avaliar o vocabulário aproximado do autor e muito mais.
Procurando um plugin para site?
Você pode adicionar facilmente verificação de texto ao seu site. Mais informações sobre o plugin e código de exemplo podem ser encontradas na página de documentação.
O que pode a API fazer?
Documentos para Postman
Você pode transferir o ficheiro de documentação da API para Postman ou qualquer outro programa de depuração HTTP. No Postman você pode definir uma chave no separador Variáveis..
Onde começar
É simples e fácil. A API está disponível para pedidos HTTP e HTTPS normais. Os dados de saída são enviados em JSON. Todos os pedidos são feitos para o servidor api.textgears.com
Para acelerar o acesso a partir de diferentes partes do mundo, colocamos servidores em 3 países: EUA, Estónia e Singapura. Ao enviar um pedido para api.textgears.com
, escolhemos o cluster mais próximo. Mas você pode fazer pedidos explicitamente para o cluster localizado mais próximo de si para reduzir o atraso na recepção de uma resposta.
https://eu.api.textgears.com
– Europe
https://us.api.textgears.com
– America
https://sg.api.textgears.com
– Asia
Todos os endpoints da API são clusters independentes de servidores. Garantimos uma capacidade de serviço de 99.9% para cada um deles. Se tal lhe parecer insuficiente, você pode alterar o cluster quando ocorrer um erro de ligação.
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) => {});
Se implementou uma biblioteca para trabalhar com a API noutra língua ou para outra framework, basta enviar-nos um link no GitHub ou no GitLab, também o publicaremos.
Línguas suportadas
A TextGears analisa o texto não tendo apenas em conta a língua do texto, mas também mantendo o dialeto em mente. Lista completa de línguas suportadas: Inglês, Francês, Alemão, Português, Italiano, Espanhol, Russo, Árabe, Japonês, Chinês, Grego
Dialetos suportados (tem que ser enviado no 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
Autorização e transferência de parâmetros
A solicitação é autorizada transferindo a sua chave entre outros parâmetros de uma das seguintes formas:
- POST parameter
key
-
GET parameter
key
?key=YOURKEY
-
Json-request
{ "key": "YOURKEY", // Other params }
-
HTTP Header
Onde YOURKEY é a sua chave.Authorization: Basic YOURKEY
Códigos de erro
Em caso de erro, o parâmetro status
terá o 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 - Chave inválida
- 606 - Língua não suportada
- 607 - Número permitido de pedidos excedido
- 500 - Erro de serviço interno desconhecido
- 501 - O comprimento do texto excede o limite da taxa
API de validação de texto
A verificar a gramática do texto
https://api.textgears.com/grammar
O método permite-lhe verificar o texto quanto a erros gramaticais, ortográficos, de pontuação e de estilo.
Parâmetros do pedido
A verfificar a ortografia do texto
https://api.textgears.com/spelling
O método verifica o texto em busca de erros de introdução usando o dicionário atualizado
Parâmetros do pedido
A corrigir automaticamente o texto
https://api.textgears.com/correct
Existem dois métodos para correção automática de texto. O método "correto" é visivelmente mais preciso, mas se aplica a solicitações de IA.
Importante!
No momento, o método funciona apenas para o idioma inglês.
Parâmetros do pedido
https://api.textgears.com/suggest
O sistema de verificação corrige automaticamente erros no texto e sugere uma continuação da última frase.
Importante!
Se for encontrado um erro de introdução, a palavra é substituída pela palavra mais próxima do dicionário. Se houver várias palavras semelhantes à detectada, então a palavra mais comum na fala moderna é escolhida. O TextGears ainda está longe de telepatia, portanto, se houver muitos erros de escrita o significado do texto final pode mudar.
Parâmetros do pedido
Legibilidade do texto
https://api.textgears.com/readability
Cálculo da legibilidade do texto de acordo com os algoritmos mais comuns e suas adaptações para a maioria das línguas. Você pode saber mais sobre métricas de legibilidade. ao ler o nosso artigo separado.
Importante!
Ao determinar métricas de texto, a precisão está diretamente relacionada ao tamanho do texto. Determinar a legibilidade ou outros parâmetros do texto para uma frase de duas palavras não faz qualquer sentido. Recomenda-se verificar textos que tenham pelo menos 30 palavras. Quanto mais, melhor.
Parâmetros do pedido
Análise de texto
https://api.textgears.com/analyze
Análise de texto abrangente. Ela encontra todos os tipos de erros, calcula métricas de legibilidade, classifica ortografia numa escala de 100 pontos e também avalia o sentimento emocional do texto.
Importante!
Ao determinar métricas de texto, a precisão está diretamente relacionada ao tamanho do texto. Determinar a legibilidade ou outros parâmetros do texto para uma frase de duas palavras não faz qualquer sentido. Recomenda-se verificar textos que tenham pelo menos 30 palavras. Quanto mais, melhor.
Parâmetros do pedido
Detecção de língua
https://api.textgears.com/detect
Determinação da língua do texto e a suposição do seu dialeto. O método retorna uma matriz de opções prováveis para cada língua. Se não for possível identificar inequivocamente a língua, o campo language
devolve null
Parâmetros do pedido
Sumarização e extração de palavras-chave
https://api.textgears.com/summarize
Parâmetros do pedido
Admin API
Cota do plano
https://api.textgears.com/account/resourcequota
Receber dados sobre a cota do plano atual. O método pode ser usado para rastrear quantos pedidos dentro do plano já foram feitos, ou quantos pedidos ainda podem ser feitos dentro do período de cobrança
Parâmetros do pedido
Estatísticas de utilização
https://api.textgears.com/account/usage
Obtendo estatísticas de uso da API para a sua conta com detalhe ao dia
Parâmetros do pedido
Criar e editar dicionários
https://api.textgears.com/custom/createdictionary
Se precisar de uma configuração flexível para verificar se há erros no texto, use a configuração de exceções personalizadas. Isto será especialmente útil para empresas que trabalham com textos cheios de palavras de um vocabulário especial. Marque palavras ou frases como “corretas” para que o sistema pare de considerá-las erros. Você também pode usá-la para permitir que o sistema encontre erros de acordo com a lista de palavras específicas. Regras personalizadas podem ser combinadas e transformadas em dicionários. Tal abordagem possibilita que as diferentes funções do seu produto usem um conjunto diferente de regras. Ao mesmo tempo, cada utilizador do seu produto pode ter o seu próprio conjunto de exceções
Parâmetros do pedido
https://api.textgears.com/custom/updatedictionary
https://api.textgears.com/custom/listdictionaries
https://api.textgears.com/custom/deletedictionary
Adicionar uma exceção
https://api.textgears.com/custom/addexception
Se estiver a verificar textos com vocabulário muito específico que esteja marcado como erros no nosso sistema, você pode adicionar palavras ou frases a exceções. Depois disso, eles não serão considerados erros.
Parâmetros do pedido
Lista de exceções
https://api.textgears.com/custom/listexceptions
Listar palavras de exclusão adicionadas anteriormente
Parâmetros do pedido
Remover exceção
https://api.textgears.com/custom/deleteexception
Remova a palavra de exceção para verificação. Se você tentar excluir uma palavra excluída anteriormente, não ocorrerá nenhum erro.