Ordena los resultados de los almacenes de datos estructurados

Nota: Esta función es una oferta de vista previa, sujeta a las “Condiciones de la oferta de la fase previa a la DG” de las Condiciones específicas del servicio de GCP. La asistencia de los productos y las características de la fase previa a la DG puede ser limitada, y es posible que los cambios en estos productos y características no sean compatibles con otras versiones de la fase previa a la DG. Para obtener más información, consulta las descripciones de la etapa de lanzamiento. Además, si usas esta función, aceptas los Términos y Condiciones de la Versión Preliminar de IA Generativa (“Términos de la Versión Preliminar”). Para usar esta función, puedes procesar datos personales como se describe en el Anexo de Tratamiento de Datos de Cloud, sujeto a las restricciones y obligaciones aplicables en el Acuerdo (como se define en los Términos de la Versión Preliminar).

En esta página, se explica cómo ordenar los resultados de una búsqueda en almacenes de datos estructurados y en almacenes de datos no estructurados con metadatos.

Tipos de datos admitidos para ordenar los resultados

Estos son los tipos de campos por los que puedes ordenar los resultados de la búsqueda:

• string
• number
• datetime
• geolocation

Antes de comenzar

Asegúrate de tener una app con un almacén de datos que contenga datos estructurados o datos no estructurados con metadatos.

Ordena los resultados de la búsqueda

Para ordenar los resultados de la búsqueda de un almacén de datos estructurados o de uno con datos no estructurados con metadatos, sigue estos pasos:

REST

Para usar la API y ordenar los resultados de la búsqueda de una app con datos estructurados o datos no estructurados con metadatos, usa el método engines.servingConfigs.search:

Nota: Puedes buscar en una app con el método engines.servingConfigs.search y en un almacén de datos con el método dataStores.servingConfigs.search. Para el siguiente procedimiento, Google recomienda realizar la búsqueda con el método engines.servingConfigs.search.

1. Busca el ID de tu app. Si ya tienes el ID de tu app, ve al siguiente paso.

   1. En la consola de Google Cloud, ve a la página Agent Builder.

      Ve a Apps.

   2. En la página Apps, busca el nombre de tu app y obtén su ID de la columna ID.

2. Realiza una búsqueda y, luego, incluye el campo orderBy.

   Término clave: En Vertex AI Search, el término app se puede usar de manera indistinta con el término motor en el contexto de las APIs.

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

   Reemplaza lo siguiente:

   • PROJECT_ID: El ID de tu proyecto de Google Cloud.
   • APP_ID: El ID de la app de Vertex AI Search.
   • QUERY: Es el texto de la búsqueda.
   • ORDER_BY: Es el orden en el que se organizan los resultados. El orden de clasificación predeterminado es ascendente. Por ejemplo, si especificas date, se muestran los resultados de la más antigua a la más reciente. Para obtener un orden descendente, agrega desc al valor date; por ejemplo, date desc. Para ver más ejemplos, consulta Ejemplos de orderBy.

   Ejemplo de comando y resultado

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

   En este ejemplo, los documentos que contienen la palabra "hotel" se ordenan por calificación, desde el Hotel Serenity Springs con una calificación de 4.6 hasta el Hotel Ocean Breeze con una calificación de 4.1.

orderBy ejemplos

Para ordenar en un campo de cadena llamado title, haz lo siguiente:

• "orderBy": "title" para mostrar los documentos en orden alfabético ascendente según el título.

• "orderBy": "title desc" para mostrar los documentos ordenados en orden alfabético inverso (de Z a A) según el título.

Para ordenar en un campo numérico llamado rating, haz lo siguiente:

• "orderBy": "rating" para ordenar los documentos de la calificación más baja a la más alta.

• "orderBy": "rating desc" para ordenar los documentos de la calificación más alta a la más baja.

Para ordenar en un campo de fecha y hora llamado available_date, haz lo siguiente:

• "orderBy": "available_date" para ordenar desde el documento más reciente disponible hasta el más antiguo.

• "orderBy": "available_date desc" para ordenar desde el documento con la fecha disponible más lejana hasta la más próxima.

Para ordenar según la geolocalización en un campo llamado location, haz lo siguiente:

• "orderBy": "GEO_DISTANCE(location, \"Mountain View, CA\")" ordena los documentos de los más cercanos a Mountain View a los más alejados.

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc" ordena los documentos de la ubicación más lejana a la más cercana a 37.38°N y 122.08°O.