Api проверка текста на ошибки

• Javascript

                                                    
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) => {});
                                                    
                                                

Проверка грамматики текста

https://api.textgears.com/grammar

Метод позволяет проверить текст на грамматические, орфографические, пунктуационные и стилистические ошибки.

Параметры запроса

https://api.textgears.com/grammar?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

                                            
{
    status : true, // false in case of checking error
    response : {
        errors : [  // array of errors info
            0 : {
                id : "e492411846",  // unique error id
                offset : 2,  // error text offset
                length : 2,  // error text length
                bad : "is",  // error text
                better : [  // array of suggestions
                    0 : "am"
                ],
                type : "grammar"
            },
            1 : {
                id : "e627659964",  // unique error id
                offset : 8,  // error text offset
                length : 8,  // error text length
                bad : "engeneer",  // error text
                better : [  // array of suggestions
                    0 : "engineer",
                    1 : "engender"
                ],
                type : "spelling"
            }
        ]
    }
}
                                            
                                        

Проверка орфографии текста

https://api.textgears.com/spelling

Метод проверяет текст по актуальному словарю на опечатки

Параметры запроса

https://api.textgears.com/spelling?key=DEMO_KEY&text=I+is+an+engeneer!&language=en-GB

                                            
{
    status : true, // false in case of checking error
    response : {
        errors : [  // array of errors info
            0 : {
                id : "e627659964",  // unique error id
                offset : 8,  // error text offset
                length : 8,  // error text length
                bad : "engeneer",  // error text
                description: "Error description",
                better : [  // array of suggestions
                    0 : "engineer",
                    1 : "engender"
                ],
                type : "spelling"
            }
        ]
    }
}
                                            
                                        

Автокоррекция текста

https://api.textgears.com/correct

Есть два метода для автоматического исправления текста.
Метод correct заметно точнее, но относится к AI-запросам.

Параметры запроса

https://api.textgears.com/suggest

Система проверки автоматически исправляет ошибки в тексте и предлогает продолжение последнего предложения.

Параметры запроса

https://api.textgears.com/suggest?key=DEMO_KEY&text=I+is+an+engeneer!+My+na

                                            
{
    status : true,  // false in case of checking error
    response : {
        corrected : "My name is Seth. My family",  // corrected text
        suggestions : [  // array of suggested text endings
            0 : {
                text : "My name is Seth. My family wishes",
                next_word : "wishes"
            },
            1 : {
                text : "My name is Seth. My family traditions",
                next_word : "traditions"
            },
            2 : {
                text : "My name is Seth. My family together",
                next_word : "together"
            },
            3 : {
                text : "My name is Seth. My family support",
                next_word : "support"
            },
            4 : {
                text : "My name is Seth. My family respectfully",
                next_word : "respectfully"
            }
        ]
    }
}
                                            
                                        

Читабельность текста

https://api.textgears.com/readability

Расчет читабельности (readability) текста по наиболее распространенным алгоритмам и их адаптациям
для большинства языков. Более подробно о метриках читабельности можно
прочитать нашу отдельную статью.

Параметры запроса

https://api.textgears.com/readability?key=DEMO_KEY&text=...

                                            
{
    status : true,  // false in case of checking error
    response : {
        stats : {
            fleschKincaid : { // Flesch–Kincaid index (https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests)
                readingEase : 53.4, // Index value
                grade : "10th to 12th grade", // Flesch–Kincaid grade
                interpretation : "Fairly difficult to read" // index value interpretation
            },
            gunningFog : 12.2, // https://en.wikipedia.org/wiki/Gunning_fog_index
            colemanLiau : 12, // https://en.wikipedia.org/wiki/Coleman–Liau_index
            SMOG : 12, // https://en.wikipedia.org/wiki/SMOG
            vocabularySize : {
                active : null, // How many words author uses every day
                passive : null // How many words author knows
            },
            emotion : { // text emotion classifier
                positive : 0.79,
                negative : 0.21
            },
            counters : {
                length : 1128,
                clearLength : 936,
                words : 187,
                sentences : 10
            }
        }
    }
}
                                            
                                        

Анализ текста

https://api.textgears.com/analyze

Комплексный анализ текста. Находит все виды ошибок, рассчитывает метрики читабельности,
дает оценку правописанию на 100-бальной шкале,
а также дает оценку эмоциональному настроению текста

Параметры запроса

