Руководство по созданию веб-страницы пользовательского поиска

Статья
03/05/2019

Предупреждение

30 октября 2020 г. API поиска Bing перемещены из служб ИИ Azure в службы поиска Bing. Эта документация приводится только для справки. Обновленную информацию см. в документации по API Поиска Bing. Инструкции по созданию ресурсов Azure для Поиска Bing приведены в статье Создание ресурса для Поиска Bing с помощью Azure Marketplace.

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

В этой руководстве описано, как настроить экземпляр пользовательского поиска и интегрировать его в новую веб-страницу.

Здесь рассматриваются такие задачи:

Создание экземпляра пользовательского поиска
Добавление активных записей
Добавление заблокированных записей
Добавление закрепленных записей
Интеграция экземпляра пользовательского поиска в веб-страницу

Необходимые компоненты

Чтобы выполнить задания, описанные в этом руководстве, требуется ключ подписки для API пользовательского поиска Bing. Чтобы получить ключ, создайте ресурс Пользовательского поиска Bing на портале Azure.
Если вы еще не установили Visual Studio 2017 или более поздней версии, можете скачать и использовать бесплатный выпуск Visual Studio 2019 Community.

Создание экземпляра пользовательского поиска

Чтобы создать экземпляр Пользовательского поиска Bing, сделайте следующее:

Откройте браузер.
Перейдите на портал службы пользовательского поиска.
Войдите на портал с помощью учетной записи Майкрософт (MSA). Если у вас нет учетной записи MSA, щелкните Создать учетную запись Майкрософт. Если вы впервые используете портал, появится запрос на разрешение доступа к данным. Нажмите кнопку Да.
После входа нажмите кнопку New custom search (Создать службу пользовательского поиска). В окне Create a new custom search instance (Создание экземпляра пользовательского поиска) введите информативное имя, которое описывает тип содержимого, возвращаемого в результатах поиска. Имя можно изменить в любой момент.
Нажмите кнопку "ОК", укажите URL-адрес и следует ли включать вложенные страницы URL-адреса.

Добавление активных записей

Чтобы включать результаты с конкретных сайтов или URL-адресов, добавьте их на вкладке Активные.

На странице Конфигурация перейдите на вкладку Активные и введите URL-адреса одного или нескольких сайтов, которые требуется включить в поиск.
Чтобы проверить, возвращает ли экземпляр результаты, введите запрос в области предварительного просмотра в правой части экрана. Bing возвращает результаты только с общедоступных индексированных сайтов.

Добавление заблокированных записей

Чтобы исключать результаты с конкретных сайтов или URL-адресов, добавьте их на вкладке Заблокированные.

На странице Конфигурация перейдите на вкладку Заблокированные и введите URL-адреса одного или нескольких сайтов, которые требуется исключать из поиска.
Чтобы проверить, не возвращает ли экземпляр результаты из заблокированных сайтов, введите запрос в области предварительного просмотра в правой части экрана.

Добавление закрепленных записей

Чтобы закрепить определенную веб-страницу в верхней части результатов поиска, добавьте веб-страницу и термин запроса на закрепленную вкладку. Закрепленная вкладка содержит список пар терминов веб-страниц и запросов, указывающих веб-страницу, которая отображается в качестве верхнего результата для определенного запроса. Веб-страница закрепляется только в том случае, если строка запроса пользователя совпадает со строкой запроса ПИН-кода на основе условия соответствия ПИН-кода. В результатах поиска будут отображаться только индексированные веб-страницы. Дополнительные сведения см. в статье Настройка режима пользовательского поиска.

На странице Конфигурация перейдите на вкладку Закрепленные, а затем введите термин запроса и веб-страницу, которая должна возвращаться как первый результат.
По умолчанию строка запроса пользователя должна точно соответствовать вашему ПИН-коду строки запроса для Bing для возврата веб-страницы как лучшего результата. Чтобы изменить условие соответствия, отредактируйте ПИН-код (щелкните по значку карандаша), щелкните точное совпадение в столбце Условие соответствия запросу и выберите условие соответствия, подходящее под ваше приложение.
Чтобы проверить, возвращает ли экземпляр указанную веб-страницу как первый результат, введите запрос в области предварительного просмотра в правой части экрана.

