Trier les résultats à partir de data stores structurés

Remarque : Cette fonctionnalité est une offre en version bêta soumise aux conditions des offres avant disponibilité générale des Conditions spécifiques du service GCP. Les fonctionnalités et produits pré-DG sont susceptibles de présenter une compatibilité limitée, et les modifications apportées à ces fonctionnalités ou produits peuvent ne pas être compatibles avec d'autres versions pré-DG. Pour en savoir plus, consultez les descriptions des étapes de lancement. En outre, en utilisant cette fonctionnalité, vous acceptez les Conditions d'utilisation de la version bêta de l'IA générative ("Conditions d'utilisation bêta"). Pour cette fonctionnalité, vous pouvez traiter les données à caractère personnel comme indiqué dans l' avenant relatif au traitement des données dans le cloud, sous réserve des restrictions et obligations applicables dans le contrat (tel que défini dans les Conditions d'aperçu).

Le classement est un type de mécanisme de classement qui modifie de manière dynamique la séquence dans laquelle les résultats sont renvoyés après un classement initial établi lors du processus de récupération. Lors de la récupération, la recherche d'agent récupère les documents pertinents du data store par milliers (en fonction de la taille du data store). Ensuite, les meilleurs résultats sont affichés en fonction de la condition spécifiée pour le re-classement. Pour en savoir plus, consultez À propos de la récupération et du classement.

Cette page explique comment classer les résultats d'une requête de recherche effectuée sur des datastores de données structurées et sur des datastores de données non structurées avec des métadonnées.

Types de données compatibles pour le classement des résultats

Voici les types de champs selon lesquels vous pouvez classer vos résultats de recherche :

• string
• number
• datetime
• geolocation

Avant de commencer

Assurez-vous de disposer d'une application avec un data store contenant des données structurées ou des données non structurées avec des métadonnées.

Classer vos résultats de recherche

Pour classer les résultats de recherche d'un data store structurées ou d'un data store non structurées avec des métadonnées, procédez comme suit :

REST

Pour utiliser l'API afin de classer les résultats de recherche d'une application avec des données structurées ou des données non structurées avec des métadonnées, utilisez la engines.servingConfigs.search méthode :

Remarque : Vous pouvez effectuer une recherche dans une application à l'aide de la engines.servingConfigs.search méthode, et dans un data store à l'aide de la dataStores.servingConfigs.search méthode. Pour la procédure suivante, Google vous recommande d'effectuer une recherche à l'aide de la méthode engines.servingConfigs.search.

1. Recherchez l'ID de votre application. Si vous disposez déjà de l'ID de votre application, passez à l'étape suivante.

   1. Dans la Google Cloud console, accédez à la page Applications d'IA.

      Accédez à "Applications".

   2. Sur la page Applications, recherchez le nom de votre application et retrouvez son ID dans la colonne ID.