https://api.textgears.com/analyze?key=DEMO_KEY&text=...

                                            
{
    status : true, // false in case of checking error
    response : {
        grammar: {
            errors : [  // array of errors info
                0 : {
                    id : "e492411846",  // unique error id
                    offset : 2,  // error text offset
                    length : 2,  // error text length
                    description: "Error description",
                    bad : "is",  // error text
                    better : [  // array of suggestions
                        0 : "am"
                    ],
                    type : "grammar"
                },
                1 : {
                    id : "e627659964",  // unique error id
                    offset : 8,  // error text offset
                    length : 8,  // error text length
                    bad : "engeneer",  // error text
                    description: "Error description",
                    better : [  // array of suggestions
                        0 : "engineer",
                        1 : "engender"
                    ],
                    type : "spelling"
                }
            ],
        },
        stats: {
             fleschKincaid : { // Flesch–Kincaid index (https://en.wikipedia.org/wiki/Flesch–Kincaid_readability_tests)
                readingEase: 63.3, // Index value
                grade : "8th or 9th grade", // Flesch–Kincaid grade
                interpretation: "Plain English. Easily understood by 13- to 15-year-old students", // index value interpretation
             }
            gunningFog : 9.4, // https://en.wikipedia.org/wiki/Gunning_fog_index
            colemanLiau : 12, // https://en.wikipedia.org/wiki/Coleman–Liau_index
            SMOG : 6.5, // https://en.wikipedia.org/wiki/SMOG
            vocabularySize : {
                active: 5000, // How many words author uses every day
                passinve: 60000, // How many words author knows
            }
            emotion: { // text emotion classifier
                positive: 0.79, // probability
                negative: 0.21,
            }
        }
    }
}
                                            
                                        

Определение языка

https://api.textgears.com/detect

Определение языка текста и предположение о его диалекте.
Метод возвращает массив вероятностей для каждого языка.
Если не удается однозначно определить язык, в поле language
возвращается null

Параметры запроса

https://api.textgears.com/detect?key=DEMO_KEY&text=...

                                            
{
    status : true, // false in case of checking error
    response : {
        language : "en", // null if language was not detected
        dialect : "en-GB", // language dialect suggestion
        probabilities : { // descending
            "en" : 0.95,
            "fr" : 0.61,
            "ge" : 0.60,
            "fi" : 0.51,
        }
    }
}
                                            
                                        

Суммаризация и извлечение ключевых слов

https://api.textgears.com/summarize

Параметры запроса

https://api.textgears.com/summarize?key=DEMO_KEY&language=en-GB&text=...

                                            
{
    status : true,  // false in case of checking error
    response : {
        keywords : [
            0 : "text",
            1 : "readability",
            2 : "english",
            3 : "printing",
            4 : "fewer",
            5 : "words",
            6 : "terms",
            7 : "higher",
            8 : "features",
            9 : "indexes"
        ],
        highlight : [ // Most important paragraph, starting with main sentence
            0 : "The two main factors of readability are the printing and linguistic features of the text.",
            1 : "In other words, pages containing simple and clear text get higher positions in the search results."
        ],
        summary : [ // Text summary sentences
            0 : "The two main factors of readability are the printing and linguistic features of the text.",
            1 : "The Flesch Kinkaid Score is the most popular way to measure the readability of English text.",
            2 : "It works on the principle of “the fewer words in the text, and the fewer syllables in them, the easier it is to perceive” and is most often used for checking essays in schools and universities."
        ]
    }
}
                                            
                                        

Данные тарифной квоты

https://api.textgears.com/account/resourcequota

Получение данных текущией тарифной квоты. Метод можно использовать чтобы следить за тем,
сколько запросов в рамках тарифа уже сделано, сколько запросов еще можно сделать
в рамках периода тарификации

Параметры запроса

Статистика использования

https://api.textgears.com/account/usage

Получение статистики использования API вашим аккаунтом с разбивкой по днях

Параметры запроса

Создание и редактирование словарей

https://api.textgears.com/custom/createdictionary

Если вам нужна гибкая настройка проверки текста на ошибки, воспользуйтесь настройкой кастомных исключений. Это будет особенно удобно компаниям, работающим с текстами, изобилующими специальной лексикой. Отмечайте слова или словосочетания как «правильные» чтобы система перестала считать их ошибочными или наоборот – чтобы система находила ошибку при появлении заданных вами слов.
Кастомные правила проверки можно объединять в словари. Чтобы, например, разные функции вашего продукта использовали разный набор правил. Или чтобы каждый пользователь вашего продукта мог иметь свой собственный набор исключений.

