对来自结构化数据存储区的结果进行排序

注意：此功能为预览版，受 GCP 服务专用条款中的“非正式版产品使用条款”约束。我们对正式发布前产品和功能的支持可能比较有限，并且对正式发布前产品和功能的更改可能与其他正式发布前版本不兼容。如需了解详情，请参阅发布阶段说明。此外，使用此功能，即表示您同意生成式 AI 预览版条款及条件（“预览版条款”）。对于此功能，您可以按照云端数据处理附录中的说明处理个人数据，但受到协议中的适用限制和义务（如“预览版条款”中所定义）的约束。

本页面介绍了如何对针对结构化数据存储区和带有元数据的非结构化数据存储区发出的搜索查询的结果进行排序。

支持对结果排序的数据类型

您可以根据以下字段类型对搜索结果进行排序：

• 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 会返回从最旧到最新的结果。如需按降序排序，请在 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\")"：按离山景城的距离从最近到最远对文档进行排序。

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc"：按离 37.38°N 和 122.08°W 位置的距离从最远到最近对文档进行排序。