Документация

response

Результаты обработки поискового запроса, информация о котором представлена в дочерних тегах request.

Содержит атрибут date — дата и время запроса в формате <год><месяц><день>Т<час><минута><секунда> по UTC.

Состоит из следующих блоков:

Общая информация о результатах поиска

Теги блока с общей информацией о результатах поиска представлены в таблице ниже.

Теги общей информации о результатах поискаОписаниеАтрибуты
error Описание ошибки.

Присутствует только в случае некорректной обработки поискового запроса (например, при пустом запросе, некорректных параметрах и т.п.).

В некоторых случаях является взаимоисключающим с прочими тегами группирующего тега response.

code — код ошибки.
reqid Уникальный идентификатор запроса.Отсутствуют.
found

Приблизительная оценка количества документов, найденных по запросу.

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

found-human

Строка на языке, соответствующем выбранному типу поиска. Содержит сведения о количестве найденных документов и сопутствующую информацию.

Отсутствуют.

Блок misspell / reask

Опциональный. Присутствует, если в запросе найдена (misspell) или исправлена (reask) опечатка.

Теги блока представлены в таблице ниже.

Теги блоков misspell / reaskОписаниеАтрибуты
rule

Тип ошибки, найденной в запросе.

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

  • «Misspell» — опечатка.
  • «KeyboardLayout» — ошибка в раскладке клавиатуры.
  • «Volapyuk» — запрос задан на русском языке в английской транслитерации. Используется, если в качестве типа поиска выбрано значение «русский (yandex.ru)».
Отсутствуют.
source-text

Исходный текст запроса.

Фрагмент поискового запроса, предположительно содержащий ошибку, выделяется тегом hlword.

Отсутствуют.
text-to-show

Опциональный (только для группирующего тега reask).

Содержит исправленный текст поискового запроса. В большинстве случаев совпадает со значением, передаваемым в теге text.

Отсутствуют.
text Исправленный текст поискового запроса.Отсутствуют.

Блок results

Опциональный. Присутствует, если по запросу найдены результаты.

Теги блока представлены в таблице ниже.

Теги блока resultsОписаниеАтрибуты
grouping

Группирующий. Дочерние теги содержат сведения о параметрах поиска и найденных документах.

Атрибуты отражают правила группировки найденных документов.

  • mode — метод группировки;
  • attr — служебный. Зависит от значения атрибута mode;
  • groups-on-page — количество групп, возвращаемых на одной странице результатов поиска;
  • docs-in-group — количество документов, возвращаемых в одной группе;
  • curcateg — служебный. Принимает значение «-1».
found Приблизительная оценка количества сформированных групп.

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

found-docs

Приблизительная оценка количества документов, найденных по запросу.

Является более точной оценкой по сравнению со значением, передаваемым в теге found блока с общей информацией о результатах поиска.

priority — служебный. Возможные значения:

  • «phrase»;
  • «strict»;
  • «all».

found-docs-human

Строка на языке, соответствующем выбранному типу поиска. Содержит сведения о количестве найденных документов и сопутствующую информацию.

Передаваемое значение должно использоваться при оформлении результатов поиска.

Отсутствуют.
page Номер возвращенной страницы результатов поиска. Нумерация начинается с нуля (первой странице соответствует значение «0»).
  • first — порядковый номер первой группы с результатами поиска, отображаемой на странице;
  • last — порядковый номер последней группы с результатами поиска, отображаемой на странице.
group

Группирующий.

Каждый тег group содержит сведения о найденной группе документов.

Отсутствуют.
categ Идентификационные данные о группе найденных документов.
  • attr — служебный. Должен совпадать со значением, переданным в запросе;
  • name — уникальный идентификатор группы.
doccount

Приблизительная оценка количества документов, которые использованы для формирования группы.

Документы, претендующие на включение в группу, ранжируются в соответствии с условиями запроса (параметр sortby). В зависимости от значения параметра docs-in-group в группу включается от одного до трех первых документов.

Отсутствуют.
relevance

Служебный.

priority — служебный.

doc

Группирующий.

Каждый тег doc содержит информацию о найденном документе.

В зависимости от значения параметра docs-in-group каждая группа может содержать от одного до трех группирующих тегов doc.

id — уникальный идентификатор найденного документа.
url Адрес найденного документа.Отсутствуют.
domain Домен, на котором расположен найденный документ.Отсутствуют.
title

Заголовок найденного документа.

Слова, входящие в поисковый запрос, выделяются тегом hlword.

Отсутствуют.
headline

Опциональный. Аннотация документа.

Для формирования используется HTML-тег meta, содержащий атрибут name со значением «description».

Отсутствуют.
modtime

Дата и время изменения документа в формате:

<год><месяц><день>Т<час><минута><секунда>
Внимание! 

Тег является необязательным и в некоторых случаях может отсутствовать.

Отсутствуют.
size Размер найденного документа в байтах.Отсутствуют.
charset Кодировка найденного документа.Отсутствуют.
passages Группирующий тег, содержащий список пассажей документа.Отсутствуют.
passage

Пассаж с аннотацией к документу.

Слова, входящие в поисковый запрос, выделяются тегом hlword.

Максимальное количество пассажей, передаваемых в одном теге passages, определяется значением параметра maxpassages поискового запроса.

Отсутствуют.
mime-type Тип документа в соответствии с RFC2046.Отсутствуют.
properties Группирующий тег, содержащий свойства документа. Отсутствуют.
_PassagesType

Тип пассажа. Возможные значения:

  • «0» — стандартный пассаж (сформирован из текста документа);
  • «1» — пассаж на основе текста ссылки. Используется, если документ найден по ссылке.
Отсутствуют.
lang

Опциональный.

Язык документа.

Отсутствуют.
saved-copy-url Адрес сохраненной копии документа.Отсутствует.