Метод checkTexts

Описание

SpellResult[] checkTexts(string[] text, string lang, int options)

Проверяет орфографию в указанных фрагментах текста. Для каждого фрагмента возвращается отдельный массив ошибок с подсказками.

Страница для демонстрации работы метода: https://speller.yandex.net/services/spellservice?op=checkTexts

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

Входные параметры могут передаваться либо с помощью HTTP(S) GET-запроса (см. пример), либо с помощью HTTP(S) POST-запроса, где параметры передаются в теле запроса. .

Параметры запроса должны быть переданы в кодировке UTF-8.

Пример запроса:

XML-интерфейс:

https://speller.yandex.net/services/spellservice/checkTexts?text=синхрафазатрон&text=в+дубне

JSON-интерфейс:

https://speller.yandex.net/services/spellservice.json/checkTexts?text=синхрафазатрон&text=в+дубне

JSONP-интерфейс (для функции myCallback):

https://speller.yandex.net/services/spellservice.json/checkTexts?text=синхрафазатрон&text=в+дубне&callback=myCallback

Ниже приводится полный список входных параметров.

Параметр Тип Описание
Обязательные
text string[]

Массив текстов для проверки.

Ограничения:

  • Для POST-запросов максимальный размер передаваемого текста составляет 10000 символов.
  • В GET-запросах ограничивается не размер передаваемого текста, а размер всей строки запроса, которая кроме текста может содержать и другие параметры. Максимальный размер строки запроса — 10Кб (в Internet Explorer 6 и 7 — 2Кб).
Необязательные
lang string

Языки проверки (перечисляются через запятую).

Возможные значения:

  • ru — русский;
  • uk — украинский;
  • en — английский.

По умолчанию: "ru,en".

options int

Опции Яндекс.Спеллера. Значением параметра является сумма значений требуемых опций, см. Настройки Яндекс.Спеллера.

Например, options=6 — это сумма опций IGNORE_DIGITS и IGNORE_URLS. По умолчанию options=0.

format string

Формат проверяемого текста.

Возможные значения:

  • plain — текст без разметки (значение по умолчанию);
  • html — HTML-текст.
callback string

Имя функции обратного вызова (только для JSONP-интерфейса).

Например: "myCallback".

Возвращает

В XML-интерфейсе возвращает элемент ArrayOfSpellResult, содержащий последовательность элементов SpellResult по одному для каждого фрагмента текста. Например:

<ArrayOfSpellResult>
   <SpellResult>
      <error code="1" pos="0" row="0" col="0" len="14">
         <word>синхрафазатрон</word>
         <s>синхрофазотрон</s>
      </error>
   </SpellResult>
   <SpellResult>
      <error code="3" pos="2" row="0" col="2" len="5">
         <word>дубне</word>
         <s>Дубне</s>
      </error>
   </SpellResult>
</ArrayOfSpellResult>

Элементы XML-схемы ответа:

  • ArrayOfSpellResult — корневой элемент, содержит элементы SpellResult по одному для каждого фрагмента текста;
  • SpellResult — результат проверки одного фрагмента текста. Если найдены ошибки, то элемент будет содержать последовательность элементов error.
  • error — информация об ошибке (может быть несколько или могут отсутствовать);
  • word — исходное слово;
  • s — подсказка (может быть несколько или могут отсутствовать).

Элемент <error> содержит следующие атрибуты:

  • code — код ошибки;
  • pos — позиция слова с ошибкой (отсчет от 0);
  • row — номер строки (отсчет от 0);
  • col — номер столбца (отсчет от 0);
  • len — длина слова с ошибкой.

В JSON-интерфейсе вместо XML-элементов возвращаются JavaScript-объекты с теми же именами и семантикой:

[
   [
      { "code": 1, "pos": 0, "row": 0, "col": 0, "len": 14,
        "word": "синхрафазатрон",
        "s": [ "синхрофазотрон" ]
      }
   ],
   [
      { "code": 3, "pos": 2, "row": 0, "col": 2, "len": 5,
        "word": "дубне",
        "s": [ "Дубне" ]
      }
   ]
]

В JSONP-интерфейсе те же самые JavaScript-объекты возвращаются в callback-функции (например, myCallback):

myCallback([
   [
      { "code": 1, "pos": 0, "row": 0, "col": 0, "len": 14,
        "word": "синхрафазатрон",
        "s": [ "синхрофазотрон" ]
      }
   ],
   [
      { "code": 3, "pos": 2, "row": 0, "col": 2, "len": 5,
        "word": "дубне",
        "s": [ "Дубне" ]
      }
   ]
])