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