Поиск изображений

{
  "query": {
    "search_type": "<тип_поиска>",
    "query_text": "<текст_поискового_запроса>",
    "family_mode": "<значение_настройки_фильтрации_результатов>",
    "page": "<номер_страницы>",
    "fix_typo_mode": "<значение_настройки_режима_исправления_опечаток>"
  },
  "image_spec": {
    "format": "<формат_изображения>",
    "size": "<размер_изображения>",
    "orientation": "<тип_ориентации_изображения>",
    "color": "<цвет_изображения>"
  },
  "site": "<доменное_имя_сайта>",
  "docs_on_page": "<количество_результатов_на_странице>",
  "folder_id": "<идентификатор_каталога>",
  "user_agent": "<заголовок_User-Agent>"
}

Описание полей:

• search_type — тип поиска. Возможные значения:

  • SEARCH_TYPE_RU — для типа поиска Русский.
  • SEARCH_TYPE_TR — для типа поиска Турецкий.
  • SEARCH_TYPE_COM — для типа поиска Международный.
  • SEARCH_TYPE_KK — для типа поиска Казахский.
  • SEARCH_TYPE_BE – для типа поиска Белорусский.
  • SEARCH_TYPE_UZ — для типа поиска Узбекский.

• query_text — текст поискового запроса. Максимальная длина запроса — 400 символов.

• family_mode — фильтрация результатов. Необязательный параметр. Возможные значения:

  • FAMILY_MODE_MODERATE — умеренный фильтр (значение по умолчанию). Из выдачи исключаются документы, относящиеся к категории «для взрослых», если запрос явно не направлен на поиск подобных ресурсов.
  • FAMILY_MODE_NONE — фильтрация отключена. В выдачу включаются любые документы вне зависимости от содержимого.
  • FAMILY_MODE_STRICT — семейный фильтр. Вне зависимости от поискового запроса из выдачи исключаются документы, относящиеся к категории «для взрослых», а также содержащие ненормативную лексику.

• page — номер запрашиваемой страницы. Необязательный параметр. По умолчанию возвращается первая страница поисковой выдачи. Нумерация страниц начинается с нуля, первой странице соответствует значение 0.

• fix_typo_mode — значение настройки режима исправления опечаток в поисковом запросе. Необязательный параметр. Возможные значения:

  • FIX_TYPO_MODE_ON — исправление опечаток включено (значение по умолчанию). Опечатки в тексте поискового запроса автоматически исправляются.
  • FIX_TYPO_MODE_OFF — исправление опечаток отключено. Опечатки в тексте поискового запроса не исправляются, поиск выполняется в полном соответствии с переданным запросом.

• format — поиск изображений указанного формата. Необязательный параметр. Если параметр не задан, выполняется поиск по изображениям всех форматов. Возможные значения:

  • IMAGE_FORMAT_JPEG — формат JPG.
  • IMAGE_FORMAT_GIF — формат GIF.
  • IMAGE_FORMAT_PNG — формат PNG.

• size — поиск изображений указанного размера. Необязательный параметр. Если параметр не задан, выполняется поиск по изображениям всех размеров. Возможные значения:

  • IMAGE_SIZE_ENORMOUS — изображения очень большого размера (более 1600 × 1200 в пикселях).
  • IMAGE_SIZE_LARGE — изображения большого размера (от 800 × 600 до 1600 × 1200 в пикселях).
  • IMAGE_SIZE_MEDIUM — изображения среднего размера (от 150 × 150 до 800 × 600 в пикселях).
  • IMAGE_SIZE_SMALL — изображения маленького размера (от 32 × 32 до 150 × 150 в пикселях).
  • IMAGE_SIZE_TINY — иконки (не более 32 × 32 в пикселях).
  • IMAGE_SIZE_WALLPAPER — обои для рабочего стола.

• orientation — поиск изображений с указанной ориентацией. Необязательный параметр. Если параметр не задан, выполняется поиск по изображениям с любой ориентацией. Возможные значения:

  • IMAGE_ORIENTATION_VERTICAL — изображения с вертикальной ориентацией.
  • IMAGE_ORIENTATION_HORIZONTAL — изображения с горизонтальной ориентацией.
  • IMAGE_ORIENTATION_SQUARE — изображения с равными сторонами (квадрат).

