О сервисе Yandex Search API
Yandex Search API позволяет автоматически отправлять запросы к поисковой базе Яндекса и получать результаты поиска в удобном для обработки формате. Сервис предназначен для разработчиков и вебмастеров, которым необходимо интегрировать поисковые возможности Яндекса в свои приложения и сервисы.
С помощью Yandex Search API вы можете организовать поиск по сайту, группе сайтов или всему интернету. Сервис можно использовать для создания внутреннего поиска на корпоративных порталах, агрегаторов контента, систем мониторинга упоминаний брендов и других приложений, где требуется автоматизированная работа с поисковой выдачей. Кроме того, Yandex Search API позволяет отслеживать позиции сайтов по поисковым запросам в выдаче Яндекса, что полезно для SEO-специалистов и маркетологов.
Примечание
Сервис Yandex Search API проксирует результаты поисковой системы Яндекса. Формат, состав и содержание полей в ответе определяются поисковой системой и могут не совпадать с результатами выдачи вашего поискового запроса в браузере.
Yandex Search API позволяет выполнять текстовый поиск, поиск изображений по текстовому описанию или другому изображению и генеративный поиск, формирующий единый емкий ответ с помощью собственной модели Яндекса.
Дополнительно Yandex Search API предоставляет инструмент Wordstat для получения статистики поисковых запросов к Яндексу. С его помощью можно узнать топ популярных запросов по ключевым словам, отследить динамику изменения частоты запросов и посмотреть распределение запросов по регионам России. Wordstat работает только через API в синхронном режиме. Веб-версия доступна на сайте Вордстат.
Режимы работы и типы поиска
Yandex Search API позволяет отправлять запросы в двух режимах:
- В синхронном режиме сервис вернет результат сразу после обработки запроса. Задержка ответа в синхронном режиме минимальна, однако ответ все равно не придет моментально: для получения результатов из поиска Яндекса требуется время. Синхронный режим подойдет для интерактивных приложений.
- В отложенном (асинхронном) режиме сервис сначала вернет объект Operation с идентификатором операции, по которому можно узнать статус операции и получить результат. Отложенный режим подойдет, если вам нужно обработать пакет запросов.
Разные типы поиска работают в разных режимах.
|
Тип поиска |
Описание |
Режимы |
|
Поиск веб-страниц по текстовому запросу. |
Синхронный и отложенный |
|
|
Поиск изображений по текстовому описанию или по заданному изображению. Результаты в формате XML или JSON. |
Только синхронный |
|
|
Текстовый поиск с использованием YandexGPT. Нейросеть анализирует результаты поиска и формирует единый емкий ответ. |
Только синхронный |
Настраивая параметры поиска, вы можете влиять на результаты выдачи — сервис будет учитывать геопозицию, оптимизировать результаты для разных устройств, а с помощью поисковых операторов вы можете точнее управлять поиском.
Интерфейсы сервиса
Yandex Search API предоставляет два способа взаимодействия: через API и через Yandex AI Studio SDK для Python.
API спроектирован на основе механизма gRPC и позволяет отправлять запросы с помощью gRPC-вызовов и REST-запросов.
Библиотека Yandex AI Studio SDK для Python упрощает работу с Yandex Search API и другими сервисами Yandex AI Studio, предоставляя удобные Python-интерфейсы для всех типов поиска и автоматическую обработку синхронных и асинхронных запросов.
Исходный код и примеры кода доступны в репозитории на GitHub, а описание классов и методов — в справочнике AI SDK.
Для работы с Yandex Search API понадобится пользовательский или сервисный аккаунт Yandex Cloud и данные для аутентификации. API-ключ AI Studio имеет все необходимые роли и доступы.