Documentazione API per il controllo ortografico e grammaticale
TextGears API permette di integrare le ultime tecnologie per l'analisi del testo virtualmente a qualsiasi prodotto. Da semplici applicazioni mobili a grandi sviluppi aziendali. L'API permette di controllare il testo per tutti i tipi di errori in modo flessibile, determinare la leggibilità del testo, valutare il vocabolario approssimativo dell'autore e molto altro.
Cerchi un plugin per il sito web?
Puoi aggiungere facilmente il controllo del testo al tuo sito web. Maggiori informazioni sul plugin e sul codice di esempio sono disponibili nella pagina della documentazione.
Cosa può fare l'API?
Docs per Postman
Puoi scaricare il file di documentazione API per Postman o qualsiasi altro programma di debug HTTP. In Postman puoi impostare una chiave nella scheda Variabili di raccolta..
Da dove cominciare
È semplice e facile. L'API è disponibile per le normali richieste HTTP e HTTPS. I dati in uscita sono inviati in JSON. Tutte le richieste sono fatte al server api.textgears.com
.
Per velocizzare l'accesso da diverse parti del mondo, abbiamo posizionato i server in 3 paesi: USA, Estonia e Singapore. Quando invii una richiesta a api.textgears.com
sceglieremo il server più vicino. Ma è possibile fare esplicitamente richieste al server situato nelle vicinanze per ridurre il ritardo nel ricevere una risposta.
https://eu.api.textgears.com
– Europe
https://us.api.textgears.com
– America
https://sg.api.textgears.com
– Asia
Tutti gli endpoint API sono server indipendenti. Garantiamo un servizio del 99,9% per ognuno di essi. Se questo ti sembra insufficiente, puoi cambiare il server quando si verifica un errore di connessione
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 avete implementato una library per lavorare con le API in un'altra lingua o per un altro framework, mandateci un link su GitHub o GitLab, e noi lo pubblicheremo.
Lingue supportate
TextGears analizza il testo non solo tenendo conto della lingua del testo, ma anche del dialetto. Elenco completo delle lingue supportate: Inglese, francese, tedesco, portoghese, italiano, spagnolo, russo, araba, giapponese, cinese, greco
I dialetti supportati (devono essere inseriti nel parametro 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
Autorizzazione e trasferimento dei parametri
La richiesta è autorizzata trasferendo la tua key among in altri parametri in uno dei seguenti modi:
- POST parameter
key
-
GET parameter
key
?key=YOURKEY
-
Json-request
{ "key": "YOURKEY", // Other params }
-
HTTP Header
Dove YOURKEY è la tua chiave.Authorization: Basic YOURKEY
Codici di errore
In caso di errore, il parametro status
avrà il valore false
.
{
status : false,
error_code : 600, // API error code
description : "Invalid license key. Go to https://textgears.com/signup.php to get one"
}
- 600 - Chiave non valida
- 606 - Lingua non supportata
- 607 - Numero consentito di richieste superato
- 500 - Errore di servizio interno sconosciuto
- 501 - La lunghezza del testo supera il limite di velocità
API di convalida del testo
Controllo della grammatica del testo
https://api.textgears.com/grammar
Il metodo permette di controllare il testo per errori grammaticali, ortografici, di punteggiatura e stilistici.
Parametri della richiesta
Controllo dell'ortografia del testo
https://api.textgears.com/spelling
Il sistema controlla il testo per gli errori di battitura utilizzando il dizionario aggiornato
Parametri della richiesta
Correzione automatica del testo
https://api.textgears.com/correct
Esistono due metodi per la correzione automatica del testo. Il metodo "correct" è notevolmente più preciso, ma si applica alle richieste di intelligenza artificiale.
Importante!
Al momento, il metodo funziona solo per la lingua inglese.
Parametri della richiesta
https://api.textgears.com/suggest
Il sistema di verifica corregge automaticamente gli errori nel testo e suggerisce una continuazione dell'ultima frase.
Importante!
Se viene trovato un errore di battitura, la parola viene sostituita con quella più vicina dal dizionario. Se ci sono più parole che sembrano simili a quella rilevata, allora viene scelta la parola più comune nel linguaggio moderno. TextGears è ancora lontano dalla telepatia, quindi se ci sono molti refusi il significato del testo finale può cambiare.
Parametri della richiesta
Leggibilità del testo
https://api.textgears.com/readability
Calcolo della leggibilità del testo secondo gli algoritmi più comuni e i loro adattamenti per la maggior parte delle lingue. Potete saperne di più sulle metriche di leggibilità. leggendo il nostro articolo specifico.
Importante!
Quando si determina la metrica del testo, l'accuratezza è direttamente correlata alla dimensione del testo. Determinare la leggibilità o altri parametri del testo per una frase di due parole non ha senso. Si raccomanda di controllare i testi che hanno almeno 30 parole. Più sono, meglio è.
Parametri della richiesta
Analisi del testo
https://api.textgears.com/analyze
Analisi completa del testo. Trova tutti i tipi di errori, calcola le metriche di leggibilità, valuta l'ortografia su una scala di 100 punti e valuta anche l'umore emotivo del testo.
Importante!
Quando si determina la metrica del testo, l'accuratezza è direttamente correlata alla dimensione del testo. Determinare la leggibilità o altri parametri del testo per una frase di due parole non ha senso. Si raccomanda di controllare i testi che hanno almeno 30 parole. Più sono, meglio è.
Parametri della richiesta
Rilevamento della lingua
https://api.textgears.com/detect
Determinazione della lingua del testo e l'ipotesi del suo dialetto. Il metodo restituisce un array di opzioni probabili per ogni lingua. Se non è possibile identificare univocamente la lingua, il campo language
restituisce null
Parametri della richiesta
Riassunto ed estrazione di parole chiave
https://api.textgears.com/summarize
Parametri della richiesta
Admin API
Piano tariffario
https://api.textgears.com/account/resourcequota
Ricevere i dati sulla tariffa corrente del piano. Il metodo può essere utilizzato per tenere traccia di quante richieste all'interno del piano sono già state fatte, o quante richieste possono ancora essere fatte entro il periodo di fatturazione
Parametri della richiesta
Statistiche di utilizzo
https://api.textgears.com/account/usage
Ricevere le statistiche di utilizzo delle API per il proprio account con una ripartizione per giorno
Parametri della richiesta
Creazione e modifica di dizionari
https://api.textgears.com/custom/createdictionary
Se hai bisogno di un'impostazione flessibile per controllare il testo per gli errori, usa l'impostazione delle eccezioni personalizzate. Questo sarà particolarmente utile per le aziende che lavorano con testi che sono pieni di parole di un vocabolario speciale. Segna parole o frasi come "corrette" in modo che il sistema smetta di considerarle errori. Si può anche usare per permettere al sistema di trovare gli errori in base alla lista di parole specifiche. Le regole personalizzate possono essere combinate e trasformate in dizionari. Un tale approccio rende possibile che le diverse funzioni del vostro prodotto utilizzino un diverso insieme di regole. Allo stesso tempo, ogni utente del vostro prodotto può avere il proprio set di eccezioni
Parametri della richiesta
https://api.textgears.com/custom/updatedictionary
https://api.textgears.com/custom/listdictionaries
https://api.textgears.com/custom/deletedictionary
Aggiungi un'eccezione
https://api.textgears.com/custom/addexception
Se stai controllando testi con un vocabolario molto specifico che è segnato come errore nel nostro sistema, puoi aggiungere parole o frasi alle eccezioni. Dopo di che, non saranno considerati errori.
Parametri della richiesta
Elenco delle eccezioni
https://api.textgears.com/custom/listexceptions
Elenco delle parole di esclusione aggiunte in precedenza
Parametri della richiesta
Rimuovere l'eccezione
https://api.textgears.com/custom/deleteexception
Elimina la parola di esclusione per il controllo. Se si tenta di cancellare una parola precedentemente eliminata, non si verifica alcun errore.