本頁說明如何使用搜尋小工具,在網站中加入搜尋功能。
事前準備
在網頁中新增搜尋小工具前,請務必先設定搜尋小工具,首先請參閱「設定搜尋小工具的結果」。請注意,您無法調整網頁中搜尋小工具的樣式。
程序
將搜尋小工具新增至網頁的程序,取決於您選擇的授權類型:
授權權杖:小工具會使用您的程式碼集提供的 JWT 或 OAuth 權杖。您必須擁有自己的伺服器,才能用來產生權杖。授權權杖可用於代表使用者或服務帳戶發出 API 呼叫。產生驗證權杖時,請使用 OAuth 範圍
https://www.googleapis.com/auth/cloud-platform
。使用服務帳戶進行伺服器對伺服器的互動:請參閱授權說明文件中的「針對伺服器對伺服器應用程式使用 OAuth 2.0」。
JavaScript 網頁應用程式:請參閱授權說明文件中的「用戶端網頁應用程式的 OAuth 2.0」。
公開存取權:小工具不會限制誰能取得搜尋查詢的結果。
新增使用授權權杖的小工具
前往 Google Cloud 控制台的「AI Applications」頁面。
按一下要編輯的應用程式名稱。
按一下「整合」。
按一下「小工具」分頁標籤。
選取「JWT or OAuth based」(採用 JWT 或 OAuth) 做為小工具授權類型。
指定小工具頁面的網域名稱:
輸入要顯示小工具的網頁網域名稱。
舉例來說,如要將小工具複製到網頁
example.com/ai.html
和cymbal.example.com/search.html
,請輸入example.com
做為網域。如果只希望小工具在子網域的網頁上運作,請輸入cymbal.example.com
。如要在 localhost 上測試小工具,請輸入
localhost
。按一下「新增」。
針對顯示小工具的每個網域,重複執行步驟 6。
按一下 [儲存]。
複製「Copy the following code to your web application」(將下列程式碼複製到您的網頁應用程式) 專區中提供的程式碼片段。
選用:進行下列變更,自訂搜尋小工具行為:
如要改為在新分頁中開啟網頁搜尋結果,請在複製的程式碼片段中加入下列內容。根據預設,非結構化文件中的結果會在新分頁中開啟,而網頁中的結果則會在小工具所在的同一頁面中開啟。
anchorsTarget="_blank"
例如:
<gen-search-widget configId="..." anchorsTarget="_blank"></gen-search-widget>
如要自訂搜尋列中的預留位置文字,請在複製的程式碼片段中加入下列內容:
placeholder="CUSTOM_PLACEHOLDER"
例如:
<gen-search-widget configId="..." placeholder="Start your search here"></gen-search-widget>
如要一律顯示小工具而不觸發,請在複製的程式碼片段中新增下列內容:
alwaysOpened
例如:
<gen-search-widget alwaysOpened></gen-search-widget>
在程式碼集內產生授權權杖。
如要將授權權杖傳送給小工具,請使用「Copy the following code to your web application」(將下列程式碼複製到您的網頁應用程式) 專區中提供的第二個程式碼片段「
// Set authorization token
」,並使用授權權杖取代文字<JWT or OAuth token provided by you backend>
。在目前的權杖過期前,定期重複上一個步驟來設定新權杖。
新增具有公開存取權的小工具
前往 Google Cloud 控制台的「AI Applications」頁面。
按一下要編輯的應用程式名稱。
按一下「整合」。
按一下「小工具」分頁標籤。
選取「Public Access」(公開存取權) 做為小工具授權類型。
指定小工具頁面的網域名稱:
輸入要顯示小工具的網頁網域名稱。
舉例來說,如要將小工具複製到網頁
example.com/ai.html
和cymbal.example.com/search.html
,請輸入example.com
做為網域。如果只希望小工具在子網域的網頁上運作,請輸入cymbal.example.com
。如要在 localhost 上測試小工具,請輸入
localhost
。按一下「新增」。
針對顯示小工具的每個網域,重複執行步驟 6。
按一下 [儲存]。
複製「Copy the following code to your web application」(將下列程式碼複製到您的網頁應用程式) 專區中提供的程式碼片段。
選用:進行下列變更,自訂搜尋小工具行為:
如要改為在新分頁中開啟網頁搜尋結果,請在複製的程式碼片段中加入下列內容。根據預設,非結構化文件中的結果會在新分頁中開啟,而網頁中的結果則會在小工具所在的同一頁面中開啟。
anchorsTarget="_blank"
例如:
<gen-search-widget configId="..." anchorsTarget="_blank"></gen-search-widget>
如要自訂搜尋列中的預留位置文字,請在複製的程式碼片段中加入下列內容:
placeholder="CUSTOM_PLACEHOLDER"
例如:
<gen-search-widget configId="..." placeholder="Start your search here"></gen-search-widget>
如要一律顯示小工具而不觸發,請在複製的程式碼片段中新增下列內容:
<gen-search-widget alwaysOpened></gen-search-widget>
將程式碼片段貼到網頁中。
嵌入式公開存取小工具範例
如要查看嵌入公開網頁的搜尋小工具,請參閱「試用 Vertex AI Search」頁面。

這個搜尋小工具適用於下列設定:
<gen-search-widget
configId="123456"
anchorsTarget="_blank"
placeholder="Search something about AI Applications"
alwaysOpened>
</gen-search-widget>