Метод checkText
Описание
SpellResult checkText(string text, string lang, int options)
Проверяет орфографию в указанном отрывке текста.
Страница для демонстрации работы метода: https://speller.yandex.net/services/spellservice?op=checkText
Входные параметры
Входные параметры могут передаваться либо с помощью запроса HTTP(S) GET (см. пример ниже), либо с помощью HTTP(S) POST. Во втором случае параметры передаются в теле запроса.
Параметры запроса должны быть переданы в кодировке UTF-8.
Пример запроса:
XML-интерфейс:
https://speller.yandex.net/services/spellservice/checkText?text=синхрафазатрон+в+дубне
JSON-интерфейс:
https://speller.yandex.net/services/spellservice.json/checkText?text=синхрафазатрон+в+дубне
JSONP-интерфейс (для функции myCallback):
Ниже приводится полный список входных параметров.
Параметр |
Тип |
Описание |
Обязательные |
||
|
|
Текст для проверки. Ограничения:
|
Необязательные |
||
|
|
Языки проверки (перечисляются через запятую). Возможные значения:
По умолчанию: |
|
|
Опции Яндекс Спеллера. Значением параметра является сумма значений требуемых опций, см. Настройки Яндекс Спеллера. Например, |
|
|
Формат проверяемого текста. Возможные значения:
|
|
|
Имя функции обратного вызова (только для JSONP-интерфейса).
Например: |
Возвращает
В 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": [ "Дубне" ]
}
])