Ordenar resultados de repositórios de dados estruturados (legado)

Importante: o Gemini Enterprise recupera os resultados da pesquisa do assistente usando o StreamAssist. Recomendamos usar o StreamAssist em vez da Pesquisa e resposta. Para mais informações, consulte Receber resultados da pesquisa usando o StreamAssist.

Observação: Este recurso é um serviço em pré-lançamento, sujeito aos Termos das Ofertas de pré-GA dos Termos específicos de serviço do GCP. Os produtos e recursos pré-GA podem ter suporte limitado, e as mudanças neles podem não ser compatíveis com outras versões pré-GA. Para mais informações, consulte as descrições da fase de lançamento. Além disso, ao usar esse recurso, você concorda com os Termos e condições de IA generativa em pré-lançamento ("Termos de Pré-lançamento"). Para esse recurso, é possível processar dados pessoais conforme descrito no Aditivo sobre tratamento de dados do Cloud, sujeito às restrições e às obrigações aplicáveis no Contrato (conforme definido nos Termos de Pré-lançamento).

Nesta página, explicamos como ordenar os resultados de uma consulta de pesquisa feita em repositórios de dados estruturados e não estruturados com metadados.

Tipos de dados compatíveis para ordenar os resultados

Estes são os tipos de campo que podem ser usados para ordenar os resultados da pesquisa:

• string
• number
• datetime
• geolocation

Antes de começar

Verifique se você tem um app com um repositório de dados que contém dados estruturados ou não estruturados com metadados.

Ordenar os resultados da pesquisa

Para ordenar os resultados da pesquisa de um repositório de dados estruturados ou não estruturados com metadados, siga estas etapas:

REST

Para usar a API para ordenar os resultados da pesquisa de um app com dados estruturados ou não estruturados com metadados, use o método engines.servingConfigs.search:

Observação: é possível pesquisar em um app usando o engines.servingConfigs.search método e em um repositório de dados usando o dataStores.servingConfigs.search método. Para o procedimento a seguir, o Google recomenda pesquisar usando o método engines.servingConfigs.search.

1. Encontre o ID do app. Se você já tiver o ID do app, pule para a próxima etapa.

   1. No Google Cloud console, acesse a página Gemini Enterprise.

      Acessar "Apps".

   2. Na página Apps, encontre o nome do seu app e acesse o ID dele na coluna ID.

2. Faça uma consulta de pesquisa e inclua o campo orderBy.

   Termo principal: no Gemini Enterprise, o termo app pode ser usado de forma intercambiável com o termo mecanismo no contexto das APIs. Um mecanismo do Gemini Enterprise é um mecanismo de pesquisa genérico em que o app_type campo está definido como 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"
   }'
   

   Substitua:

   • PROJECT_ID: o ID do seu projeto.
   • APP_ID: o ID do app.
   • QUERY: o texto da consulta a ser pesquisado.
   • ORDER_BY: a ordem em que os resultados são organizados. A ordem de classificação padrão é crescente. Por exemplo, especificar date retorna resultados do mais antigo para o mais recente. Para receber a ordem de classificação decrescente, anexe desc ao valor date. Por exemplo, date desc. Para mais exemplos, consulte orderBy exemplos.

   Exemplo de comando e 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": {}
   }
       

   Neste exemplo, os documentos que contêm a palavra "hotel" são ordenados por classificação, do Serenity Springs Hotel com uma classificação de 4,6 ao Ocean Breeze Hotel com uma classificação de 4,1.

Exemplos de orderBy

Para ordenar um campo de string chamado title:

• "orderBy": "title" para retornar os documentos em ordem alfabética crescente de acordo com o título.

• "orderBy": "title desc" para retornar os documentos classificados em ordem alfabética inversa (de Z a A) de acordo com o título.

Para ordenar um campo numérico chamado rating:

• "orderBy": "rating" para ordenar do documento com a classificação mais baixa para a mais alta.

• "orderBy": "rating desc" para ordenar do documento com a classificação mais alta para a mais baixa.

Para ordenar um campo de data e hora chamado available_date:

• "orderBy": "available_date" para ordenar do documento disponível mais próximo para o mais distante.

• "orderBy": "available_date desc" para ordenar do documento com a data de disponibilidade mais distante para o mais próximo.

Para ordenar de acordo com a geolocalização em um campo chamado location:

• "orderBy": "GEO_DISTANCE(location, \"Mountain View, CA\")" classifica os documentos em ordem dos mais próximos de Mountain View para os mais distantes.

• "orderBy": "GEO_DISTANCE(location, 37.38, -122.08) desc" classifica os documentos em ordem do mais distante para o mais próximo do local 37,38°N e 122,08°W.