На этой странице руководства по Cloud Search показано, как настроить источник данных и коннектор контента для индексирования данных. Чтобы начать работу с самого начала этого руководства, обратитесь к руководству по началу работы с Cloud Search.
Создайте коннектор
Перейдите в рабочую директорию cloud-search-samples/end-to-end/connector и выполните следующую команду:
mvn package -DskipTests
Эта команда загружает необходимые зависимости для создания коннектора контента и компилирует код.
Создать учетные данные сервисной учетной записи
Для вызова API Cloud Search коннектору требуются учетные данные сервисной учетной записи. Чтобы создать учетные данные:
- Вернуться в консоль Google Cloud .
- В левой панели навигации нажмите «Учетные данные» . Откроется страница «Учетные данные».
- Click the + CREATE CREDENTIALS drop-down list and select Service account . The "Create service account" page appears.
- В поле « Имя учетной записи службы » введите «tutorial».
- Обратите внимание на значение идентификатора учетной записи службы (сразу после имени учетной записи службы). Это значение будет использоваться далее.
- Нажмите кнопку СОЗДАТЬ . Откроется диалоговое окно «Разрешения учетной записи службы (необязательно)».
- Нажмите ПРОДОЛЖИТЬ . Откроется диалоговое окно «Предоставить пользователям доступ к этой учетной записи службы (необязательно)».
- Нажмите кнопку ГОТОВО . Откроется экран «Учетные данные».
- В разделе «Сервисные учетные записи» щелкните по адресу электронной почты сервисной учетной записи. Откроется страница с «подробными сведениями о сервисной учетной записи».
- В разделе «Ключи» щелкните раскрывающийся список «ДОБАВИТЬ КЛЮЧ» и выберите «Создать новый ключ ». Откроется диалоговое окно «Создать закрытый ключ».
- Нажмите СОЗДАТЬ .
- (необязательно) Если появится диалоговое окно «Разрешить ли загрузку файлов на console.cloud.google.com?», нажмите «Разрешить ».
- Файл закрытого ключа сохранен на вашем компьютере. Запомните местоположение загруженного файла. Этот файл используется для настройки коннектора контента, чтобы он мог проходить аутентификацию при вызове API Google Cloud Search.
Инициализация поддержки сторонних организаций
Перед вызовом любых других API Cloud Search необходимо инициализировать поддержку сторонних сервисов для Google Cloud Search.
Для инициализации поддержки сторонних сервисов:
- Создайте учетные данные веб-приложения в проекте платформы Cloud Search. См. раздел «Создание учетных данных» . Вам понадобятся идентификатор клиента и секретный ключ клиента.
- Получите токен доступа, используя OAuth 2.0 Playground :
- Нажмите «Конфигурация OAuth 2.0» (значок настроек) и установите флажок «Использовать собственные учетные данные OAuth» .
- Введите свой идентификатор клиента и секретный ключ клиента.
- В поле «Области действия» введите
https://www.googleapis.com/auth/cloud_search.settingsи нажмите «Авторизовать API» . - Нажмите «Код авторизации биржи для получения токенов» .
Выполните следующую команду curl, заменив
[YOUR_ACCESS_TOKEN]на ваш токен: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. В случае неудачи обратитесь в службу поддержки Cloud Search.Используйте
operations.getдля проверки инициализации:curl 'https://cloudsearch.googleapis.com/v1/operations/<var>operation_name</var>?key=[YOUR_API_KEY]' \ --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \ --header 'Accept: application/json' \ --compressedИнициализация считается завершенной, когда
doneравноtrue.
Создайте источник данных
Далее создайте источник данных в консоли администратора. Источник данных предоставляет пространство имен для индексирования контента с помощью коннектора.
- Откройте консоль администратора Google .
- Нажмите на значок «Приложения». Откроется страница «Администрирование приложений».
- Нажмите «Google Workspace» . Откроется страница «Администрирование приложений Google Workspace».
- Прокрутите вниз и нажмите «Облачный поиск ». Откроется страница «Настройки Google Workspace».
- Нажмите «Сторонние источники данных ». Откроется страница «Источники данных».
- Click the round yellow + . The "Add new data source" dialog appears.
- В поле «Отображаемое имя » введите «tutorial».
- В поле «Адреса электронной почты учетных записей служб» введите адрес электронной почты учетной записи службы, созданной вами в предыдущем разделе. Если вы не знаете адрес электронной почты учетной записи службы, найдите это значение на странице учетных записей служб .
- Click ADD . The "Successfully created data source" dialog appears.
- Нажмите * ОК . Запишите идентификатор источника для только что созданного источника данных. Идентификатор источника используется для настройки коннектора контента.
Сгенерируйте персональный токен доступа для API GitHub.
Для обеспечения достаточного объема квоты коннектору требуется аутентифицированный доступ к API GitHub. Для простоты коннектор использует персональные токены доступа вместо OAuth. Персональные токены позволяют аутентифицироваться как пользователь с ограниченным набором прав, аналогично OAuth.
- Войдите в GitHub.
- In the upper-right corner, click on your profile picture. A drop-down menu appears.
- Нажмите «Настройки» .
- Нажмите «Настройки разработчика» .
- Нажмите «Персональные токены доступа» .
- Нажмите «Сгенерировать персональный токен доступа» .
- В поле «Примечание » введите «Учебное пособие по поиску в облаке».
- Проверьте область видимости public_repo .
- Нажмите «Сгенерировать токен» .
- Note the generated token. It is used by the connector to call the GitHub APIs and provides API quota to perform the indexing.
Настройте коннектор
После создания учетных данных и источника данных обновите конфигурацию коннектора, добавив следующие значения:
- From the command line, change directory to
cloud-search-samples/end-to-end/connector/. - Open the
sample-config.propertiesfile with a text editor. - Set the
api.serviceAccountPrivateKeyFileparameter to the file path of the service credentials you previously downloaded. - Set the
api.sourceIdparameter to the ID of the data source you previously created. - Set the
github.userparameter to your GitHub username. - Set the
github.tokenparameter to the access token you previously created. - Сохраните файл.
Обновите схему
The connector indexes both structured and unstructured content. Before indexing data, you must update the schema for the data source. Run the following command to update the schema:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Запустите коннектор
To run the connector and begin indexing, run the command:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
По умолчанию коннектор индексирует один репозиторий в организации googleworkspace . Индексирование репозитория занимает около 1 минуты. После первоначального индексирования коннектор продолжает опрашивать репозиторий на предмет изменений, которые необходимо отразить в индексе Cloud Search.
Проверка кода
The remaining sections examine how the connector is built.
Запуск приложения
The entry point to the connector is the GithubConnector class. The main method instantiates the SDK's IndexingApplication and starts it.
ListingConnector предоставляемый SDK, реализует стратегию обхода, использующую очереди Cloud Search для отслеживания состояния элементов в индексе. Он делегирует доступ к контенту из GitHub компоненту GithubRepository , реализованному в примере коннектора.
Обход репозиториев GitHub
During full traversals, the getIds() method is called to push items that may need to be index into the queue.
Коннектор может индексировать несколько репозиториев или организаций. Чтобы минимизировать последствия сбоя, индексация выполняется по одному репозиторию GitHub за раз. Возвращается контрольная точка с результатами индексации, содержащая список репозиториев, которые будут индексироваться в последующих вызовах функции getIds() . В случае ошибки индексация возобновляется с текущего репозитория, а не начинается с начала.
Метод collectRepositoryItems() обрабатывает обход отдельного репозитория GitHub. Этот метод возвращает коллекцию ApiOperations , представляющих элементы, которые необходимо добавить в очередь. Элементы добавляются в виде имени ресурса и хеш-значения, представляющего текущее состояние элемента.
Хэш-значение используется при последующих обходах репозиториев GitHub. Это значение обеспечивает упрощенную проверку, позволяющую определить, изменилось ли содержимое, без необходимости загрузки дополнительного контента. Коннектор автоматически ставит все элементы в очередь. Если элемент новый или хэш-значение изменилось, он становится доступным для опроса в очереди. В противном случае элемент считается неизмененным.
Обработка очереди
После завершения полного обхода коннектор начинает опрашивать очередь на наличие элементов, которые необходимо проиндексировать. Метод getDoc() вызывается для каждого элемента, извлеченного из очереди. Этот метод считывает элемент из GitHub и преобразует его в соответствующее представление для индексации.
Поскольку коннектор работает с данными в реальном времени, которые могут изменяться в любой момент, getDoc() также проверяет, что элемент в очереди по-прежнему действителен, и удаляет из индекса все элементы, которые больше не существуют.
Для каждого из объектов GitHub, индексируемых коннектором, соответствующий метод indexItem() отвечает за создание представления элемента для Cloud Search. Например, для создания представления элементов контента:
Далее разверните интерфейс поиска.