• color — поиск изображений с заданными параметрами цвета. Необязательный параметр. Если параметр не задан, выполняется поиск по изображениям с любыми цветовыми параметрами. Возможные значения:

  • IMAGE_COLOR_COLOR — цветные изображения.
  • IMAGE_COLOR_GRAYSCALE — черно-белые изображения.
  • IMAGE_COLOR_RED — изображения, в которых основной цвет — красный.
  • IMAGE_COLOR_ORANGE — изображения, в которых основной цвет — оранжевый.
  • IMAGE_COLOR_YELLOW — изображения, в которых основной цвет — желтый.
  • IMAGE_COLOR_GREEN — изображения, в которых основной цвет — зеленый.
  • IMAGE_COLOR_CYAN — изображения, в которых основной цвет — голубой.
  • IMAGE_COLOR_BLUE — изображения, в которых основной цвет — синий.
  • IMAGE_COLOR_VIOLET — изображения, в которых основной цвет — фиолетовый.
  • IMAGE_COLOR_WHITE — изображения, в которых основной цвет — белый.
  • IMAGE_COLOR_BLACK — изображения, в которых основной цвет — черный.

• site — поиск изображений только на указанном сайте. Например: yandex.cloud. Необязательный параметр. Если параметр не задан, поиск выполняется по всем сайтам поисковой базы.

• docs_on_page — количество групп результатов, которое выводится на одной странице с результатами поиска. Возможные значения — от 1 до 60. Необязательный параметр. Значение по умолчанию — 20.

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

• user_agent — строка, содержащая заголовок User-Agent. Параметр позволяет получить поисковую выдачу, ориентированную на конкретное устройство и браузер, в том числе мобильную выдачу. Необязательный параметр. Если параметр не задан, сервис возвращает стандартную выдачу по умолчанию.

{
  "site": "<доменное_имя_сайта>",
  "folder_id": "<идентификатор_каталога>",
  "url": "<URL_исходного_изображения>",
  "data": "<тело_изображения>",
  "id": "<идентификатор_CBIR>",
  "page": "<номер_страницы>"
}

Описание полей:

• site — поиск изображений только на указанном сайте. Например: yandex.cloud. Необязательный параметр. Если параметр не задан, поиск выполняется по всем сайтам поисковой базы.

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

• url — URL, по которому доступно исходное изображение.

• data — тело исходного изображения в кодировке Base64.

• id — идентификатор CBIR исходного изображения. Указывайте идентификатор, полученный в ответе, чтобы быстрее получить следующую страницу поисковой выдачи.

  Примечание

  В запросе можно передать только один из параметров: url, id или data.

• page — номер запрашиваемой страницы. Необязательный параметр. По умолчанию возвращается первая страница поисковой выдачи. Нумерация страниц начинается с нуля, первой странице соответствует значение 0.

{
  "images": [
    {
      "url": "https://cs10.pikabu.ru/post_img/2019/10/29/8/og_og_1572352646221687176.jpg",
      "format": "IMAGE_FORMAT_JPEG",
      "width": "570",
      "height": "960",
      "passage": "This Pin was discovered by Some Dude.",
      "host": "www.pinterest.com",
      "page_title": "How to enrich your cute cats' life? Cute cats, Indoor cat, Cats",
      "page_url": "https://www.pinterest.com/pin/how-to-enrich-your-cute-cats-life--703194929319013467/"
    },
    ...
  ],
  "page": "3",
  "id": "1716254/_KnCt2T9gLh4z8SSv8nVqQ7277"
}

Описание полей:

• images — массив, содержащий объекты с информацией о найденных изображениях:

  • url — URL изображения;

  • format — формат изображения:

    • IMAGE_FORMAT_JPEG — формат JPG;
    • IMAGE_FORMAT_GIF — формат GIF;
    • IMAGE_FORMAT_PNG — формат PNG.

  • width — ширина изображения в пикселях;

  • height — высота изображения в пикселях;

  • passage — текстовый сниппет, описывающий изображение;

  • host — домен, на котором расположен документ, содержащий изображение;

  • page_title — заголовок страницы, содержащей изображение;

  • page_url — URL страницы, содержащей изображение.

• page — номер текущей страницы с результатами поиска.

• id — идентификатор CBIR исходного изображения.