Console
Start free

Order web search results

Ordering is a type of ranking mechanism that dynamically changes the sequence in which results are returned after an initial ranking that's established during the retrieval process. During retrieval, Agent Search fetches the relevant documents from the data store in the order of thousands (subject to the size of the data store). After this the top results are served according to the condition specified for reordering. For more information, see About retrieval and ranking.

This page explains how to order the results of a web search query by date.

Before you begin

Make sure that you do the following:

Order search results for basic website search

To order the search results for a website data store with basic website search, follow these steps:

REST

The following sample shows how to to order your web search results for an app with basic website search. This sample uses 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 AI Applications page.

      Go to Apps

    2. On the Apps page, find the name of your app and get the app's ID from the ID column.

  2. Make a search query and include the orderBy field.

    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 '{
"servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
"query": "QUERY",
"orderBy": "ORDER_BY"
}'

    Replace the following:

REST

The following sample shows how to order your web search results for an app with advanced website indexing. This sample uses the engines.servingConfigs.search method:

  • 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 AI Applications page.

      Go to Apps

    2. On the Apps page, find the name of your app and get the app's ID from the ID column.

    • Make a search query and include the orderBy field.

    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 '{
"servingConfig": "projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/servingConfigs/default_search",
"query": "QUERY",
"orderBy": "ORDER_BY"
}'

    Replace the following:

  • PROJECT_ID: the ID of your Google Cloud project.
  • APP_ID: the ID of the Agent Search app.
  • QUERY: the query text to search.
    • ORDER_BY: the order in which the results are arranged. The field can have values that are of the following data types: datetime, integer, or number. To order chronologically, specify the custom date attribute specified in the schema or the Google-inferred page date to return web pages sorted by date. For example, to order by a date_edited PageMap attribute, you can specify the orderBy field as "orderBy": "date_edited". The default sort order is ascending, in which older pages are returned first. To get the results in descending order, append desc to the custom attribute value—for example, "orderBy":"date_edited desc".