Get search results

Console

To use the Google Cloud console to preview search results for an app with structured or unstructured data, follow these steps:

1. Open the Previewpage in the console.
2. Type a search query.
   1. If you enabled autocomplete in step 1, you'll see a list of autocomplete suggestions below the search bar as you type.
3. (Optional) If you connected multiple data stores to your app but want results only from a specific data store, select the data store to get results from.
4. Click Enterto submit the query.
   1. A list of search results appears below the search bar.
   2. If no attribute mapping is defined in the Configurationspage, each search result appears as a list of raw attribute names and values.
   3. If any attribute mappings were saved in the Configurationspage, the search results display the same images that you see in the Configurationspage preview.
5. If any facets were specified in the Configurationspage, they are displayed in the same way.
6. Click the arrow below the results list to load the next page of results.

REST

To use the API to get search results for an app with structured or unstructured data, use the engines.servingConfigs.search method:

1. Find your app ID. If you already have your app ID, skip to the next step.

   1. In the Google Cloud console, go to the Agentspacepage.

      Go to Apps

   2. On the Appspage, find the name of your app and get the app's ID from the IDcolumn.

2. Preview search results.

    curl  
   -X  
   POST  
   -H  
    "Authorization: Bearer 
    $( 
   gcloud  
   auth  
   print-access-token ) 
    " 
     
    \ 
   -H  
    "Content-Type: application/json" 
     
    \ 
    "https://discoveryengine.googleapis.com/v1/projects/ PROJECT_ID 
   /locations/global/collections/default_collection/engines/ APP_ID 
   /servingConfigs/default_search:search" 
     
    \ 
   -d  
    '{ 
    "query": " QUERY 
   ", 
    "userPseudoId": " USER_PSEUDO_ID 
   ", 
    "pageSize": " PAGE_SIZE 
   ", 
    "offset": " OFFSET 
   ", 
    "orderBy": " ORDER_BY 
   ", 
    "filter": " FILTER 
   ", 
    "boostSpec": " BOOST_SPEC 
   ", 
    "facetSpec": " FACET_SPEC 
   ", 
    "queryExpansionSpec": " QUERY_EXPANSION_SPEC 
   ", 
    "spellCorrectionSpec": " SPELL_CORRECTION_SPEC 
   ", 
    "contentSearchSpec": " CONTENT_SEARCH_SPEC 
   ", 
    "dataStoreSpecs": [{" DATA_STORE_SPEC 
   "}], 
    }' 
    
   

   Replace the following:

   • PROJECT_ID : the ID of your project.
   • APP_ID : the ID of the app that you want to query.
   • QUERY : the query text to search.
   • USER_PSEUDO_ID : optional. This is a pseudonymized identifier for tracking a search visitor. Google strongly recommends using this field, which improves model performance and personalization quality. You can use an HTTP cookie for this field, which uniquely identifies a visitor on a single device. This identifier does not change when the visitor signs in or out of a website. Don't set this field to the same identifier for multiple users—this would combine their event histories and degrade model quality. Don't include personally identifiable information (PII) in this field.

   • PAGE_SIZE : the number of results returned by the search. The maximum allowed page size depends on the data type. Page sizes above the maximum value are coerced to the maximum value.

     • Websites with basic indexing: Default 10 , Maximum 25
     • Websites with advanced indexing: Default 25 , Maximum 50
     • Other: Default 50 , Maximum 100

   • OFFSET : optional. The starting index of the results. The default value is 0.

     For example, if the offset is 2, the page size is 10, and there are 15 results to return, results 2 through 11 are returned on the first page.

   • ORDER_BY : optional. The order in which the results are arranged.

   • FILTER : optional. A text field for filtering your search using a filter expression. The default value is an empty string, which means no filter is applied.

     Example: color: ANY("red", "blue") AND score: IN(*, 100.0e)

     For more information, see Filter search for structured or unstructured data .

   • BOOST_SPEC : optional. A specification to boost or bury documents. Values:

     • BOOST : a floating point number in the range [-1,1]. When the value is negative, results are demoted (they appear lower down in the results). When the value is positive, results are promoted (they appear higher up in the results).
     • CONDITION : a text filter expression to select the documents to which boost is applied. The filter must evaluate to a boolean value.

     To learn about boost for structured search, see Boost search results .

   • FACET_SPEC : optional. A facet specification to perform faceted search.

   • QUERY_EXPANSION_SPEC : optional. A specification to determine under which conditions query expansion should occur. Default is DISABLED .

   • SPELL_CORRECTION_SPEC : optional. A specification to determine under which conditions spell correction should occur. Default is AUTO .

   • CONTENT_SEARCH_SPEC : optional. For getting snippets, extractive answers, extractive segments, and search summaries. For unstructured data only. For more information, see:

     • Use snippets and extractive content
     • Get search summaries

   • DATA_STORE_SPEC : filters for a specific data store to search across. This can be used if your search app is connected to multiple data stores. For more information, see DataStoreSpec .

   • Viewing guided search results in the search response:

     Guided search results are returned with search responses for structured and unstructured search. The guided search result contains a list of extracted attribute key-value pairs based on search result documents. This allows users to refine their search results by using some attribute keys and values as filters.

     In this example response, the color green was used to refine search results by issuing a new search request with the filter field specified as _gs.color: ANY("green") :

       { 
      "guidedSearchResult" 
      : 
       
      { 
       
      "refinementAttributes" 
      : 
       
      [ 
       
      { 
       
      "attributeKey" 
      : 
       
      "_gs.color" 
      , 
       
      "attributeValue" 
       
      : 
       
      "green" 
       
      }, 
       
      { 
       
      "attributeKey" 
      : 
       
      "_gs.category" 
      , 
       
      "attributeValue" 
       
      : 
       
      "shoe" 
       
      } 
       
      ] 
      } 
      }