Cette page explique comment prévisualiser les recommandations à l'aide de la console Google Cloud et obtenir les résultats des recommandations à l'aide de l'API. Consultez l'onglet REST pour obtenir des exemples d'appels d'API qui peuvent vous aider à intégrer des recommandations à votre application.
La procédure à suivre dépend du type de recommandations souhaité et Type de data store auquel votre application de recommandation est associée:
- Obtenir des recommandations de contenus multimédias
- Obtenez des recommandations génériques pour une application avec des données structurées données
- Obtenir des recommandations génériques pour une application contenant des données non structurées
- Obtenir des recommandations génériques pour une application avec des données de site Web
Obtenir des recommandations de contenus multimédias
Console
Pour prévisualiser les recommandations de médias dans la console Google Cloud, procédez comme suit : étapes:
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application pour laquelle vous souhaitez prévisualiser les recommandations.
Cliquez sur Configurations > Entraînement. Si Prêt pour la requête affiche OK : alors l'application est prête à être prévisualisée.
Cliquez sur Aperçu.
Cliquez sur le champ ID du document. La liste des ID des documents s'affiche.
Cliquez sur l'ID du document pour lequel vous souhaitez obtenir des recommandations. Vous pouvez également saisir un ID de document dans le champ ID du document.
Cliquez sur Sélectionner une configuration de diffusion, puis sélectionnez la configuration de diffusion à prévisualiser.
Facultatif : saisissez l'ID de visiteur (également appelé "ID utilisateur pseudo") d'un utilisateur pour lequel vous avez collecté des événements utilisateur. Si vous laissez ce champ vide ou saisissez un ID de visiteur inexistant, vous prévisualiserez les recommandations en tant que nouvel utilisateur.
Cliquez sur Obtenir des recommandations. Une liste de documents recommandés s'affiche.
Cliquez sur un document pour afficher les détails le concernant.
REST
Pour obtenir des recommandations de médias à l'aide de l'API, utilisez la
Méthode servingConfigs.recommend
:
Recherchez votre ID de moteur et votre ID de configuration de diffusion. Si vous connaissez déjà l'ID de votre moteur et les ID de configuration de diffusion, passez à l'étape 2.
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application.
Dans le volet de navigation, cliquez sur Configurations.
Si seule la configuration de diffusion a été créée automatiquement vous avez créé votre application, l'ID de configuration de diffusion et l'ID de moteur sont même chose. Passez à l'étape suivante.
Si plusieurs configurations de diffusion sont répertoriées dans la section Configurations de diffusion recherchez la configuration de diffusion à partir de laquelle vous souhaitez obtenir des recommandations. L'ID de configuration de diffusion correspond à la valeur de la colonne ID.
Si vous avez supprimé la configuration de diffusion créée automatiquement lorsque vous avez créé votre application et que vous ne disposez actuellement que d'une seule configuration de diffusion que vous avez créée manuellement, accédez à la page Aperçu, puis cliquez sur Sélectionner une configuration de diffusion pour afficher l'ID de la configuration de diffusion.
Cliquez sur l'onglet Entraînement. Votre ID de moteur correspond à la valeur de la ligne ID de l'application.
Assurez-vous que l'application est prête à être prévisualisée :
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application.
Cliquez sur Configurations > Entraînement. Si Prêt à interroger est OK, l'application est prête à être prévisualisée.
Obtenez des recommandations.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -d '{ "validateOnly": false, "userEvent": { "eventType": "view-item", "userPseudoId": "USER_PSEUDO_ID", "documents": [{ "id": "DOCUMENT_ID" }], "filter": "FILTER_STRING" } }' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
- PROJECT_ID : ID de votre projet.
- DATA_STORE_ID : ID de votre datastore.
- DOCUMENT_ID : ID du document pour lequel vous souhaitez prévisualiser les recommandations. Utilisez l'ID que vous avez utilisé pour ce document à la à l'ingestion de vos données.
- USER_PSEUDO_ID: identifiant pseudonymisé de l'utilisateur. Toi peut utiliser un cookie HTTP pour ce champ, qui identifie de manière unique visiteur sur un seul appareil. Ne définissez pas ce champ sur le même identifiant pour plusieurs utilisateurs, car cela combinerait leurs historiques d'événements et dégraderait la qualité du modèle. N'incluez pas d'informations permettant d'identifier personnellement l'utilisateur dans ce champ.
- SERVING_CONFIG_ID: ID de votre configuration de diffusion.
- FILTER : facultatif. Champ de texte qui vous permet de filtrer sur un ensemble de champs spécifié à l'aide de la syntaxe d'expression de filtre. La valeur par défaut est une chaîne vide, ce qui signifie qu'aucun filtre n'est appliqué. Pour en savoir plus, consultez Filtrer les recommandations.
Un résultat semblable aux lignes suivantes doit s'afficher :
{ "results": [{"id": "sample-id-1"}, {"id": "sample-id-2"}], "attributionToken": "abc123" }
Google recommande d'associer des jetons d'attribution, que nous incluons à chaque
Réponse à la recherche et recommandation, avec les actions qu'un utilisateur entreprend en réponse
à ces réponses et recommandations. Cela peut améliorer la qualité des réponses et des recommandations de recherche au fil du temps. Pour ce faire, ajoutez des valeurs attributionToken
aux URL de chacun des liens que vous affichez sur votre site Web pour les réponses ou les recommandations de recherche (par exemple, https://www.example.com/54321/?rtoken=abc123
). Lorsqu'un utilisateur clique sur l'une de ces
incluent la valeur attributionToken
dans l'événement utilisateur que vous enregistrez.
Obtenir des recommandations génériques pour une application contenant des données structurées
Console
Utiliser la console Google Cloud afin de prévisualiser les recommandations génériques pour votre une application structurée, procédez comme suit:
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application pour laquelle vous souhaitez prévisualiser les recommandations.
Cliquez sur Aperçu.
Cliquez sur le champ ID du document. La liste des ID des documents s'affiche.
Cliquez sur l'ID du document pour lequel vous souhaitez obtenir des recommandations. Vous pouvez également saisir un ID de document dans le champ ID du document.
Cliquez sur Obtenir des recommandations. Une liste de documents recommandés s'affiche.
Cliquez sur un document pour afficher les détails le concernant.
REST
Pour utiliser l'API afin d'obtenir des recommandations génériques pour une application contenant des données structurées, procédez comme suit :
utilisez la méthode servingConfigs.recommend
:
Recherchez l'identifiant du moteur. Si vous connaissez déjà l'identifiant du moteur, passez à l'étape 2.
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application.
Obtenez l'ID du moteur à partir de l'URL de la console Google Cloud. Il s'agit du texte situé entre
engines/
et/data
. Par exemple, si l'URL contientgen-app-builder/engines/demo_1234567890123/data/records
l'ID du moteur est
demo_1234567890123
.
Recherchez l'ID de votre data store. Si vous disposez déjà de votre data store ID, passez à l'étape suivante.
Dans la console Google Cloud, accédez à la page Agent Builder et cliquez sur Data Stores dans le menu de navigation.
Cliquez sur le nom de votre data store.
Sur la page Données de votre data store, obtenez l'ID du data store.
Assurez-vous que votre moteur est prêt pour la prévisualisation en interrogeant
GetEngine
jusqu'à ce qu'elle renvoie"servingState":"ACTIVE"
. À ce stade, le moteur est prêt à être prévisualisé.curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/ENGINE_ID
- PROJECT_ID : ID de votre projet.
- ENGINE_ID : ID de votre moteur.
Obtenez des recommandations.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d '{ "userEvent": { "eventType":"view-item", "userPseudoId":"USER_PSEUDO_ID", "documents":[{"id":"DOCUMENT_ID"}]}}' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
- PROJECT_ID : ID de votre projet.
- DATA_STORE_ID : ID de votre datastore.
- DOCUMENT_ID : ID du document pour lequel vous souhaitez prévisualiser les recommandations. Utilisez l'ID que vous avez utilisé pour ce document à la à l'ingestion de vos données.
- USER_PSEUDO_ID: identifiant pseudonymisé de l'utilisateur. Toi peut utiliser un cookie HTTP pour ce champ, qui identifie de manière unique visiteur sur un seul appareil. Ne définissez pas ce champ sur le même identifiant pour plusieurs utilisateurs, car cela combinerait leurs historiques d'événements et dégraderait la qualité du modèle. N'incluez pas d'informations permettant d'identifier personnellement l'utilisateur dans ce champ.
- SERVING_CONFIG_ID: ID de votre configuration de diffusion. Votre l'ID de configuration de diffusion est identique à l'ID de moteur. Vous devez donc utiliser cet ID ici.
C#
Pour en savoir plus, consultez les API C# de Vertex AI Agent Builder documentation de référence.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Pour en savoir plus, consultez les API Go de Vertex AI Agent Builder documentation de référence.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour en savoir plus, consultez la documentation de référence de l'API Java Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Node.js Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Pour en savoir plus, consultez la documentation de référence de l'API PHP Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Pour en savoir plus, consultez la documentation de référence de l'API Python Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Pour en savoir plus, consultez la documentation de référence de l'API Ruby Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Obtenir des recommandations génériques pour une application avec des données non structurées
Console
Pour prévisualiser des recommandations génériques à l'aide de la console Google Cloud, procédez comme suit :
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application pour laquelle vous souhaitez prévisualiser les recommandations.
Cliquez sur Aperçu.
Cliquez sur le champ URI. Une liste d'URI s'affiche.
Cliquez sur l'URI du document pour lequel vous souhaitez obtenir des recommandations. Vous pouvez également saisir un URI dans le champ URI.
Cliquez sur Obtenir des recommandations. Liste des URI des documents recommandés s'affiche.
Cliquez sur un URI pour afficher le document.
REST
Pour utiliser l'API afin d'obtenir des recommandations génériques pour une application avec des données non structurées, procédez comme suit :
Recherchez l'identifiant du moteur. Si vous connaissez déjà l'identifiant du moteur, passez à l'étape 2.
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application.
Obtenez l'ID du moteur à partir de l'URL de la console Google Cloud. Il s'agit du texte situé entre
engines/
et/data
. Par exemple, si l'URL contientgen-app-builder/engines/demo_1234567890123/data/records
l'ID du moteur est
demo_1234567890123
.
Recherchez l'ID de votre data store. Si vous disposez déjà de votre data store ID, passez à l'étape suivante.
Dans la console Google Cloud, accédez à la page Agent Builder. Dans le menu de navigation, cliquez sur Data stores (Magasins de données).
Cliquez sur le nom de votre data store.
Sur la page Données de votre data store, obtenez l'ID du data store.
Assurez-vous que votre moteur est prêt pour la prévisualisation en interrogeant
GetEngine
jusqu'à ce qu'elle renvoie"servingState":"ACTIVE"
. À ce stade, le moteur est prêt à être prévisualisé.curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/ENGINE_ID
- PROJECT_ID : ID de votre projet.
- ENGINE_ID : ID de votre moteur.
Obtenez des recommandations.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d '{ "userEvent": { "eventType":"view-item", "userPseudoId":"USER_PSEUDO_ID", "documents":[{"id":"DOCUMENT_ID"}]}}' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
- PROJECT_ID : ID de votre projet.
- DATA_STORE_ID : ID du magasin de données associé à votre moteur.
- DOCUMENT_ID: ID du document que vous souhaitez prévisualiser recommandations. Utilisez l'ID de document que vous avez fourni au moment de la modification vous avez ingéré vos données.
- USER_PSEUDO_ID : identifiant pseudonymisé de l'utilisateur. Vous pouvez utiliser un cookie HTTP pour ce champ, qui identifie de manière unique un visiteur sur un seul appareil. Ne définissez pas ce champ sur le même pour plusieurs utilisateurs. L'historique de leurs événements est ainsi combiné et dégrader la qualité du modèle. N'incluez pas d'informations permettant d'identifier personnellement l'utilisateur dans ce champ.
- SERVING_CONFIG_ID: ID de votre configuration de diffusion. Votre l'ID de configuration de diffusion est identique à l'ID de moteur. Vous devez donc utiliser cet ID ici.
C#
Pour en savoir plus, consultez la documentation de référence de l'API C# Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Pour en savoir plus, consultez la documentation de référence de l'API Go Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour en savoir plus, consultez les API Java de Vertex AI Agent Builder documentation de référence.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Node.js Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Pour en savoir plus, consultez la documentation de référence de l'API PHP Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Pour en savoir plus, consultez la documentation de référence de l'API Python Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Pour en savoir plus, consultez la documentation de référence de l'API Ruby Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Obtenir des recommandations génériques pour une application avec des données de site Web
Console
Pour prévisualiser des recommandations génériques pour votre application de site Web à l'aide de la console Google Cloud, procédez comme suit :
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application pour laquelle vous souhaitez prévisualiser les recommandations.
Dans le menu de navigation, cliquez sur Aperçu.
Cliquez sur le champ URI. Une liste des URL de votre site Web s'affiche.
Cliquez sur l'URL de la page Web pour laquelle vous souhaitez obtenir des recommandations. Vous pouvez également saisir une URL de votre site Web dans le champ URL.
Cliquez sur Obtenir des recommandations. Une liste d'URL de pages Web recommandées s'affiche.
Cliquez sur une URL pour afficher la page Web correspondante.
REST
Pour utiliser l'API afin d'obtenir des recommandations génériques pour une application avec des données de site Web,
utilisez la méthode servingConfigs.recommend
:
Recherchez l'identifiant du moteur. Si vous disposez déjà de votre ID de moteur, passez à l'étape 2.
Dans la console Google Cloud, accédez à la page Agent Builder.
Cliquez sur le nom de l'application.
Obtenez l'ID du moteur à partir de l'URL de la console Google Cloud. Il s'agit du texte situé entre
engines/
et/data
. Par exemple, si l'URL contientgen-app-builder/engines/demo_1234567890123/data/records
l'ID du moteur est
demo_1234567890123
.
Recherchez l'ID de votre data store. Si vous disposez déjà de votre data store ID, passez à l'étape suivante.
Dans la console Google Cloud, accédez à la page Agent Builder et cliquez sur Data Stores dans le menu de navigation.
Cliquez sur le nom de votre data store.
Sur la page Données de votre data store, obtenez l'ID du data store.
Assurez-vous que votre moteur est prêt pour la prévisualisation en interrogeant
GetEngine
jusqu'à ce qu'elle renvoie"servingState":"ACTIVE"
. À ce stade, le moteur est prêt à être prévisualisé.curl -X GET \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/engines/ENGINE_ID
- PROJECT_ID : ID de votre projet.
- ENGINE_ID : ID de votre moteur.
Obtenez des recommandations.
curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -d '{ "userEvent": { "eventType":"view-item", "userPseudoId":"USER_PSEUDO_ID", "documents":[{"uri":"WEBSITE_URL"}]}}' \ "https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/servingConfigs/SERVING_CONFIG_ID:recommend"
- PROJECT_ID : ID de votre projet.
- DATA_STORE_ID : ID de votre datastore.
- WEBSITE_URL: URL du site Web que vous souhaitez prévisualiser recommandations.
- USER_PSEUDO_ID: identifiant pseudonymisé de l'utilisateur. Toi peut utiliser un cookie HTTP pour ce champ, qui identifie de manière unique visiteur sur un seul appareil. Ne définissez pas ce champ sur le même identifiant pour plusieurs utilisateurs, car cela combinerait leurs historiques d'événements et dégraderait la qualité du modèle. N'ajoutez pas d'informations permettant d'identifier personnellement l'utilisateur. dans ce domaine.
- SERVING_CONFIG_ID: ID de votre configuration de diffusion. Votre diffusion est identique à l'identifiant de moteur. Vous devez donc utiliser votre identifiant de moteur ici.
C#
Pour en savoir plus, consultez la documentation de référence de l'API C# Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Go
Pour en savoir plus, consultez la documentation de référence de l'API Go Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Java
Pour en savoir plus, consultez les API Java de Vertex AI Agent Builder documentation de référence.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Node.js
Pour en savoir plus, consultez la documentation de référence de l'API Node.js Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
PHP
Pour en savoir plus, consultez les API PHP de Vertex AI Agent Builder documentation de référence.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Python
Pour en savoir plus, consultez la documentation de référence de l'API Python Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez les identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.
Ruby
Pour en savoir plus, consultez la documentation de référence de l'API Ruby Vertex AI Agent Builder.
Pour vous authentifier auprès de Vertex AI Agent Builder, configurez le service Identifiants par défaut de l'application. Pour en savoir plus, consultez Configurer l'authentification pour un environnement de développement local.