Параметры запроса

https://api.textgears.com/custom/updatedictionary

https://api.textgears.com/custom/listdictionaries

https://api.textgears.com/custom/deletedictionary

Добавить исключение

https://api.textgears.com/custom/addexception

Если вы проверяете тексты с очень специфической лексикой, которая
помечается нашей системой как ошибочная, вы можете добавить
слова или словосочетания в исключения. После этого они не будут считаться ошибочными.

Параметры запроса

https://api.textgears.com/custom/addexception?text=foobaring&type=2&lang=en-US&key=DEMO_KEY

                                            
{
    status : true,
    response : {
        id: 20, // New exception id
        text: "foobaring",
        type: 1,
        lang: "en-US",
        creation_time: "2023-06-08T19:20:10+0000",
        suggestions: [],
        update_time: null,
        description: null,
    },
}
                                            
                                        

Список исключений

https://api.textgears.com/custom/listexceptions

Вывод списка ранее добавленных слов-исключений

Параметры запроса

https://api.textgears.com/custom/addexception?text=foobaring&key=DEMO_KEY

                                            
{
    status : true,
    response : {
        exceptions : [
            {
                id: 20,
                text: "foobaring",
                type: 1,
                lang: "en-US",
                creation_time: "2023-06-08T19:20:10+0000",
                update_time: null,
                description: null,
            },
        ],
    },
}
                                            
                                        

Удалить исключение

https://api.textgears.com/custom/deleteexception

Удалить слово-исключение для проверки. Если попытаться удалить ранее удаленное, то ошибки не возникает

Параметры запроса

https://api.textgears.com/custom/deleteexception?id=20&key=DEMO_KEY

                                            
{
    status : true,
    response : {}
}
                                            
                                        

Входные параметры:

