Eseguire la migrazione dall'API Custom Search Site Restricted JSON
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Se utilizzi l'API Custom Search Site Restricted JSON del Programmable Search Engine, puoi creare e
implementare una ricerca di qualità Google limitata al sito in pochi minuti, utilizzando
Vertex AI Search. Per eseguire il deployment dell'app, puoi utilizzare il widget di ricerca copiando il codice dalla console Google Cloud direttamente in una pagina web, senza dover scrivere codice. In alternativa, puoi implementare un deployment dell'API per controllare l'aspetto della funzionalità di ricerca sul tuo sito web.
Per saperne di più sull'utilizzo dell'API, consulta la scheda REST di Recuperare i risultati di ricerca per un'app con dati del sito web e il metodo servingConfigs.search nel riferimento REST.
Oltre ai brevi snippet standard che
Vertex AI Search restituisce con i risultati di ricerca, puoi aggiungere
funzionalità avanzate alla tua ricerca. Questi includono riepiloghi generati dei risultati di ricerca, ricerca con domande aggiuntive per una ricerca sensibile al contesto che consente di porre domande aggiuntive e risposte estrattive per il testo estratto restituito con ogni risultato di ricerca. Per ottenere queste funzionalità avanzate per la ricerca web è necessaria la verifica del dominio e si incorrono in costi di indicizzazione aggiuntivi.
Nella console Google Cloud , nella pagina di selezione del progetto, seleziona il progetto che hai utilizzato per l'API Custom Search Site Restricted JSON.
Nella pagina Crea app, fai clic su Crea in Ricerca su sito con modalità AI.
Assicurati che le funzionalità della versione Enterprise siano attive. Questo campo è obbligatorio
per la ricerca sul sito web. Per saperne di più, vedi Funzionalità della versione
Enterprise.
Disattiva Funzionalità LLM avanzate. La disattivazione di questa opzione offre
funzionalità simili all'API Custom Search Site Restricted JSON del
Programmable Search Engine. Disattiva questa opzione se non hai bisogno del riepilogo della ricerca o della ricerca con follow-up. Per saperne di più, consulta la sezione
Funzionalità LLM avanzate.
Nel campo Nome app, inserisci un nome per l'app.
Nel campo Nome esterno della tua azienda o organizzazione, inserisci
il nome comune della tua azienda o organizzazione.
Seleziona globale (Globale) come località per la tua app, poi fai clic su
Continua.
Nella pagina Datastore, fai clic su Crea datastore.
Nel riquadro Seleziona un'origine dati, scegli Contenuti dei siti web.
Disattiva l'indicizzazione Indicizzazione avanzata dei siti web. Se disattivi questa opzione, avrai una funzionalità simile all'API Custom Search Site Restricted JSON
del Programmable Search Engine. Disattiva questa opzione se non hai bisogno del riepilogo della ricerca o della ricerca con follow-up oppure se non possiedi i domini specificati. Per saperne di più, consulta la sezione
Indicizzazione avanzata dei siti web.
Nel riquadro Specifica i pattern URL da indicizzare, nel campo Siti da includere, inserisci i pattern URL dei siti web in cui vuoi eseguire la ricerca e fai clic su Continua.
Nel riquadro Configura il datastore, inserisci un nome visualizzato per il datastore, quindi fai clic su Crea.
Nella pagina Datastore, seleziona il nuovo datastore e fai clic su
Crea.
Esegui il deployment dell'app di ricerca
Decidi come autenticare l'app di ricerca Vertex AI Search: utilizzando OAuth 2.0 o una chiave API. Per informazioni sui vantaggi e
svantaggi di ciascun metodo, vedi Informazioni
sull'autenticazione.
Se non hai ancora selezionato il progetto, selezionalo nell'elenco dei progetti nella parte superiore della pagina della console Google Cloud .
Fai clic su Crea credenziali e poi seleziona Chiave API.
Non aggiungere limitazioni dei referrer. Alcune impostazioni della privacy dell'utente non
trasmettono l'URL referrer.
Prendi nota della chiave API generata, che utilizzerai quando chiamerai
il metodo searchLite.
Per una maggiore sicurezza, aggiungi una
limitazione HTTP
alla tua chiave API per limitare l'accesso al servizio AI Applications
all'indirizzo https://discoveryengine.googleapis.com/*.
L'API Custom Search Site Restricted JSON del
Programmable Search Engine esegue l'autenticazione utilizzando una chiave API. Mentre, con un paio di eccezioni, Vertex AI Search richiede OAuth 2.0.
Se vuoi continuare a utilizzare una chiave API per l'autenticazione, devi utilizzare il metodo searchLite tramite chiamate API.
Se scegli di autenticarti tramite OAuth 2.0, devi utilizzare il metodo
search e il metodo answer per eseguire query
sul tuo sito web. Inoltre, puoi eseguire il deployment della tua app di ricerca tramite il widget di ricerca
no-code.
La seguente tabella elenca le differenze tra l'utilizzo del metodo searchLite con l'autenticazione con chiave API e i metodi search e answer con l'autenticazione OAuth 2.0.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Difficile da capire","hardToUnderstand","thumb-down"],["Informazioni o codice di esempio errati","incorrectInformationOrSampleCode","thumb-down"],["Mancano le informazioni o gli esempi di cui ho bisogno","missingTheInformationSamplesINeed","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 2025-09-05 UTC."],[[["\u003cp\u003eVertex AI Search enables the creation of site-restricted search functionality, similar to the Custom Search Site Restricted JSON API, with options for both widget-based and API-driven deployment.\u003c/p\u003e\n"],["\u003cp\u003eAdvanced features such as generated summaries, follow-up questions, and extractive answers are available, although they require domain verification and incur additional indexing costs.\u003c/p\u003e\n"],["\u003cp\u003eYou can refine search results through filtering, ordering, and promoting specific links, providing greater control over how information is presented to users.\u003c/p\u003e\n"],["\u003cp\u003eDeploying Vertex AI Search can be done using either OAuth 2.0 or an API key, with OAuth 2.0 supporting the search widget, while API key authentication requires the use of the \u003ccode\u003esearchLite\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eSetting up a website search app involves a series of steps in the Agent Builder console, including selecting website content as the data source and specifying the URL patterns to index.\u003c/p\u003e\n"]]],[],null,["# Migrate from Custom Search Site Restricted JSON API\n\nIf you use the [Custom Search Site Restricted JSON API](https://developers.google.com/custom-search/v1/site_restricted_api) of Programmable Search Engine, you can create and\ndeploy Google-quality, site-restricted search in minutes, using\nVertex AI Search. To deploy your app, you can use the [search\nwidget](/generative-ai-app-builder/docs/add-widget) by copying code from the Google Cloud console directly into a\nweb page---no coding required. Or, you can implement an API\ndeployment to have control over how search functionality looks on your website.\nFor more information about using the API, see the REST tab of [Get search\nresults for an app with website data](/generative-ai-app-builder/docs/preview-search-results#web) and the\n[`servingConfigs.search`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines.servingConfigs/search) method in the REST reference.\n\nIn addition to the standard short snippets that\nVertex AI Search returns with search results, you can add\nadvanced features to your search. These include generated\n[summaries](/generative-ai-app-builder/docs/get-search-summaries) of search results, [search with follow-ups](/generative-ai-app-builder/docs/answer#commands_for_follow-up_questions) for context-aware search that allows follow-up questions,\nand [extractive answers](/generative-ai-app-builder/docs/snippets#extractive-answers) for extracted text returned with\neach search result. Getting these advanced features for your web search requires\n[domain verification](/generative-ai-app-builder/docs/domain-verification) and incurs additional indexing costs.\n\nYou can also [filter](/generative-ai-app-builder/docs/filter-website-search#filter-expressions-basic-indexing) or [order](/generative-ai-app-builder/docs/order-web-search-results#basic-indexing) your\nsearch results and apply [promote controls](/generative-ai-app-builder/docs/configure-serving-controls#promote) to display a link as a promoted result.\n\nFor more information, see the [AI Applications pricing](/generative-ai-app-builder/pricing) page.\n\nSet up Vertex AI Search\n-----------------------\n\nTo set up Vertex AI Search, follow these steps:\n\n1. In the Google Cloud console, on the [project selector\n page](https://console.cloud.google.com/projectselector2/home/dashboard), select the project that you've been\n using for the Custom Search Site Restricted JSON API.\n\n2. [Turn on AI Applications](/generative-ai-app-builder/docs/before-you-begin#turn-on-discovery-engine).\n\nCreate a search app\n-------------------\n\nTo create a search app, follow these steps:\n\n1. In the Google Cloud console, go to the **AI Applications** page.\n\n [AI Applications](https://console.cloud.google.com/gen-app-builder/engines)\n2. Click **Create app**.\n\n3. On the **Create App** page, under **Site search with AI mode** , click\n **Create**.\n\n4. Make sure **Enterprise edition features** is turned on. This is required\n for website search. For more information, see [Enterprise edition\n features](/generative-ai-app-builder/docs/about-advanced-features#enterprise-features).\n\n5. Turn off **Advanced LLM features** . Turning this off gives you\n functionality similar to the Custom Search Site Restricted JSON API of\n Programmable Search Engine. Turn this off if you don't need search\n summarization or search with follow-ups. For more information, see\n [Advanced LLM features](/generative-ai-app-builder/docs/about-advanced-features#advanced-llm-features).\n\n6. In the **Your app name** field, enter a name for your app.\n\n7. In the **External name of your company or organization** field, enter\n the common name for your company or organization.\n\n8. Select **global (Global)** as the location for your app, and then click\n **Continue**.\n\n9. On the **Data Stores** page, click **Create data store**.\n\n10. In the **Select a data source** pane, select **Website Content**.\n\n11. Turn off **Advanced website indexing** indexing. Turning this off gives\n you functionality similar to the Custom Search Site Restricted JSON API\n of Programmable Search Engine. Turn this off if you don't need search\n summarization or search with follow-ups, or if you don't own the\n domains that you specify. For more information, see\n [Advanced website indexing](/generative-ai-app-builder/docs/about-advanced-features#advanced-website-indexing).\n\n12. In the **Specify URL patterns to index** pane, in the **Sites\n to include** field, enter the URL patterns of the websites that you want\n to search, and then click **Continue**.\n\n13. In the **Configure your data store** pane, enter a display name for your\n data store, and then click **Create**.\n\n14. On the **Data Stores** page, select your new data store, and then click\n **Create**.\n\nDeploy the search app\n---------------------\n\nDecide how you plan to authenticate your Vertex AI Search search\napp: using OAuth 2.0 or an API key. For information about the advantages and\ndisadvantages of each method, see [About\nauthentication](#about-authentication).\n\n- [To deploy the search app with OAuth 2.0](#oauth-deploy)\n\n- [To deploy the search app with an API key](#api-key-deploy)\n\n### Deploy the search app (OAuth 2.0)\n\nTo deploy your search app using OAuth 2.0 authentication, follow these steps:\n\n1. To set up OAuth 2.0, see [On Google Cloud](/generative-ai-app-builder/docs/authentication#on-gcp) in *Authenticate to\n AI Applications* . Make sure to add the [Discovery Engine\n User](/generative-ai-app-builder/docs/access-control#discoveryengine.user) or the [Discovery Engine\n Viewer](/generative-ai-app-builder/docs/access-control#discoveryengine.viewer) role to the service account.\n\n2. Deploy your search app in one of the following ways:\n\n - **Use the search widget.** Deploy your search\n app with no coding required. For more information, see\n [Add the search widget to a web page](/generative-ai-app-builder/docs/add-widget).\n\n - **Use the API.** Use the API to control how search functionality looks on\n your website. For more information, see the REST tab of [Get search\n results for an app with website data](/generative-ai-app-builder/docs/preview-search-results#web) and the\n [`servingConfigs.search`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines.servingConfigs/search) method in the REST reference. To\n order the results of your web search queries, see [Order web search\n results](/generative-ai-app-builder/docs/order-web-search-results).\n\n### Deploy the search app (API key)\n\nTo deploy your search app using an API key for authentication, follow these\nsteps:\n\n1. Create the API key:\n\n 1. In the Google Cloud console, go to the **Credentials** page.\n\n [Credentials](https://console.cloud.google.com/apis/credentials)\n 2. If you're not already in your project, in the project list at the top of\n the Google Cloud console page, select your project.\n\n 3. Click **Create credentials** and then select **API key** .\n *Don't add any referrer restrictions*. Some user privacy settings don't\n pass the referrer URL.\n\n - Take note of the generated API key, which you will use when calling the `searchLite` method.\n 4. For increased security, add an\n [HTTP restriction](/docs/authentication/api-keys#api_key_restrictions)\n to your API Key to restrict access to the AI Applications service\n at `https://discoveryengine.googleapis.com/*`.\n\n2. Deploy your search app using the API.\n See [Get search results for an app with website data (API\n key)](/generative-ai-app-builder/docs/preview-search-results#web-api-key) and the\n [`servingConfigs.searchLite`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines.servingConfigs/searchLite) method in the\n REST reference. To order the results of your web search queries, see [Order\n web search results](/generative-ai-app-builder/docs/order-web-search-results).\n\nAbout authentication\n--------------------\n\nThe [Custom Search Site Restricted JSON API](https://developers.google.com/custom-search/v1/site_restricted_api) of\nProgrammable Search Engine authenticates using an API key. While, with a\ncouple of exceptions, Vertex AI Search requires OAuth 2.0.\nIf you want to carry on using an API key for authentication, then you need to\nuse the [`searchLite`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.collections.engines.servingConfigs/searchLite) method through API calls.\n\nIf you choose to authenticate through OAuth 2.0, then you need to use the\n[`search`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.dataStores.servingConfigs/search) method and the [`answer`](/generative-ai-app-builder/docs/reference/rest/v1/projects.locations.dataStores.servingConfigs/answer) method to query\nyour website, furthermore, you can deploy your search app through the no-code\nsearch widget.\n\nThe following table lists differences between using the `searchLite` method with\nAPI key authentication and the `search` and `answer` methods with OAuth 2.0\nauthentication.\n\nNext steps\n----------\n\n- If you need to filter the search results, see [Filter expressions\n for basic website search](/generative-ai-app-builder/docs/filter-website-search#filter-expressions-basic-indexing).\n\n- If you need to provide image search, see [Search for images on\n websites](/generative-ai-app-builder/docs/image-search).\n\n- If you need to order the search results, for example by date, see [Order\n search results for basic website search](/generative-ai-app-builder/docs/order-web-search-results#basic-indexing).\n\n- If you need multi-turn search, see [Commands for follow-up\n questions](/generative-ai-app-builder/docs/answer#commands_for_follow-up_questions)."]]