Настройка размещенного пользовательского интерфейса

Служба "Пользовательский поиск" предоставляет размещенный пользовательский интерфейс, который обрабатывает ответ JSON экземпляра пользовательского поиска. Чтобы определить пользовательский интерфейс, сделайте следующее:

Щелкните вкладку Hosted UI (Размещенный пользовательский интерфейс).
Выбор макета.
Выберите цветовую тему.

Если вам нужно точно настроить цветовую тему, чтобы лучше интегрироваться с веб-приложением, нажмите кнопку Настройка темы. Не все конфигурации цвета применяются ко всем темам макета. Чтобы изменить цвет, введите значение цвета RGB HEX (например, #366eb8) в соответствующем текстовом поле. Или нажмите кнопку выбора цвета и щелкните оттенок, который вам подходит. При выборе цвета всегда думайте о специальных возможностях.
Укажите дополнительные параметры конфигурации.

Чтобы получить дополнительные конфигурации, щелкните Показать дополнительные конфигурации. Это добавляет конфигурации, такие как цель ссылки в веб-параметры поиска, Включить фильтры в параметры изображений и видеофайлов, и заполнитель текста в поле поиска в параметры "Разное".
Выберите ключи подписки из раскрывающихся списков. Или можно ввести ключ подписки вручную.

Публикация или отмена

Изменения, которые вы вносите в экземпляр службы пользовательского поиска, выполняются на вкладке Конфигурация, поэтому вы можете проверить свои изменения. Когда вы уже внесли изменения и готовы к публикации, нажмите кнопку Опубликовать. Изменения не отражаются на рабочих конечных точках, пока не выполнена публикация.

Перед публикацией, если вы не хотите сохранять внесенные изменения, нажмите кнопку Отменить изменения. В случае отмены изменений активная конфигурация не меняется, а изменения на вкладке Конфигурация отменяются, чтобы значения соответствовали активному состоянию.

Использование размещенного пользовательского интерфейса

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

Вариант 1. Интеграция предоставленного фрагмента кода JavaScript в приложение.
Вариант 2. Использование предоставленной конечной точки HTML.

Оставшаяся часть этого руководства иллюстрирует вариант 1. Фрагмент кода JavaScript.

Настройка решения Visual Studio

Откройте Visual Studio у себя на компьютере.
В меню Файл выберите пункт Создать, а затем — Проект.
В окне Новый проект выберите Visual C# / Интернет / Веб-приложение ASP.NET Core, введите имя проекта, а затем нажмите кнопку ОК.
В окне Веб-приложение ASP.NET Core выберите Веб-приложение и нажмите кнопку ОК.

Изменение файла Index.cshtml

В обозревателе решений разверните узел Страницы и дважды щелкните файл Index.cshtml, чтобы открыть его.
В файле Index.cshtml удалите все, начиная со строки 7.
```
@page
@model IndexModel
@{
   ViewData["Title"] = "Home page";
}    
```
Добавьте элемент разрыва строки и элемент div в качестве контейнера.
```
@page
@model IndexModel
@{
   ViewData["Title"] = "Home page";
}
<br />
<div id="customSearch"></div>
```
На вкладкеHosted UI (Размещенный пользовательский интерфейс) прокрутите к разделу Consuming the UI (Использование пользовательского интерфейса). Нажмите кнопку Endpoints (Конечные точки) для доступа к фрагменту кода JavaScript. Можно также получить фрагмент кода, нажав кнопку Production (Производство), а затем вкладку Hosted UI (Размещенный пользовательский интерфейс).

Вставьте элемент скрипта в добавленный контейнер.

@page
@model IndexModel
@{
   ViewData["Title"] = "Home page";
}
<br />
<div id="customSearch">
   <script type="text/javascript" 
       id="bcs_js_snippet"
       src="https://ui.customsearch.ai /api/ux/rendering-js?customConfig=<YOUR-CUSTOM-CONFIG-ID>&market=en-US&safeSearch=Moderate&version=latest&q=">
   </script>
</div>