Migrer depuis l'API JSON Custom Search Site Restricted

Si vous utilisez l'API JSON Custom Search Site Restricted de Programmable Search Engine, vous pouvez créer et déployer une recherche de qualité Google limitée à un site en quelques minutes à l' aide d'Agent Search. Pour déployer votre application, vous pouvez utiliser le widget Recherche en copiant le code de la Google Cloud console directement dans une page Web. Vous n'aurez pas besoin de rédiger de code. Vous pouvez également implémenter un déploiement d'API pour contrôler l'apparence de la fonctionnalité de recherche sur votre site Web. Pour en savoir plus sur l'utilisation de l'API, consultez l'onglet REST de la section Obtenir des résultats de recherche pour une application avec des données de site Web et la méthode servingConfigs.search dans la documentation de référence REST.

En plus des extraits courts standards qu'Agent Search renvoie avec les résultats de recherche, vous pouvez ajouter des fonctionnalités avancées à votre recherche. Il s'agit, entre autres, de résumés générés des résultats de recherche, pour une recherche contextuelle qui permet de poser des questions complémentaires, et pour le texte extrait renvoyé avec chaque résultat de recherche. Pour bénéficier de ces fonctionnalités avancées pour votre recherche sur le Web, vous devez valider votre domaine et payer des coûts d'indexation supplémentaires.

Vous pouvez également filtrer ou trier vos résultats de recherche et appliquer des commandes de promotion pour afficher un lien en tant que résultat sponsorisé.

Pour en savoir plus, consultez la page des tarifs d'Agent Search.

Configurer Agent Search

Pour configurer Agent Search, procédez comme suit :

  1. Dans la Google Cloud console, sur la page de sélection du projet, sélectionnez le projet que vous utilisez pour l'API JSON Custom Search Site Restricted.

  2. Activez Agent Search.

Créer une application de recherche

Pour créer une application de recherche, procédez comme suit :

  1. Dans la Google Cloud console, accédez à la page AI Applications.

    AI Applications

  2. Cliquez sur Create app (Créer l'application).

  3. Sur la page Create App (Créer une application), sous Site search with AI mode (Recherche sur site avec le mode IA), cliquez Create (Créer).

  4. Assurez-vous que les fonctionnalités de l'édition Enterprise sont activées. Cette étape est obligatoire pour la recherche sur un site Web. Pour en savoir plus, consultez Fonctionnalités de l'édition Enterprise.

  5. Désactivez Generative Responses (Réponses génératives). Cette action vous offre des fonctionnalités semblables à celles de l'API JSON Custom Search Site Restricted de Programmable Search Engine. Désactivez cette option si vous n'avez pas besoin de résumés de recherche ni de recherches avec des questions complémentaires. Pour en savoir plus, consultez Réponses génératives.

  6. Dans le champ Your app name (Nom de votre application), saisissez le nom de votre application.

  7. Dans le champ External name of your company or organization (Nom externe de votre entreprise ou organisation), saisissez le nom commun de votre entreprise ou organisation.

  8. Sélectionnez global (Global) comme emplacement pour votre application, puis cliquez sur Continue (Continuer).

  9. Sur la page Data Stores (Datastores), cliquez sur Create data store (Créer un datastore).

  10. Dans le volet Select a data source (Sélectionner une source de données), sélectionnez Website Content (Contenu de site Web).

  11. Désactivez l'indexation Advanced website indexing (Indexation avancée de site Web). Cette action vous offre des fonctionnalités semblables à celles de l'API JSON Custom Search Site Restricted de Programmable Search Engine. Désactivez cette option si vous n'avez pas besoin de résumés de recherche ni de recherches avec des questions complémentaires, ou si vous n'êtes pas propriétaire des domaines que vous spécifiez. Pour en savoir plus, consultez Indexation avancée de site Web.

  12. Dans le champ Sites to include (Sites à inclure) du volet Specify URL patterns to index (Spécifier les formats d'URL à indexer), saisissez les formats d'URL des sites Web que vous souhaitez rechercher, puis cliquez sur Continue (Continuer).

  13. Dans le volet Configure your data store (Configurer votre datastore), saisissez un nom à afficher pour votre datastore, puis cliquez sur Create (Créer).

  14. Sur la page Data Stores (Datastores), sélectionnez votre nouveau data store, puis cliquez sur Create (Créer).

Déployer l'application de recherche

Choisissez comment vous comptez authentifier votre application de recherche Agent Search : à l'aide d'OAuth 2.0 ou d'une clé API. Pour en savoir plus sur les avantages et les inconvénients de chaque méthode, consultez À propos de l' authentification.

Déployer l'application de recherche (OAuth 2.0)

Pour déployer votre application de recherche à l'aide de l'authentification OAuth 2.0, procédez comme suit :

  1. Pour configurer OAuth 2.0, consultez la section Sur Google Cloud de S'authentifier auprès d' Agent Search. Veillez à ajouter le rôle Discovery Engine Utilisateur ou Discovery Engine Lecteur au compte de service.

  2. Déployez votre application de recherche de l'une des manières suivantes :

Déployer l'application de recherche (clé API)

Pour déployer votre application de recherche à l'aide d'une clé API pour l'authentification, procédez comme suit :

  1. Créez la clé API :

    1. Dans la Google Cloud console, accédez à la page Credentials (Identifiants).

      Credentials

    2. Si vous n'êtes pas déjà dans votre projet, sélectionnez-le dans la liste des projets en haut de la Google Cloud page de la console.

    3. Cliquez sur Create credentials (Créer des identifiants), puis sélectionnez API key (Clé API). N'ajoutez aucune restriction de référent. Certains paramètres de confidentialité de l'utilisateur ne transmettent pas l'URL de provenance.

      • Prenez note de la clé API générée, que vous utiliserez lors des appels à la méthode searchLite.

    4. Pour renforcer la sécurité, ajoutez une restriction HTTP à votre clé API afin de restreindre l'accès au service Agent Search à l'adresse https://discoveryengine.googleapis.com/*.

  2. Déployez votre application de recherche à l'aide de l'API. Consultez Obtenir des résultats de recherche pour une application avec des données de site Web (clé API) et la servingConfigs.searchLite méthode dans la documentation de référence REST. Pour trier les résultats de vos requêtes de recherche sur le Web, consultez Trier les résultats de recherche sur le Web.

À propos de l'authentification

L'API JSON Custom Search Site Restricted de Programmable Search Engine s'authentifie à l'aide d'une clé API. Tandis qu'à quelques exceptions près, Agent Search nécessite OAuth 2.0. Si vous souhaitez continuer à utiliser une clé API pour l'authentification, vous devez utiliser la searchLite méthode via des appels d'API.

Si vous choisissez de vous authentifier via OAuth 2.0, vous devez utiliser la search méthode et la answer méthode pour interroger votre site Web. De plus, vous pouvez déployer votre application de recherche via le widget de recherche sans code .

Le tableau suivant répertorie les différences entre l'utilisation de la méthode searchLite avec l'authentification par clé API et les méthodes search et answer avec l'authentification OAuth 2.0.

Fonctionnalité/Méthodes Méthode searchLite Méthode search
Authentification Clé API OAuth 2.0
Widget Recherche disponible ✘ ✔
Résumés de recherche ✔ ✔
Rechercher sur des sites Web publics ✔ ✔

Étapes suivantes