Cette page du tutoriel Cloud Search explique comment configurer une source de données et le connecteur de contenu pour l'indexation des données. Pour commencer ce tutoriel depuis le début, Tutoriel de mise en route de Cloud Search
Créer le connecteur
Remplacez votre répertoire de travail par cloud-search-samples/end-to-end/connector
.
et exécutez la commande suivante:
mvn package -DskipTests
La commande télécharge les dépendances nécessaires à la compilation et compile le code.
Créer les identifiants du compte de service
Le connecteur requiert les identifiants du compte de service pour appeler l'API Cloud Search API. Pour créer les identifiants:
- Revenez au Console Google Cloud
- Dans le volet de navigation de gauche, cliquez sur Identifiants. "Certificat" s'affiche.
- Cliquez sur la liste déroulante + CRÉER DES IDENTIFIANTS et sélectionnez Compte de service : L'option "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. "Autorisations de compte de service (facultatif)" s'affiche.
- Cliquez sur CONTINUER. L'option "Autoriser les utilisateurs à accéder à ce compte de service" (facultatif)" s'affiche.
- Cliquez sur OK. La colonne "Credentials" (Identifiants) s'affiche.
- Sous "Comptes de service", cliquez sur l'adresse e-mail du compte de service. Le service détails du compte" s'affichent.
- Sous "Clés", cliquez sur la liste déroulante AJOUTER UNE CLÉ et sélectionnez Créer une clé : L'option "Créer une clé privée" s'affiche.
- Cliquez sur CRÉER.
- (facultatif) Si l'option "Voulez-vous autoriser les téléchargements 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 est utilisé pour configurer le connecteur de contenu il peut s'authentifier lorsqu'il appelle les API Google Cloud Search.
Initialiser la compatibilité tierce
Avant de pouvoir appeler d'autres API Cloud Search, vous devez initialiser des API tierces de Google Cloud Search.
Pour initialiser la compatibilité tierce avec Cloud Search:
Votre projet Cloud Search Platform contient les identifiants du compte de service. Toutefois, pour initialiser la prise en charge tierce, vous devez créer des métriques les identifiants de l'application. Pour obtenir des instructions sur la création d'une application Web les identifiants, consultez Créez 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 dans É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 prise en charge 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
Lorsque l'initialisation du service tiers est terminée, champ
done
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. Dans "Administration des applications", s'affiche.
- Cliquez sur Google Workspace. La section "Apps Google Workspace administration" s'affiche.
- Faites défiler la page vers le bas et cliquez sur Cloud Search. "Paramètres de Google Workspace" page s'affiche.
- Cliquez sur Sources de données tierces. Les "Sources de données" s'affiche.
- Cliquez sur le bouton + jaune rond. L'option "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 des le compte de service que vous avez créé à la section précédente. Si vous ne connaissez pas le l'adresse e-mail du compte de service, recherchez la valeur la comptes de service .
- Cliquez sur AJOUTER. 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. La 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 a besoin d'un accès authentifié à l'API GitHub pour de disposer d'un quota suffisant. Pour plus de simplicité, le connecteur utilise des données des jetons d'accès au lieu d'OAuth. Les jetons personnels permettent de s'authentifier en tant que un utilisateur disposant d'un ensemble limité d'autorisations similaires à 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é. Le connecteur l'utilise pour appeler la bibliothèque API 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 le connecteur pour inclure ces valeurs:
- À partir de 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 téléchargés précédemment. - Définissez le paramètre
api.sourceId
sur l'ID de la source de données créés 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 l'indexation 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é pour 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
qui doivent être réfléchies dans l'index Cloud Search.
Examiner 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
La méthode main
instancie la méthode IndexingApplication
du SDK.
et le démarre.
ListingConnector
fournies par le SDK implémente une stratégie de balayage
qui exploite les files d'attente Cloud Search
pour suivre l'état des éléments de l'index. Il délègue à GithubRepository
,
implémentés 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 insérer des éléments susceptibles de nécessiter une indexation dans la file d'attente.
Le connecteur peut indexer plusieurs dépôts ou organisations. Pour atténuer la
impact en cas de défaillance, un dépôt GitHub est balayé à la fois. Un point de contrôle
est renvoyée avec les résultats du balayage contenant la liste des
dépôts à indexer dans les appels suivants à getIds()
. Si une erreur
l'indexation est reprise dans le dépôt actuel au lieu de démarrer
dès 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 une valeur de hachage représentant l'état actuel de l'élément.
La valeur de hachage est utilisée lors des balayages ultérieurs du des dépôts. Cette valeur permet de déterminer facilement si le contenu sans avoir à importer de contenu supplémentaire. Le connecteur aveugle met tous les éléments en file d'attente. Si l'élément est nouveau ou si la valeur de hachage a changé, il est créé 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
pour les éléments à indexer. getDoc()
est appelée pour chaque élément extrait de la file d'attente. La méthode lit
l'élément de GitHub et le convertit dans la représentation appropriée
pour l'indexation.
Le connecteur étant exécuté sur des données actives susceptibles d'être modifiées à tout moment
temps, getDoc()
vérifie également que l'élément de la file d'attente est toujours valide.
et supprime tous les éléments de l'index qui n'existent plus.
Pour chacun des objets GitHub indexés par le connecteur, les
La méthode indexItem()
gère la création de 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.