• text — проверяемый текст на уникальность от 100 до 150000 символов (обязательный);
• userkey — ваш персональный секретный ключ (обязательный);
• exceptdomain — домены, которые вы хотите исключить из проверки. Домены разделяются пробелами или запятыми (необязательный);
• excepturl — ссылки, которые вы хотите исключить из проверки. Ссылки разделяются пробелами или запятыми (необязательный);
• visible — доступность результатов проверки другим пользователям. По-умолчанию — результаты проверки (https://text.ru/antiplagiat/{your_text_uid}) доступны только вашему аккаунту. Если вы хотите, чтобы результаты проверок были открыты, необходимо передать значение vis_on (необязательный);
• copying — если вы не хотите, чтобы формировалась ссылка с визуальным оформлением результатов проверки https://text.ru/antiplagiat/{your_text_uid}, то необходимо передать значение noadd (необязательный);
• callback — ваш URL (ссылка), на которую мы отправим POST-запрос с результатами проверки сразу же после её окончания. Подробности указаны ниже (необязательный).

Выходные параметры:

Если текст успешно добавился, возвращается один параметр:

• text_uid — уникальный идентификатор текста. Используется при последующем получении результатов проверки.

В случае возникновения ошибки возвращаются следующие параметры:

• error_code — код ошибки;
• error_desc — описание ошибки.

$body = [
    'userkey' => '<USERKEY>',
    // Проверяемый текст
    'text' => '<TEXT>',
    // Ссылка, на которую нужно отправить результат проверки
    'callback' => 'https://your-site.com/callback',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.text.ru/post');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));

$rawResponse = curl_exec($ch);

if (curl_errno($ch)) {
    throw new Exception('Ошибка curl: ' . curl_error($ch));
}

curl_close($ch);

$response = json_decode($rawResponse, true);

print_r($response); // ['text_uid' => '63c129651c171']

const axios = require('axios');

const client = axios.create({
    baseURL: 'https://api.text.ru'
});

const body = {
    userkey: '<USERKEY>',
    // Проверяемый текст
    text: '<TEXT>',
    // Ссылка, на которую нужно отправить результат проверки
    callback: 'https://your-site.com/callback'
};

client
    .post('/post', body)
    .then((response) => {
        console.log(response.data);
    })
    .catch((err) => {
        console.error(err);
    })
;

Входные параметры:

• uid — уникальный идентификатор текста. Берется из метода addText (обязательный);
• userkey — ваш персональный секретный ключ (обязательный);
• jsonvisible — если вы хотите получить более детальную информацию о результатах проверки (дополнительные параметры смотрите ниже), то необходимо передать значение detail (необязательный).

Выходные параметры:

Если текст успешно проверен, возвращаются два параметра:

• text_unique — уникальность текста в процентах с точностью до 2 знаков после запятой;
• result_json — дополнительная информация о результатах проверки на уникальность в формате json. Структура json-ответа расшифрована ниже;
• spell_check — (доступен с опцией jsonvisible) дополнительная информация о результатах проверки на правописание в формате json.
  Структура json-ответа расшифрована ниже;
• seo_check — (доступен с опцией jsonvisible) дополнительная информация о результатах проверки на SEO-анализ в формате json.
  Структура json-ответа расшифрована ниже.

Если текст ещё не проверился или произошла ошибка при проверке, возвращаются следующие параметры:

• error_code — код ошибки;
• error_desc — описание ошибки.

$body = [
    'userkey' => '<USERKEY>',
    'uid' => '<UID>',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.text.ru/post');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));

$rawResponse = curl_exec($ch);

if (curl_errno($ch)) {
    throw new Exception('Ошибка curl: ' . curl_error($ch));
}

curl_close($ch);

$response = json_decode($rawResponse, true);

print_r($response);

const axios = require('axios');

const client = axios.create({
    baseURL: 'https://api.text.ru'
});

const body = {
    userkey: '<USERKEY>',
    uid: '<UID>'
};

client
    .post('/post', body)
    .then((response) => {
        console.log(response.data);
    })
    .catch((err) => {
        console.error(err);
    })
;

• date_check — дата окончания проверки текста на сервере;
• unique — уникальность текста в процентах, с точностью до 2 знаков после запятой;
• urls — массив ссылок, для которых известно:
  • url — текст ссылки;
  • plagiat — процент совпадения текста по ссылке;
  • words — (доступен с опцией jsonvisible) номера позиций «совпадающих» слов в тексте (clear_text — см. ниже). Нумерация начинается с 0.
• clear_text — (доступен с опцией jsonvisible) очищенный от служебных символов и знаков препинания ваш текст, состоящий из слов, разделенных через пробел.

Посмотреть пример JSON-ответа

{
«date_check»:»29.03.2017 14:46:49″,
«unique»:0,
«clear_text»:»Wikipedia was launched оn January 15 2001 by Jimmy Wаles and Larry Sanger 11 Sanger coined its name 12 13 a portmanteau of wiki notes 4 and encyclopedia Therе was only the English language version initially but it quickly developed similar versions in other languages which differ in content and in editing practices With 5 466 824 articles notes 5 the English Wikipedia is the largest of the more than 290 Wikipedia encyclopedias Overall Wikipedia consists of more than 40 million articles in more than 250 different languages 15 and as of February 2014 it had 18 billion page views and nearly 500 million unique visitors each month»,
«mixed_words»:»4 10 29″,
«urls»:[
{
«url»:»https://en.wikipedia.org/wiki/Wikipedia»,
«plagiat»:100,
«words»:»0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107″
}
]
}

Проверка текста на правописание работает параллельно и независимо с проверкой на уникальность. К примеру, текст может провериться на правописание раньше, чем на уникальность. В этом случае результаты по правописанию уже будут доступны в ответе, в то время как для получения результатов проверки на уникальность понадобятся дополнительные запросы.

Проверка на правописание гарантированно не может найти все ошибки. Мы постоянно работаем над улучшением алгоритма. С примерами его работы вы можете ознакомиться в бесплатной версии через форму на сайте.

Если проверка на правописание ещё не завершена, то параметр spell_check будет равен пустой строке.
По завершению проверки параметр spell_check примет json-представление массива, элементы которого состоят из:

• error_type — тип ошибки (‘Орфография’, ‘Пунктуация’ и т.д.);
• reason — детальное описание ошибки;
• error_text — текст фрагмента, в котором обнаружилась ошибка;
• replacements — массив с предлагаемыми вариантами замены (может быть пустым);
• start — начальная позиция фрагмента, в котором найдена ошибка;
• end — конечная позиция фрагмента, в котором найдена ошибка.

Посмотреть пример JSON-ответа

[
{
«error_type»:»Spelling»,
«replacements»:[
«milk»,
«mild»,
],
«reason»:»Spelling error found»,
«error_text»:»mildd»,
«start»:255,
«end»:272
},
{
«error_type»:»Capital letters»,
«replacements»:[
«Hello»
],
«reason»:»This sentence doesn’t start with a capital letter»,
«error_text»:»hello»,
«start»:276,
«end»:287
}
]

Проверка текста на SEO-анализ работает параллельно, как и проверка текста на правописание. Текст на SEO-анализ может провериться раньше, чем на уникальность. В этом случае для получения результатов проверки на уникальность понадобятся дополнительные запросы до готовности ответа от API.

Если проверка на SEO-анализ ещё не завершена, то параметр seo_check будет равен пустой строке.
По завершению проверки параметр seo_check примет следующее json-представление:

• count_chars_with_space — количество символов с пробелами;
• count_chars_without_space — количество символов без пробелов;
• count_words — количество слов в тексте;
• water_percent — процент воды;
• spam_percent — процент заспамленности;
• mixed_words — номера позиций слов в тексте, у которых присутствуют символы из разных алфавитов и имеющих схожее написание. Нумерация начинается с 0.
• list_keys — список ключей в тексте, отсортированных по частоте встречаемости:
  • key_title — текст ключа;
  • count — количество вхождений ключа в текст во всех формах.
• list_keys_group — список ключей в тексте, отсортированных по числу значимых слов и сгруппированных по составу слов:
  • key_title — текст ключа;
  • count — количество вхождений ключа в текст во всех формах.
  • sub_keys — список подключей:
  • key_title — текст подключа;
  • count — количество вхождений подключа в текст во всех формах.

Посмотреть пример JSON-ответа

{
«count_chars_with_space»:620,
«count_chars_without_space»:545,
«count_words»:77,
«water_percent»:11,
«spam_percent»:38,
«mixed_words»:[8,11,47],
«list_keys»:[
{
«key_title»:»check»,
«count»:6
},
{
«key_title»:»text»,
«count»:5
},
{
«key_title»:»antiplagiat»,
«count»:3
},
{
«key_title»:»check text»,
«count»:3
}
],
«list_keys_group»:[
{
«key_title»:»check text»,
«count»:3,
«sub_keys»:[
{
«key_title»:»check»,
«count»:6
},
{
«key_title»:»text»,
«count»:5
}
]
},
{
«key_title»:»antiplagiat»,
«count»:3,
«sub_keys»:[]
},
{
«key_title»:»check»,
«count»:6,
«sub_keys»:[]
},
{
«key_title»:»text»,
«count»:5,
«sub_keys»:[]
},
]
}

Проверка текста на уникальность занимает определенное (заранее неизвестное) время. Если вы хотите получить уведомление о факте завершения (вместе с результатами) проверки вашего текста, то вы можете при добавлении текста на API в параметре callback указать адрес вашего скрипта, который обработает наш POST-запрос с результатами проверки текста.

• Чтобы убедиться, что вы успешно получили результат, на вашей странице должно отобразиться ok и ничего более (echo «ok»;).
• Максимальное число попыток отправки результатов проверки — 3.
• В callback POST-запросе отправляются 4 параметра: uid, text_unique, json_result, spell_check. Структура json-ответа такая же, что и при ручном запросе результата (без атрибутов clear_text и words).
• Если проверка на правописание закончится позже проверки на уникальность, то будет отправлено 2 callback-запроса по мере окончания проверок (во время первого запроса параметр spell_check будет равен пустой строке).
• Получить результаты проверки на уникальность также можно и вручную.

* Разрешено добавлять не более 3 млн. символов в час на проверку. При превышении данного лимита будет возвращена ошибка с кодом 429. Лимит восстанавливается в начале каждого часа.

Адрес для запроса: http://api.text.ru/account

POST-параметры запроса:

• method — ‘get_packages_info‘ (обязательный);
• userkey — ваш персональный секретный ключ (обязательный);

Результат запроса (в формате json):

• size — суммарный остаток символов по всем пакетам;

Внимание! В целях безопасности, чтобы ваш IP-адрес не заблокировался, не рекомендуется обращаться к данному методу чаще 2 раз в минуту.

$body = [
    'userkey' => '<USERKEY>',
    'method' => 'get_packages_info',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.text.ru/account');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));

$rawResponse = curl_exec($ch);

if (curl_errno($ch)) {
    throw new Exception('Ошибка curl: ' . curl_error($ch));
}

curl_close($ch);

$response = json_decode($rawResponse, true);

print_r($response); // ['size' => 1000]

const axios = require('axios');

const client = axios.create({
    baseURL: 'https://api.text.ru'
});

const body = {
    userkey: '<USERKEY>',
    method: 'get_packages_info'
};

client
    .post('/account', body)
    .then((response) => {
        console.log(response.data);
    })
    .catch((err) => {
        console.error(err);
    })
;