從結構化資料儲存庫排序結果

注意 ： 這項功能是預先發布版產品，使用時須遵守《GCP 服務專屬條款》的《正式發布前產品條款》。 正式發布前的產品和功能或許只提供部分支援，而且這類產品和功能的變更，可能與其他正式發布前版本不相容。詳情請參閱推出階段說明。此外，使用這項功能即表示您同意《生成式 AI 預先發布版條款及細則》(下稱「預先發布版條款」)。就這項功能而言，您可以按照《Cloud 資料處理附加條款》所述方式處理個人資料，同時也必須遵守「協議」中的適用限制和義務 (相關定義請見「預先發布版條款」)。

本頁面說明如何排序對結構化資料儲存庫和含有中繼資料的非結構化資料儲存庫發出的搜尋查詢結果。

支援的資料類型，可用於排序結果

您可以根據下列欄位類型排序搜尋結果：

• string
• number
• datetime
• geolocation

事前準備

確認您擁有應用程式，且應用程式的資料儲存庫包含結構化資料或附有中繼資料的非結構化資料。

將搜尋結果排序

如要排序結構化資料儲存庫或含有中繼資料的非結構化資料儲存庫搜尋結果，請按照下列步驟操作：

REST

如要使用 API 依結構化資料或含有中繼資料的非結構化資料排序應用程式的搜尋結果，請使用 engines.servingConfigs.search 方法：

注意：您可以使用 engines.servingConfigs.search 方法搜尋應用程式，並使用 dataStores.servingConfigs.search 方法搜尋資料儲存庫。Google 建議您使用 engines.servingConfigs.search 方法進行搜尋，以完成下列程序。

1. 找出應用程式 ID。如果已有應用程式 ID，請跳到下一個步驟。

   1. 前往 Google Cloud 控制台的「AI Applications」頁面。

      前往「應用程式」

   2. 在「應用程式」頁面中，找出應用程式名稱，然後從「ID」欄取得應用程式的 ID。

2. 建立搜尋查詢並加入 orderBy 欄位。

   重要詞彙：在 Vertex AI Search 中，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"
   }'
   

   更改下列內容：

   • PROJECT_ID：您的 Google Cloud 專案 ID。
   • APP_ID：Vertex AI Search 應用程式的 ID。
   • QUERY：要搜尋的查詢文字。
   • ORDER_BY：結果的排列順序。預設排序順序為遞增。舉例來說，指定 date 會傳回從最舊到最新的結果。如要取得遞減排序順序，請將 desc 附加至 date 值，例如 date desc。如需更多範例，請參閱orderBy 範例。

   指令與結果範例

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

   在本範例中，含有「hotel」一詞的文件會依評分排序，從評分 4.6 的 Serenity Springs Hotel 到評分 4.1 的 Ocean Breeze Hotel。

orderBy 個樣本

如要依名為 title 的字串欄位排序：

• "orderBy": "title"，即可依文件標題的字母順序遞增排序。

• "orderBy": "title desc"，即可依標題以反向字母順序 (從 Z 到 A) 排序文件。

如要依名為 rating 的數字欄位排序：

• "orderBy": "rating"，即可依評分由低到高排序文件。

• "orderBy": "rating desc"，即可依評分由高至低排序文件。

如要依名為 available_date 的日期時間欄位排序：

• "orderBy": "available_date"，即可依時間順序排列文件。

• "orderBy": "available_date desc"，依可預訂日期排序，從最遠的日期到最近的日期。

如要根據名為 location 的欄位中的地理位置排序，請執行下列操作：

• "orderBy": "GEO_DISTANCE(location, \"Mountain View, CA\")" 會依據文件與山景城的距離排序，從最近到最遠。

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc" 會依據與 37.38°N 和 122.08°W 位置的距離，由遠到近排序文件。