На этой странице руководства Cloud Search показано, как настроить источник данных и соединитель контента для индексирования данных. Чтобы начать работу с этим руководством, обратитесь к руководству по началу работы с Cloud Search.
Создание соединителя
Измените свой рабочий каталог на каталог cloud-search-samples/end-to-end/connector
и выполните следующую команду:
mvn package -DskipTests
Команда загружает необходимые зависимости, необходимые для создания соединителя контента, и компилирует код.
Создайте учетные данные сервисной учетной записи
Соединителю требуются учетные данные учетной записи службы для вызова API Cloud Search. Чтобы создать учетные данные:
- Вернитесь в консоль Google Cloud .
- На панели навигации слева нажмите «Учетные данные» . Появится страница «Учетные данные».
- Нажмите раскрывающийся список + CREATE CREDENTIALS и выберите Сервисный аккаунт . Появится страница «Создать учетную запись службы».
- В поле «Имя учетной записи службы» введите «tutorial».
- Обратите внимание на значение идентификатора учетной записи службы (сразу после имени учетной записи службы). Это значение используется позже.
- Нажмите СОЗДАТЬ . Появится диалоговое окно «Разрешения сервисной учетной записи (необязательно)».
- Нажмите ПРОДОЛЖИТЬ . Появится диалоговое окно «Предоставить пользователям доступ к этой учетной записи службы (необязательно)».
- Нажмите ГОТОВО . Появится экран «Учетные данные».
- В разделе «Учетные записи служб» нажмите на адрес электронной почты учетной записи службы. Откроется страница «Сведения об учетной записи службы».
- В разделе «Ключи» щелкните раскрывающийся список «ДОБАВИТЬ КЛЮЧ» и выберите « Создать новый ключ» . Появится диалоговое окно «Создать закрытый ключ».
- Нажмите СОЗДАТЬ .
- (необязательно) Если вопрос «Хотите ли вы разрешить загрузку на console.cloud.google.com?» появится диалоговое окно, нажмите «Разрешить» .
- Файл закрытого ключа сохраняется на вашем компьютере. Обратите внимание на расположение загруженного файла. Этот файл используется для настройки соединителя контента, чтобы он мог аутентифицировать себя при вызове API Google Cloud Search.
Инициализировать стороннюю поддержку
Прежде чем вы сможете вызывать любые другие API Cloud Search, вам необходимо инициализировать стороннюю поддержку Google Cloud Search.
Чтобы инициализировать стороннюю поддержку Cloud Search:
Ваш проект платформы Cloud Search содержит учетные данные сервисной учетной записи. Однако для инициализации сторонней поддержки необходимо создать учетные данные веб-приложения. Инструкции по созданию учетных данных веб-приложения см. в разделе Создание учетных данных . По завершении этого шага у вас должен быть идентификатор клиента и секретный файл клиента.
Используйте площадку Google OAuth 2 для получения токена доступа:
- Нажмите «Настройки» и установите флажок «Пользователь имеет свои учетные данные» .
- Введите идентификатор клиента и секрет клиента из шага 1.
- Нажмите Закрыть .
- В поле «Области» введите
https://www.googleapis.com/auth/cloud_search.settings
и нажмите «Авторизовать» . Площадка OAuth 2 возвращает код авторизации. - Нажмите «Код авторизации Exchange для токенов» . Токен возвращается.
Чтобы инициализировать стороннюю поддержку Cloud Search, используйте следующую команду Curl. Обязательно замените
[YOUR_ACCESS_TOKEN]
токеном, полученным на шаге 2.curl --request POST \ 'https://cloudsearch.googleapis.com/v1:initializeCustomer' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{}' \ --compressed
В случае успеха тело ответа содержит экземпляр
operation
. Например:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
В случае неудачи обратитесь в службу поддержки Cloud Search.
Используйте Operations.get , чтобы убедиться, что инициализирована сторонняя поддержка:
curl \ 'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key= [YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressed
Когда сторонняя инициализация завершена, она содержит поле
done
со значениемtrue
. Например:{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
Создайте источник данных
Затем создайте источник данных в консоли администратора. Источник данных предоставляет пространство имен для индексации содержимого с помощью соединителя.
- Откройте консоль администратора Google .
- Нажмите значок «Приложения». Появится страница «Администрирование приложений».
- Нажмите Google Workspace . Откроется страница «Администрирование приложений Google Workspace».
- Прокрутите вниз и нажмите «Поиск в облаке» . Откроется страница «Настройки Google Workspace».
- Нажмите Сторонние источники данных . Откроется страница «Источники данных».
- Нажмите круглый желтый + . Появится диалоговое окно «Добавить новый источник данных».
- В поле «Отображаемое имя » введите «tutorial».
- В поле Адреса электронной почты учетной записи службы введите адрес электронной почты учетной записи службы, которую вы создали в предыдущем разделе. Если вы не знаете адрес электронной почты учетной записи службы, найдите значение на странице учетных записей службы .
- Нажмите ДОБАВИТЬ . Появится диалоговое окно «Источник данных успешно создан».
- Нажмите * ОК . Запишите идентификатор источника для вновь созданного источника данных. Идентификатор источника используется для настройки соединителя содержимого.
Создайте личный токен доступа для API GitHub.
Соединителю требуется аутентифицированный доступ к API GitHub, чтобы иметь достаточную квоту. Для простоты соединитель использует токены личного доступа вместо OAuth. Персональные токены позволяют аутентифицироваться как пользователь с ограниченным набором разрешений, аналогично OAuth.
- Войдите в GitHub.
- В правом верхнем углу нажмите на изображение своего профиля. Появится раскрывающееся меню.
- Нажмите «Настройки» .
- Нажмите «Настройки разработчика» .
- Нажмите Токены личного доступа .
- Нажмите Создать токен личного доступа .
- В поле «Примечание» введите «Учебное пособие по Cloud Search».
- Проверьте область public_repo .
- Нажмите Создать токен .
- Обратите внимание на сгенерированный токен. Он используется соединителем для вызова API GitHub и предоставляет квоту API для выполнения индексации.
Настройка соединителя
После создания учетных данных и источника данных обновите конфигурацию соединителя, включив в нее следующие значения:
- В командной строке измените каталог на
cloud-search-samples/end-to-end/connector/
. - Откройте файл
sample-config.properties
в текстовом редакторе. - Задайте для параметра
api.serviceAccountPrivateKeyFile
путь к файлу ранее загруженных учетных данных службы. - Задайте для параметра
api.sourceId
идентификатор ранее созданного источника данных. - Установите для параметра
github.user
свое имя пользователя GitHub. - Установите для параметра
github.token
ранее созданный токен доступа. - Сохраните файл.
Обновите схему
Соединитель индексирует как структурированное, так и неструктурированное содержимое. Прежде чем индексировать данные, необходимо обновить схему источника данных. Выполните следующую команду, чтобы обновить схему:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Запустите соединитель
Чтобы запустить коннектор и начать индексацию, выполните команду:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
Конфигурация соединителя по умолчанию — индексировать один репозиторий в организации googleworkspace
. Индексация репозитория занимает около 1 минуты. После первоначального индексирования коннектор продолжает опрашивать репозиторий на наличие изменений, которые необходимо отразить в индексе Cloud Search.
Проверка кода
В остальных разделах рассматривается, как устроен соединитель.
Запуск приложения
Точкой входа в коннектор является класс GithubConnector
. main
метод создает экземпляр IndexingApplication
SDK и запускает его.
ListingConnector
, предоставляемый SDK, реализует стратегию обхода, которая использует очереди Cloud Search для отслеживания состояния элементов в индексе. Он делегирует GithubRepository
, реализованный примером соединителя, для доступа к контенту из GitHub.
Обход репозиториев GitHub
Во время полного обхода вызывается метод getIds()
для помещения в очередь элементов, которые, возможно, потребуется индексировать.
Соединитель может индексировать несколько репозиториев или организаций. Чтобы свести к минимуму влияние сбоя, за раз просматривается один репозиторий GitHub. Контрольная точка возвращается с результатами обхода, содержащими список репозиториев, которые будут индексироваться при последующих вызовах getIds()
. В случае возникновения ошибки индексирование возобновляется в текущем репозитории, а не начинается с начала.
Метод collectRepositoryItems()
обрабатывает обход одного репозитория GitHub. Этот метод возвращает коллекцию ApiOperations
представляющую элементы, которые нужно поместить в очередь. Элементы передаются как имя ресурса и хеш-значение, представляющее текущее состояние элемента.
Хэш-значение используется при последующих обходах репозиториев GitHub. Это значение обеспечивает упрощенную проверку, позволяющую определить, изменилось ли содержимое, без необходимости загрузки дополнительного содержимого. Коннектор слепо ставит все элементы в очередь. Если элемент новый или значение хеш-функции изменилось, он становится доступным для опроса в очереди. В противном случае элемент считается неизмененным.
Обработка очереди
После завершения полного обхода соединитель начинает опрашивать очередь на наличие элементов, которые необходимо проиндексировать. Метод getDoc()
вызывается для каждого элемента, извлеченного из очереди. Метод считывает элемент из GitHub и преобразует его в подходящее представление для индексации.
Поскольку коннектор работает с актуальными данными, которые могут быть изменены в любое время, getDoc()
также проверяет, что элемент в очереди все еще действителен, и удаляет из индекса все элементы, которые больше не существуют.
Для каждого объекта GitHub, индексируемого коннектором, соответствующий метод indexItem()
занимается созданием представления элемента для Cloud Search. Например, чтобы построить представление элементов контента:
Далее разверните интерфейс поиска.