Trier les résultats à partir de magasins de données structurées

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).

Cette page explique comment trier 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 acceptés pour l'ordre des résultats

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

• string
• number
• datetime
• geolocation

Avant de commencer

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

Trier vos résultats de recherche

Pour trier 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 trier 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 méthode engines.servingConfigs.search :

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

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

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

      Accédez à "Applications".

   2. Sur la page Applications, recherchez le nom de votre application et récupérez son ID dans la colonne ID.

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

   Terme clé : Dans Vertex AI Search, 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 projet Google Cloud .
   • APP_ID : ID de l'application Vertex AI Search.
   • 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 Exemples de orderBy.

   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 (note 4,6) à l'hôtel Ocean Breeze (note 4,1).

orderBy exemples

Pour trier les résultats selon 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 trier les résultats selon un champ numérique appelé rating :

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

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

Pour trier les résultats selon un champ datetime appelé available_date :

• "orderBy": "available_date" pour trier les documents du plus proche au plus éloigné.

• "orderBy": "available_date desc" pour commander les documents en commençant par celui dont la date de disponibilité est la plus éloignée, puis en allant vers celui dont la date de disponibilité est la plus proche.

Pour trier selon la géolocalisation sur un champ appelé location :

• "orderBy": "GEO_DISTANCE(location, \"Mountain View, CA\")" trie les documents du plus proche au plus éloigné de Mountain View.

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc" trie les documents du plus éloigné au plus proche de l'emplacement 37,38°N et 122,08°O.