API Адвего Лингвиста - проверка качества текстов
На запросы отвечает сервис по адресу https://api.advego.com/json/
API Лингвиста доступен пользователям, на символьном счету которых находится не менее 100 тысяч символов.
Пополнение символьного счета: https://advego.com/antiplagiat/buy/
Базовая стоимость проверки - 1,2 руб. / 0,01 у. е. за 1000 символов с пробелами.
При покупке пакета символов доступны скидки до 50%.
-----
Токен для API используется общий с токеном для Антиплагиата (рекомендуем обновить перед первым использованием): https://advego.com/antiplagiat/api/
Токен должен передаваться в каждом запросе. Токен не имеет срока действия и может быть перегенерирован на той же странице.
-------
В качестве протокола используется json-rpc 2.0. Стандартный запрос выглядит следующим образом (id используется для сопоставления запроса с ответом):
{"jsonrpc": "2.0", "method": "...", "params": { …. }, "id": 1 }
-------
Форматирование текста для проверки:
- Для передачи переноса строк необходимо использовать тег \n
- HTML-теги автоматически удаляются при проверке, в проверяемом объеме не учитываются и на качество проверки не влияют, но остаются видны в полном тексте проверки на сайте.
Важно! Если в проверяемом тексте встречаются кавычки вида "", их необходимо экранировать:
"слово" -> \"слово\"
<a href="https://advego.com">АНКОР</a> -> <a href=\"https://advego.com\">АНКОР</a>
Также нужно экранировать символ обратного слеша \, если он используется сам по себе:
\слово -> \\слово
Не нужно экранировать символ \, если он экранирует кавычки или является частью тега переноса строки \n.
-------
Методы
-------
1. Добавление текста на проверку
linguist.checking_text
Параметры:
• token — токен для авторизации;
• text — текст для проверки; Важно! Если в тексте есть переносы строк (абзацы, списки и т. п.) их нужно заменить на символ "\n" без кавычек.
-----
Пример запроса:
{
"jsonrpc": "2.0",
"method": "linguist.checking_text",
"id": 1,
"params":
{
"appid": "",
"token": "TOKEN",
"text": "Прекрасным дополнением в интерьере вашей комнаты стал аквариум. Но теперь возникли вопросы, как сделать его красивым и пригодным для обитания растений и рыбок. Особое внимание нужно уделить грунту для аквариумов. Ошибаются те, кто считает его лишь элементом декоративности и красоты. На самом деле грунт для аквариумов – это своеобразный биологический фильтр, в нем живут бактерии, перерабатывающие продукты жизнедеятельности рыбок, растут растения. К тому же некоторые виды рыб любят рыться, копаться в грунте, искать в нем корм, метать икру."
}
}
-----
Ответ:
{
"result": {
"id_result": "10"
},
"jsonrpc": "2.0",
"id": 1
}
Для дальнейших запросов (выгрузка результатов и т. п.) необходимо использовать значение "id_result": "10".
-----
2. Выгрузка списка проверок
linguist.get_checking_list
Параметры:
• token — токен для авторизации;
-----
Пример запроса:
{
"jsonrpc": "2.0",
"id": 1,
"method": "linguist.get_checking_list",
"params":
{
"appid": "",
"token": "TOKEN"
}
}
Ответ:
"result": [
{
"header": "Прекрасным дополнением в интерьере вашей комнаты стал аквариум. Но теперь возникли вопросы, как сдел...",
"date": "2023-12-14 01:41:09",
"id_result": "10"
}
],
"jsonrpc": "2.0",
"id": 1
}
-----
3. Выгрузка результатов проверки
linguist.get_checking_result
Параметры:
• token — токен для авторизации;
• id_result — id проверки.
Пример запроса:
{
"jsonrpc": "2.0",
"id": 1,
"method": "linguist.get_checking_result",
"params":
{
"appid": "",
"token": "TOKEN",
"id_result":"10"}
}
Ответ:
{
"jsonrpc": "2.0",
"result": {
"result": {
"stat": {
"estimation": "72.77",
"text_length": 78,
"phrases_number": 8,
"symbols": 543,
"insignificant_phrases": 2,
"common_phrases": 6
},
"phrases": {
"1": [
{
"decision": "Добавить факты и преобразовать в конкретность.",
"explanation": "Не несет информационной нагрузки, вводит в заблуждение размытостью формулировки и провоцирует недоверие.",
"type": "Неопределенность",
"list": [
[
19
]
],
"phrase": "теперь",
"dphtype": "Неопределенность",
"category": "Общие фразы",
"sample": "Плохо:\nТеперь древесина не будет рассыхаться.\nХорошо:\nОбработайте стены деревянного дома защитным составом, и древесина не будет рассыхаться.\nПри обработке стен деревянного дома защитным составом древесина не будет рассыхаться.",
"num": 1
}
],
"2": [
{
"type": "Менторство",
"list": [
[
47,
48,
49,
50,
51
]
],
"decision": "Заменить скрыто-повелительную форму на описательную или дать четкие инструкции без поучения.",
"explanation": "Информация в поучающей форме провоцирует \"обратный эффект\": я сам знаю, что нужно. Задача текста – предоставить информацию, на основании которой читатель сам примет решение.",
"category": "Незначимые фразы",
"num": 2,
"sample": "",
"phrase": "особое внимание нужно",
"dphtype": "Менторство"
}
],
...,
"fragments": [
{
"num": -1,
"text": "Прекрасным дополнением в интерьере вашей комнаты стал аквариум. Но "
},
{
"text": "теперь",
"num": "1"
},
{
"num": -1,
"text": " возникли вопросы, как сделать его красивым и пригодным для обитания растений и рыбок. "
},
{
"text": "Особое внимание нужно",
"num": "2"
},
{
"text": " уделить грунту для аквариумов. Ошибаются ",
"num": -1
},
...,
"text": [
"Прекрасным",
" ",
"дополнением",
" ",
"в",
" ",
"интерьере",
" ",
"вашей",
" ",
"комнаты",
...,
"header": "Прекрасным дополнением в интерьере вашей комнаты стал аквариум. Но теперь возникли вопросы, как сдел...",
"id_result": "10",
"date": "2023-12-14 01:41:09"
},
"id": 1
}
-----
Расшифровка параметров:
estimation - оценка качества текста в баллах (максимум - 100.00).
Градация оценок:
- 90 и выше: отлично;
- 85 - 90: хорошо (текст хорошо читается, но проверьте, не слишком ли он формализован или обобщен);
- 80 - 85: удовлетворительно (в тексте заметно часто встречается канцелярит, общие фразы и штампы);
- ниже 80: неудовлетворительно (текст читается как водянистый, неконкретный)
text_length - общее количество слов в тексте.
symbols - объем текста в символах без пробелов.
phrases_number - общее количество фраз, ухудшающих качество текста.
insignificant_phrases - количество малозначимых фраз.
common_phrases - количество общих фраз.
text - проверяемый текст, разбитый на элементарные единицы: слова, пробелы, знаки препинания. Нумерация элементов используется в дальнейшем для выделения фраз по номерам элементов. Нумерация начинается с 1.
phrases - найденные фразы с подробным комментарием по каждой фразе (немеруются, начиная с 1):
- phrase - фраза,
- num - номер фразы по порядку,
- category - тип фразы (малозначимая или общая),
- type, dphtype - разновидность фразы (неопределеность, менторство и т. д.),
- explanation - объяснение проблемности фразы,
- decision - рекомендации по решению проблемности или улучшению фразы,
- sample - примеры применения в текстах (удачные и неудачные),
- list - список номеров элементов, из которых состоит фраза, в соответствии с нумерацией элементов из параметра text.
fragments - текст, разбитый на фрагменты: последовательный набор из найденных фраз и оставшегося текста:
- text - текстовый фрагмент,
- num - номер найденной фразы по порядку (нумерация начинается с 1). Если значение равно минус 1, фрагмент относится к остальному тексту.
header - название проверки. Если не задано, то берутся первые 100 символов проверяемого текста.
id_result - уникальный id проверки.
date - дата и время проверки (UTC +0).