從結構化資料儲存庫排序結果 (舊版)

重要事項：Gemini Enterprise 會使用 StreamAssist 從助理擷取搜尋結果。建議使用 StreamAssist，而非 Search and Answer。 詳情請參閱「使用 StreamAssist 取得搜尋結果」。

注意： 這項功能是預先發布版產品，使用時須遵守《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 控制台的「Gemini Enterprise」頁面。

      前往「應用程式」

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

2. 提出搜尋查詢，並加入 orderBy 欄位。

   重要術語：在 Gemini Enterprise 中，就 API 而言，應用程式和引擎這兩個詞彙可以互換使用。Gemini Enterprise 引擎是一般搜尋引擎，其 app_type 欄位設為 APP_TYPE_INTRANET。

   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：專案 ID。
   • APP_ID：應用程式 ID。
   • QUERY：要搜尋的查詢文字。
   • ORDER_BY：結果的排列順序。預設排列順序為遞增。舉例來說，指定 date 會傳回從最舊到最新的結果。如要以遞減順序排序，請在 date 值後方附加 desc，例如 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\")" 會將文件排序，從距離 Mountain View 最近的文件排到最遠的文件。

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc" 會將文件排序，從距離北緯 37.38 度、西經 122.08 度最遠的位置排到最近的位置。