Ordinare i risultati dai datastore di dati strutturati

Nota: questa funzionalità è un'offerta in anteprima, soggetta ai "Termini dell'offerta pre-GA" dei Termini di servizio specifici per Google Cloud. I prodotti e le funzionalità pre-GA potrebbero avere supporto limitato e le modifiche ai prodotti e alle funzionalità pre-GA potrebbero non essere compatibili con altre versioni pre-GA. Per ulteriori informazioni, consulta le descrizioni della fase di lancio. Inoltre, utilizzando questa funzionalità, accetti i Termini e condizioni di Anteprima dell'IA generativa ("Termini di anteprima"). Per questa funzionalità, puoi trattare i dati personali come descritto nell'Addendum per il trattamento dei dati Cloud, in conformità alle limitazioni e alle obbligazioni applicabili del Contratto (come definite nei Termini di anteprima).

Questa pagina spiega come ordinare i risultati di una query di ricerca eseguita su datastore di dati strutturati e su datastore di dati non strutturati con metadati.

Tipi di dati supportati per l'ordinamento dei risultati

Questi sono i tipi di campi in base ai quali puoi ordinare i risultati di ricerca:

• string
• number
• datetime
• geolocation

Prima di iniziare

Assicurati di avere un'app con un data store contenente dati strutturati o non strutturati con metadati.

Ordinare i risultati di ricerca

Per ordinare i risultati di ricerca per un data store strutturato o per un data store non strutturato con metadati:

REST

Per utilizzare l'API per ordinare i risultati di ricerca per un'app con dati strutturati o con dati non strutturati con metadati, utilizza il metodo engines.servingConfigs.search:

Nota: puoi eseguire ricerche in un'app utilizzando il metodo engines.servingConfigs.search e in un datastore utilizzando il metodo dataStores.servingConfigs.search. Per la procedura che segue, Google consiglia di eseguire la ricerca utilizzando il metodo engines.servingConfigs.search.

1. Trova l'ID app. Se hai già l'ID app, vai al passaggio successivo.

   1. Nella console Google Cloud, vai alla pagina Agent Builder.

      Vai ad App

   2. Nella pagina App, trova il nome della tua app e recupera l'ID dall'app colonna ID.

2. Esegui una query di ricerca e includi il campo orderBy.

   Termine chiave: in Vertex AI Search, il termine app può essere utilizzato in modo intercambiabile con il termine engine nel contesto delle 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"
   }'
   

   Sostituisci quanto segue:

   • PROJECT_ID: l'ID del tuo Google Cloud progetto.
   • APP_ID: l'ID dell'app Vertex AI Search.
   • QUERY: il testo della query da cercare.
   • ORDER_BY: l'ordine in cui sono disposti i risultati. L'ordinamento predefinito è crescente. Ad esempio, se specifichi date , i risultati vengono restituiti dal più antico al più recente. Per ottenere un ordine di ordinamento crescente, accoda desc al valore date, ad esempio date desc. Per altri esempi, consulta gli esempi orderBy.

   Comando e risultato di esempio

   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": {}
   }
       

   In questo esempio, i documenti che contengono la parola "hotel" sono ordinati in base alla valutazione, dall'hotel Serenity Springs con una valutazione di 4,6 all'hotel Ocean Breeze con una valutazione di 4,1.

orderBy esempi

Per ordinare in base a un campo di stringhe denominato title:

• "orderBy": "title" per restituire i documenti in ordine alfabetico crescente in base al titolo.

• "orderBy": "title desc" per restituire i documenti in ordine alfabetico inverso (dalla Z alla A) in base al titolo.

Per ordinare in base a un campo numerico denominato rating:

• "orderBy": "rating" per ordinare i documenti dalla valutazione più bassa a quella più alta.

• "orderBy": "rating desc" per ordinare i documenti dalla valutazione più alta a quella più bassa.

Per ordinare in base a un campo data/ora denominato available_date:

• "orderBy": "available_date" per ordinare i documenti dal più recente al meno recente.

• "orderBy": "available_date desc" per ordinare dal documento con la data disponibile più lontana a quella disponibile più prossima.

Per ordinare in base alla geolocalizzazione in un campo denominato location:

• "orderBy": "GEO_DISTANCE(location, \"Mountain View, CA\")" ordina i documenti in ordine da quelli più vicini a Mountain View a quelli più lontani da Mountain View.

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc" ordina i documenti in ordine dal più lontano al più vicino alla posizione 37,38°N e 122,08°O.