Ergebnisse aus Datenspeichern für strukturierte Daten anfordern

Hinweis: Dieses Feature ist ein Vorschauangebot, das den Pre-GA-Bedingungen in den Nutzungsbedingungen des GCP-Dienstes unterliegt. Pre-GA-Produkte und -Funktionen werden eventuell nur eingeschränkt unterstützt. Änderungen an Pre-GA-Produkten und -Funktionen sind möglicherweise nicht mit anderen Pre-GA-Versionen kompatibel. Weitere Informationen finden Sie unter den Beschreibungen der Startphase. Wenn Sie diese Funktion verwenden, stimmen Sie außerdem den Nutzungsbedingungen für die Vorschau der generativen KI zu ("Vorschaubedingungen"). Für diese Funktion können personenbezogene Daten gemäß dem Zusatz zur Verarbeitung von Cloud-Daten verarbeitet werden, vorbehaltlich der geltenden Einschränkungen und Verpflichtungen in der Vereinbarung (wie in den Vorschaubedingungen definiert).

Auf dieser Seite wird erläutert, wie Sie die Ergebnisse einer Suchanfrage in strukturierten Datenspeichern und in unstrukturierten Datenspeichern mit Metadaten sortieren.

Unterstützte Datentypen für die Sortierung der Ergebnisse

Die Suchergebnisse können nach folgenden Feldtypen sortiert werden:

• string
• number
• datetime
• geolocation

Hinweise

Sie benötigen eine App mit einem Datenspeicher, der strukturierte Daten oder unstrukturierte Daten mit Metadaten enthält.

Suchergebnisse sortieren

So ordnen Sie die Suchergebnisse für einen strukturierten Datenspeicher oder einen unstrukturierten Datenspeicher mit Metadaten:

REST

Wenn Sie die API verwenden möchten, um die Suchergebnisse für eine App mit strukturierten Daten oder unstrukturierten Daten mit Metadaten zu sortieren, verwenden Sie die Methode engines.servingConfigs.search:

Hinweis:Mit der Methode engines.servingConfigs.search können Sie in einer App und mit der Methode dataStores.servingConfigs.search in einem Datenspeicher suchen. Für die folgende Vorgehensweise empfiehlt Google die Suche mit der engines.servingConfigs.search-Methode.

1. Suchen Sie Ihre App-ID. Wenn Sie bereits eine App-ID haben, fahren Sie mit dem nächsten Schritt fort.

   1. Rufen Sie in der Google Cloud Console die Seite Agent Builder auf.

      Zu Apps wechseln

   2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und sehen Sie sich die ID der App in der Spalte ID an.

2. Stellen Sie eine Suchanfrage und fügen Sie das Feld orderBy ein.

   Wichtiger Begriff:In Vertex AI Search kann der Begriff App im Kontext von APIs synonym mit dem Begriff Engine verwendet werden.

   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"
   }'
   

   Ersetzen Sie Folgendes:

   • PROJECT_ID: die ID Ihres Google Cloud Projekts.
   • APP_ID: Die ID der Vertex AI Search-Anwendung.
   • QUERY: Der Suchtext.
   • ORDER_BY: die Reihenfolge, in der die Ergebnisse angeordnet sind. Die Standardsortierreihenfolge ist aufsteigend. Wenn Sie beispielsweise date angeben, werden Ergebnisse vom ältesten zum neuesten zurückgegeben. Wenn die Sortierung in absteigender Reihenfolge erfolgen soll, fügen Sie dem date-Wert desc hinzu, z. B. date desc. Weitere Beispiele finden Sie unter orderBy-Beispiele.

   Beispielbefehl und -ergebnis

   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 diesem Beispiel werden die Dokumente, die das Wort „Hotel“ enthalten, nach Bewertung sortiert, vom Serenity Springs Hotel mit einer Bewertung von 4,6 bis zum Ocean Breeze Hotel mit einer Bewertung von 4,1.

Beispiele für orderBy

So ordnen Sie nach einem Stringfeld namens title:

• "orderBy": "title", um die Dokumente in aufsteigender alphabetischer Reihenfolge nach Titel zurückzugeben.

• "orderBy": "title desc", um die Dokumente in umgekehrter alphabetischer Reihenfolge (von Z nach A) nach dem Titel zurückzugeben.

So ordnen Sie nach einem Zahlenfeld namens rating:

• "orderBy": "rating", um die Dokumente von der niedrigsten bis zur höchsten Bewertung zu sortieren.

• "orderBy": "rating desc", um die Dokumente von der höchsten zur niedrigsten Bewertung zu sortieren.

So ordnen Sie nach einem Datums- und Uhrzeitfeld namens available_date:

• "orderBy": "available_date", um die Dokumente vom frühesten bis zum spätesten Datum zu sortieren.

• "orderBy": "available_date desc", um die Dokumente vom Dokument mit dem spätesten verfügbaren Datum zum Dokument mit dem frühesten verfügbaren Datum zu bestellen.

So ordnen Sie nach Standort in einem Feld namens location:

• "orderBy": "GEO_DISTANCE(location, \"Mountain View, CA\")" sortiert die Dokumente in der Reihenfolge von den am nächsten zu Mountain View gelegenen bis zu den am weitesten von Mountain View entfernten.

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc" sortiert die Dokumente in der Reihenfolge vom am weitesten entfernten zum am nächsten gelegenen Standort 37,38° N und 122,08° W.