Метод 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):
Ниже приводится полный список входных параметров.
Параметр |
Тип |
Описание |
Обязательные |
||
|
|
Массив текстов для проверки. Ограничения:
|
Необязательные |
||
|
|
Языки проверки (перечисляются через запятую). Возможные значения:
|
|
|
Опции Яндекс Спеллера. Значением параметра является сумма значений требуемых опций, см. Настройки Яндекс Спеллера.
Например, |
|
|
Формат проверяемого текста. Возможные значения:
|
|
|
Имя функции обратного вызова (только для JSONP-интерфейса).
Например: |
Возвращает
В 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": [ "Дубне" ]
}
]
])