Media search checklist

This page provides a checklist of the steps required to implement a mediasearch app.

If you're new to Vertex AI Search, consider following theGet startedwith media search quickstarttutorial to create a sample app.

Set up a Google Cloud project, turn on Vertex AI Search, and set up accesscontrol for your project. You can use an existing Google Cloud project if youhave one already.

Actions

  1. Complete the steps inBefore you begin.

Prepare your data for importing to Vertex AI Search.

Media search apps use the following data:

  • Structured media data. Required. Upload metadata information about yourmedia content, such as titles, descriptions, and URIs to the location of yourmedia. Vertex AI Search provides a predefined schema for media.Alternatively, you can use your own schema.

  • User events. Required. User events help rank search results.

Actions

  1. Review information about media data and data stores and prepare your dataaccording to the required schemas and fields inAbout media documents anddata stores. If you areusing your own schema, also seeExample schema as a JSONobject andstructured data.

  2. Review media user event requirements inAbout media userevents.

Create an app and data store and then import your media data.

How you import media data depends on where you're importing it from. Forexample, if your data is in Cloud Storage, you can import it using theconsole or the API by providing the bucket location of your data.

Actions

  1. Create a media data store.

  2. Create media apps.

  3. Bulk import historical user events so thatyour app can start training.

  4. Set up real-time user event recording.

Vertex AI Search provides many configuration options. Some optionsdepend on whether you plan to deploy a search widget.

Actions

Depending on your use case and whether you plan to deploy the out-of-the-boxsearch widget or integrate search API calls into your own code,Vertex AI Search provides several options for configuration.

  1. You can embed a search widget into your website that automatically providesa search bar and expandable search interface. If you plan to deploy thesearch widget, configure the following:

  2. If you plan to integrate search API calls into your server or applicationinstead of using the widget, you can configure your search settings usingthe following options:

    • Field settings. For structured data or for unstructured data withmetadata, update field settings to refine how Vertex AI Searchuses metadata for search. SeeConfigure fields forsearch.

    • Autocomplete. Depending on your data, set up autocomplete suggestionsbased on document content, fields, search history, or user events. SeeConfigure autocomplete.

    • Serving controls. Control when search resultsare boosted, buried, filtered, or redirected, or whether certain queriesare associated with other queries. SeeConfigure servingcontrols for search.

    • Search-as-you-type. If your app uses awkward input devices such as TVremote controls, you can enable the search-as-you-type feature. SeeGetsearch-as-you-type results for a mediaapp.

If you plan to deploy your app by integrating search API calls into your owncode, you can configure filtering and boosting for your search results.

Actions

  1. Filter media search.

  2. Boost search results.

You can preview your search results to check if your app configurations areworking as expected.

Actions

  1. To preview your search results, use the console or the API.

    • Console. Use the Vertex AI Search consolePreview page to previewhow search widget configurations affect your results. See theConsoleinstructions inGet searchresults for media.

    • API. If you're integrating API calls into your application,make API calls to preview your search configurations. See theRESTinstructions inGet searchresults for media.

When you're happy with the preview version of your media search app, share itwith your users by deploying it to your website.

Actions

  1. You can deploy your search app in either of the following ways:

    • Embed the search widget into your website. Vertex AI Searchprovides code that you can copy into your website or web application. Thisdeploys the search widget. You can preview search results in the console.SeeAdd the search widget to a webpage.

    • Integrate search API calls into your server or application. For fullcontrol over how your search results are displayed, you can integrate APIcalls into your server or applications. For more information about makingAPI calls, seeGet search results. For client library resources, seeVertex AI Search clientlibraries.

You can maintain your app to ensure that latest and necessary data is availablein your data store.

Actions

  1. Refresh your structureddata.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.