Vertex AI Search and Conversation has been renamed to Vertex AI Agent Builder. We are in the process of updating content to reflect the new branding.

Order web search results

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

Before you begin

Make sure that you do the following:

Create a data store with website data. For more information, see Website URLs.
Create a search app and connect it to the data store. For more information, see Create a search app.

Order your web search results

REST

To use the API to order your web search results for an app with website data, use the engines.servingConfigs.search method:

Note: You can search over an app using the engines.servingConfigs.search method and you can search over a data store using the dataStores.servingConfigs.search method. For the following procedure, Google recommends searching using the engines.servingConfigs.search method.

Find your data store ID. If you already have your data store ID, skip to the next step.
1. In the Google Cloud console, go to the Agent Builder page and in the navigation menu, click Data stores.
  
  Go to the Data stores page
2. Click the name of your data store.
3. On the Data page for your data store, get the data store ID.
Make a search query and include the orderBy field.

Key Term: In Vertex AI Search, the term app can be used interchangeably with the term engine in the context of APIs.
```
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 project.
- APP_ID: The ID of your app.
- QUERY: The query text to search.
- ORDER_BY: The order in which the results are arranged. For example, specifying date returns web pages sorted by Google's estimate for each page's date. These estimates are based on features of the web pages such as the date in the title and URL. The default sort order is descending (pages with the most recent dates are returned first). To get ascending sort order, append :a to the date value—for example, date:a.