2. Effectuez une requête de recherche et incluez le champ orderBy.

   Terme clé : Dans la recherche d'agent, le terme application peut être utilisé de manière interchangeable avec le terme moteur dans le contexte des API.

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
   -H "Content-Type: application/json" \
   "https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search:search" \
   -d '{
   "servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
   "query": "QUERY",
   "orderBy": "ORDER_BY"
   }'
   

   Remplacez les éléments suivants :

   • PROJECT_ID : ID de votre Google Cloud projet.
   • APP_ID : ID de l'application de recherche d'agent.
   • QUERY : texte de la requête à rechercher.
   • ORDER_BY : ordre dans lequel les résultats sont organisés. L'ordre de tri par défaut est croissant. Par exemple, si vous spécifiez date , les résultats sont renvoyés du plus ancien au plus récent. Pour obtenir un ordre de tri décroissant, ajoutez desc à la valeur date (par exemple, date desc). Pour obtenir d'autres exemples, consultez orderBy exemples.

   Exemple de commande et résultat

   curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json" \
     "https://discoveryengine.googleapis.com/v1alpha/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/servingConfigs/default_search:search" \
   -d '{
       "query": "hotel",
       "orderBy": "rating desc"
      }'
       
   
   {
   "results": [
   {
     "id": "10d480b19c256bb1",
     "document": {
       "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/10d480b19c256bb1",
       "id": "10d480b19c256bb1",
       "structData": {
         "available_date": "2023-11-05",
         "amenities": [
           "Lake Views",
           "Private Beach",
           "Spa",
           "Water Activities"
         ],
         "room_types": [
           "Lakefront Suite",
           "Deluxe Room",
           "Cottage"
         ],
         "location": {
           "address": "988 Serenity Circle, Tranquil Town, NV 89501, USA"
         },
         "rating": 4.6,
         "id": 11,
         "price_per_night": 220.5,
         "title": "Serenity Springs Hotel"
       }
     }
   },
   {
     "id": "9ffae8af37cc8b63",
     "document": {
       "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/9ffae8af37cc8b63",
       "id": "9ffae8af37cc8b63",
       "structData": {
         "title": "Riverfront Plaza Hotel",
         "rating": 4.2,
         "location": {
           "address": "101 Main St, Anytown, CA 94501, USA"
         },
         "price_per_night": 145.8,
         "amenities": [
           "Fitness Center",
           "Conference Rooms",
           "Restaurant",
           "Valet Parking"
         ],
         "id": 3,
         "room_types": [
           "Executive Suite",
           "King Room",
           "Double Queen"
         ],
         "available_date": "2023-11-15"
       }
     }
   },
   {
     "id": "3be9e854d8f3a47f",
     "document": {
       "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/3be9e854d8f3a47f",
       "id": "3be9e854d8f3a47f",
       "structData": {
         "amenities": [
           "Oceanfront Views",
           "Pool",
           "Spa",
           "Beachside Dining"
         ],
         "available_date": "2023-09-18",
         "location": {
           "address": "449 Oceanfront Drive, Seaside Resort, CA 92007, USA"
         },
         "id": 13,
         "title": "Ocean Breeze Hotel",
         "room_types": [
           "Ocean View Suite",
           "Deluxe Room",
           "Family Suite"
         ],
         "rating": 4.1,
         "price_per_night": 180
       }
     }
   }
   ],
   "totalSize": 3,
   "attributionToken": "wAHwvwoMCNDYz7UGEMCklrsCEiQ2NmIzYmU5My0wMDAwLTIxMDUtYmUyNy01ODI0MjljMzdlZTQiB0dFTkVSSUMqgAHd1akt3e2ILebtiC2CspoigLKaIpjeqC-q-LMtjr6dFeqCsS2W3qgvwvCeFaz4sy2jgJcinta3LeiCsS3b7Ygt5O2ILa3Eii3Usp0Vpp-VLZzWty359rMt-_azLaCJsy3dj5oixcvzF6vEii2iibMttreMLd_VqS3bj5oipJ-VLQ",
   "guidedSearchResult": {},
   "summary": {}
   }
       

   Dans cet exemple, les documents contenant le mot "hôtel" sont classés par note, de l'hôtel Serenity Springs (4,6) à l'hôtel Ocean Breeze (4,1).

Exemples orderBy

Pour classer un champ de chaîne appelé title :

• "orderBy": "title" pour renvoyer les documents par ordre alphabétique croissant en fonction du titre.

• "orderBy": "title desc" pour renvoyer les documents triés par ordre alphabétique inverse (de Z à A) en fonction du titre.

Pour classer un champ numérique appelé rating :

• "orderBy": "rating" pour classer les documents du moins bien noté au mieux noté.

• "orderBy": "rating desc" pour classer les documents du mieux noté au moins bien noté.

Pour classer un champ de date et d'heure appelé available_date :

• "orderBy": "available_date" pour classer les documents du plus tôt disponible au plus tard.

• "orderBy": "available_date desc" pour classer les documents de celui dont la date de disponibilité est la plus éloignée à celui dont la date de disponibilité est la plus proche.

Pour classer en fonction de la géolocalisation dans un champ appelé location :

• "orderBy": "GEO_DISTANCE(location, \"Mountain View, CA\")" trie les documents par ordre de proximité avec Mountain View.

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc" trie les documents par ordre de distance par rapport à l'emplacement 37,38° N et 122,08° O.