Cette page du tutoriel sur Cloud Search explique comment configurer une source de données et un connecteur de contenu pour indexer des données. Pour commencer depuis le début de ce tutoriel, consultez le tutoriel de mise en route de Cloud Search.
Créer le connecteur
Remplacez votre répertoire de travail par le répertoire cloud-search-samples/end-to-end/connector
et exécutez cette commande:
mvn package -DskipTests
La commande télécharge les dépendances nécessaires à la création du connecteur de contenu et compile le code.
Créer les identifiants du compte de service
Le connecteur requiert les identifiants du compte de service pour appeler les API Cloud Search. Pour créer les identifiants:
- Revenez à la console Google Cloud.
- Dans le volet de navigation de gauche, cliquez sur Identifiants. La page "Identifiants" s'affiche.
- Cliquez sur la liste déroulante + CRÉER DES IDENTIFIANTS, puis sélectionnez Compte de service. La page "Créer un compte de service" s'affiche.
- Dans le champ Nom du compte de service, saisissez "tutorial".
- Notez la valeur de l'ID du compte de service (juste après le nom du compte de service). Cette valeur sera utilisée ultérieurement.
- Cliquez sur CRÉER. La boîte de dialogue "Autorisations de compte de service (facultatif)" s'affiche.
- Cliquez sur CONTINUER. La boîte de dialogue "Autoriser les utilisateurs à accéder à ce compte de service (facultatif)" s'affiche.
- Cliquez sur OK. L'écran "Identifiants" s'affiche.
- Sous "Comptes de service", cliquez sur l'adresse e-mail du compte de service. La page "Détails du compte de service" s'affiche.
- Sous "Clés", cliquez sur la liste déroulante AJOUTER UNE CLÉ et sélectionnez Créer une clé. La boîte de dialogue "Créer une clé privée" s'affiche.
- Cliquez sur CRÉER.
- (Facultatif) Si la boîte de dialogue "Voulez-vous autoriser les téléchargements sur console.cloud.google.com ?" s'affiche, cliquez sur Autoriser.
- Un fichier de clé privée est enregistré sur votre ordinateur. Notez l'emplacement du fichier téléchargé. Ce fichier permet de configurer le connecteur de contenu afin qu'il puisse s'authentifier lors des appels aux API Google Cloud Search.
Initialiser la compatibilité tierce
Avant de pouvoir appeler d'autres API Cloud Search, vous devez initialiser la compatibilité tierce pour Google Cloud Search.
Pour initialiser la compatibilité tierce avec Cloud Search:
Votre projet Cloud Search Platform contient les identifiants du compte de service. Toutefois, dans le but d'initialiser la compatibilité tierce, vous devez créer des identifiants d'application Web. Pour savoir comment créer des identifiants d'application Web, consultez la section Créer des identifiants. Une fois cette étape terminée, vous devez disposer d'un fichier d'ID client et de code secret du client.
Utilisez OAuth 2 Playground de Google pour obtenir un jeton d'accès:
- Cliquez sur "Paramètres", puis cochez la case Utilisez vos propres identifiants d'authentification.
- Saisissez l'ID client et le code secret du client de l'étape 1.
- Cliquez sur Fermer.
- Dans le champ "Champs d'application", saisissez
https://www.googleapis.com/auth/cloud_search.settings
, puis cliquez sur Autoriser. OAuth 2 Playground renvoie un code d'autorisation. - Cliquez sur Exchange authorization code for tokens (Échanger le code d'autorisation contre des jetons). Un jeton est renvoyé.
Pour initialiser la compatibilité tierce avec Cloud Search, utilisez la commande curl suivante. Veillez à remplacer
[YOUR_ACCESS_TOKEN]
par le jeton obtenu à l'étape 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
Si la requête aboutit, le corps de la réponse contient une instance d'
operation
. Exemple :{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" }
En cas d'échec, contactez l'assistance Cloud Search.
Utilisez la méthode operations.get pour vérifier que la compatibilité tierce est initialisée:
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
Une fois l'initialisation tierce terminée, le champ
done
est défini surtrue
. Exemple :{ name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY" done: true }
Créer la source de données
Ensuite, créez une source de données dans la console d'administration. La source de données fournit un espace de noms pour l'indexation du contenu à l'aide du connecteur.
- Ouvrez la console d'administration Google.
- Cliquez sur l'icône Applications. La page "Administration des applications" s'affiche.
- Cliquez sur Google Workspace. La page "Apps Google Workspace administration" (Administration des applications Google Workspace) s'affiche.
- Faites défiler la page vers le bas et cliquez sur Cloud Search. La page "Paramètres de Google Workspace" s'affiche.
- Cliquez sur Sources de données tierces. La page "Sources de données" s'affiche.
- Cliquez sur le bouton jaune + rond. La boîte de dialogue "Ajouter une source de données" s'affiche.
- Dans le champ Nom à afficher, saisissez "tutorial".
- Dans le champ Adresses e-mail du compte de service, saisissez l'adresse e-mail du compte de service que vous avez créé à la section précédente. Si vous ne connaissez pas l'adresse e-mail du compte de service, recherchez-la sur la page Comptes de service.
- Cliquez sur AJOUTER. La boîte de dialogue "La source de données a bien été créée" s'affiche.
- Cliquez sur *OK. Notez l'ID source de la nouvelle source de données. L'ID source est utilisé pour configurer le connecteur de contenu.
Générer un jeton d'accès personnel pour l'API GitHub
Le connecteur nécessite un accès authentifié à l'API GitHub pour disposer d'un quota suffisant. Pour plus de simplicité, le connecteur utilise des jetons d'accès personnels plutôt que OAuth. Les jetons personnels permettent de s'authentifier en tant qu'utilisateur avec un ensemble limité d'autorisations semblables à OAuth.
- Connectez-vous à GitHub.
- En haut à droite, cliquez sur votre photo de profil. Un menu déroulant apparaît.
- Cliquez sur Paramètres.
- Cliquez sur Paramètres pour les développeurs.
- Cliquez sur Personal access tokens (Jetons d'accès personnels).
- Cliquez sur Generate personal access token (Générer un jeton d'accès personnel).
- Dans le champ Note, saisissez "Cloud Searchtutorial" (Tutoriel Cloud Search).
- Vérifiez le champ d'application public_repo.
- Cliquez sur Générer un jeton.
- Notez le jeton généré. Il permet au connecteur d'appeler les API GitHub et fournit un quota d'API pour effectuer l'indexation.
Configurer le connecteur
Après avoir créé les identifiants et la source de données, mettez à jour la configuration du connecteur pour inclure les valeurs suivantes:
- Depuis la ligne de commande, remplacez le répertoire par
cloud-search-samples/end-to-end/connector/
. - Ouvrez le fichier
sample-config.properties
avec un éditeur de texte. - Définissez le paramètre
api.serviceAccountPrivateKeyFile
sur le chemin d'accès au fichier d'identifiants de service que vous avez précédemment téléchargé. - Définissez le paramètre
api.sourceId
sur l'ID de la source de données que vous avez créée précédemment. - Définissez le paramètre
github.user
sur votre nom d'utilisateur GitHub. - Définissez le paramètre
github.token
sur le jeton d'accès que vous avez créé précédemment. - Enregistrez le fichier.
Mettre à jour le schéma
Le connecteur indexe les contenus structurés et non structurés. Avant d'indexer les données, vous devez mettre à jour le schéma de la source de données. Exécutez la commande suivante pour mettre à jour le schéma:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.SchemaTool \
-Dexec.args="-Dconfig=sample-config.properties"
Exécuter le connecteur
Pour exécuter le connecteur et commencer l'indexation, exécutez la commande suivante:
mvn exec:java -Dexec.mainClass=com.google.cloudsearch.tutorial.GithubConnector \
-Dexec.args="-Dconfig=sample-config.properties"
Par défaut, le connecteur est configuré de façon à indexer un seul dépôt dans l'organisation googleworkspace
. L'indexation du dépôt prend environ une minute.
Après l'indexation initiale, le connecteur continue d'interroger les modifications apportées au dépôt qui doivent être reflétées dans l'index Cloud Search.
Comprendre le code
Les autres sections examinent la construction du connecteur.
Démarrer l'application
Le point d'entrée du connecteur est la classe GithubConnector
. La méthode main
instancie l'élément IndexingApplication
du SDK et le démarre.
Le ListingConnector
fourni par le SDK met en œuvre une stratégie de balayage qui exploite les files d'attente Cloud Search pour suivre l'état des éléments de l'index. Il opère une délégation à GithubRepository
, mise en œuvre par l'exemple de connecteur, pour accéder au contenu de GitHub.
Balayage des dépôts GitHub
Lors des balayages complets, la méthode getIds()
est appelée pour placer dans la file d'attente des éléments pouvant avoir besoin d'être indexés.
Le connecteur peut indexer plusieurs dépôts ou organisations. Pour minimiser l'impact d'une défaillance, un dépôt GitHub est balayé à la fois. Un point de contrôle est renvoyé avec les résultats du balayage contenant la liste des dépôts à indexer lors des prochains appels à getIds()
. Si une erreur se produit, l'indexation est reprise dans le dépôt actuel au lieu de recommencer depuis le début.
La méthode collectRepositoryItems()
gère le balayage d'un seul dépôt GitHub. Cette méthode renvoie une collection de ApiOperations
représentant les éléments à ajouter à la file d'attente. Les éléments sont transmis en tant que nom de ressource et valeur de hachage représentant l'état actuel de l'élément.
La valeur de hachage est utilisée lors des balayages ultérieurs des dépôts GitHub. Cette valeur permet de déterminer facilement si le contenu a été modifié sans avoir à importer de contenu supplémentaire. Le connecteur met tous les éléments en file d'attente à l'aveugle. Si l'élément est nouveau ou si la valeur de hachage a changé, il est disponible pour l'interrogation dans la file d'attente. Sinon, l'élément est considéré comme non modifié.
Traitement de la file d'attente...
Une fois le balayage complet terminé, le connecteur commence à interroger la file d'attente à la recherche d'éléments à indexer. La méthode getDoc()
est appelée pour chaque élément extrait de la file d'attente. La méthode lit l'élément à partir de GitHub et le convertit en une représentation appropriée pour l'indexation.
Comme le connecteur s'exécute sur des données actives pouvant être modifiées à tout moment, getDoc()
vérifie également que l'élément de la file d'attente est toujours valide et supprime de l'index tous les éléments qui n'existent plus.
Pour chacun des objets GitHub indexés par le connecteur, la méthode indexItem()
correspondante crée la représentation de l'élément pour Cloud Search. Par exemple, pour créer la représentation des éléments de contenu:
Déployez ensuite l'interface de recherche.