ВебмастерМетрикаВиджетыРекламная сетьДиректПоиск для сайтаAPI
ещё
Найти

Спеллер:

Войти

Руководство разработчика

В формате PDF
← Ctrl предыдущаяследующая Ctrl →

Метод checkText

Описание

SpellResult checkText(string text, string lang, int options)

Проверяет орфографию в указанном отрывке текста.

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

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

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

См. также замечание о кодировке входных запросов.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Например, options=5 - это сумма опций IGNORE_UPPERCASE и IGNORE_URLS. По умолчанию options = 0.
format string

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

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

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

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

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

Возвращает

В XML-интерфейсе возвращает ответ в виде XML-документа с корневым элементом SpellResult. Например: 

<?xml version="1.0" encoding="utf-8" ?>
<SpellResult>
   <error code="1" pos="0" row="0" col="0" len="14">
      <word>синхрофазатрон</word>
      <s>синхрофазотрон</s>
   </error>
   <error code="3" pos="17" row="0" col="17" len="5">
      <word>дубне</word>
      <s>Дубне</s>
   </error>
</SpellResult>

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

  • SpellResult – корневой элемент;
  • 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": 17, "row": 0, "col": 17, "len": 5,
     "word": "дубне",
     "s": [ "Дубне" ]
   }
]

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

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