Wenn Sie die Custom Search Site Restricted JSON API von Programmable Search Engine verwenden, können Sie mit Vertex AI Search in wenigen Minuten eine eingeschränkte Suche in Google-Qualität erstellen und bereitstellen. Zum Bereitstellen Ihrer App können Sie das Such-Widget verwenden. Kopieren Sie dazu den Code aus der Google Cloud Console direkt in eine Webseite – Programmieren ist nicht erforderlich. Alternativ können Sie eine API-Bereitstellung implementieren, um die Darstellung der Suchfunktion auf Ihrer Website zu steuern.
Weitere Informationen zur Verwendung der API finden Sie auf dem Tab „REST“ unter Suchergebnisse für eine App mit Websitedaten abrufen und in der REST-Referenz unter der Methode servingConfigs.search.
Zusätzlich zu den standardmäßigen Kurz-Snippets, die Vertex AI Search mit den Suchergebnissen zurückgibt, können Sie Ihrer Suche erweiterte Funktionen hinzufügen. Dazu gehören generierte Zusammenfassungen von Suchergebnissen, die Suche mit Weiterführenden Fragen für eine kontextbezogene Suche, die weiterführende Fragen zulässt, und zusammenfassende Antworten für extrahierten Text, der mit jedem Suchergebnis zurückgegeben wird. Für die Nutzung dieser erweiterten Funktionen für Ihre Websuche ist eine Domainbestätigung erforderlich. Außerdem fallen zusätzliche Indexierungskosten an.
Sie können Ihre Suchergebnisse auch filtern oder sortieren und Steuerelemente für Anzeigen anwenden, um einen Link als Anzeigenergebnis anzuzeigen.
Weitere Informationen finden Sie auf der Seite Vertex AI Agent Builder – Preise.
Vertex AI Search einrichten
So richten Sie die Vertex AI Search ein:
Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl das Projekt aus, das Sie für die JSON API für eingeschränkte Websites der benutzerdefinierten Suche verwendet haben.
Such-App erstellen
So erstellen Sie eine Such-App:
Rufen Sie in der Google Cloud Console die Seite Agent Builder auf.
Klicken Sie auf Anwendung erstellen.
Klicken Sie auf der Seite App erstellen unter Suche für Ihre Website auf Erstellen.
Die Enterprise-Funktionen müssen aktiviert sein. Dies ist für die Websitesuche erforderlich. Weitere Informationen finden Sie unter Funktionen der Enterprise-Version.
Deaktivieren Sie Erweiterte LLM-Features. Wenn Sie diese Option deaktivieren, erhalten Sie eine Funktionalität, die der Custom Search Site Restricted JSON API der Programmable Search Engine ähnelt. Deaktivieren Sie diese Option, wenn Sie keine Suchzusammenfassung oder Suchanfragen mit Nachfragen benötigen. Weitere Informationen finden Sie unter Erweiterte LLM-Funktionen.
Geben Sie im Feld Anwendungsname einen Namen für die Anwendung ein.
Geben Sie im Feld Externer Name Ihres Unternehmens oder Ihrer Organisation den gängigen Namen Ihres Unternehmens oder Ihrer Organisation ein.
Wählen Sie als Standort für Ihre Anwendung Global aus und klicken Sie dann auf Weiter.
Klicken Sie auf der Seite Datenspeicher auf Neuen Datenspeicher erstellen.
Wählen Sie im Bereich Datenquelle auswählen die Option Websitecontent aus.
Deaktivieren Sie die Erweiterte Websiteindexierung. Wenn Sie diese Option deaktivieren, stehen Ihnen Funktionen zur Verfügung, die denen der Custom Search Site Restricted JSON API von Programmable Search Engine ähneln. Deaktivieren Sie diese Option, wenn Sie keine Zusammenfassung der Suche oder Suche mit Nachfragen benötigen oder nicht der Inhaber der angegebenen Domains sind. Weitere Informationen finden Sie unter Erweiterte Websiteindexierung.
Geben Sie im Bereich URL-Muster für die Indexierung an im Feld Einzuschließende Websites die URL-Muster der Websites ein, nach denen Sie suchen möchten, und klicken Sie dann auf Weiter.
Geben Sie im Bereich Datenspeicher konfigurieren einen Anzeigenamen für den Datenspeicher ein und klicken Sie dann auf Erstellen.
Wählen Sie auf der Seite Datenspeicher den neuen Datenspeicher aus und klicken Sie dann auf Erstellen.
Suchanwendung bereitstellen
Entscheiden Sie, wie Sie Ihre Vertex AI Search-Suchanwendung authentifizieren möchten: mit OAuth 2.0 oder einem API-Schlüssel. Informationen zu den Vor- und Nachteilen der einzelnen Methoden finden Sie unter Authentifizierung.
Suchanwendung bereitstellen (OAuth 2.0)
So stellen Sie Ihre Such-App mit OAuth 2.0-Authentifizierung bereit:
Informationen zum Einrichten von OAuth 2.0 finden Sie unter Bei Vertex AI Agent Builder authentifizieren im Abschnitt In Google Cloud. Achten Sie darauf, dem Dienstkonto die Rolle Discovery Engine-Nutzer oder Discovery Engine-Betrachter hinzuzufügen.
Sie haben folgende Möglichkeiten, Ihre Such-App bereitzustellen:
Verwenden Sie das Such-Widget. Ihre Such-App ganz ohne Programmieren bereitstellen Weitere Informationen finden Sie unter Such-Widget auf einer Webseite einfügen.
Verwenden Sie die API. Mit der API können Sie festlegen, wie die Suchfunktion auf Ihrer Website angezeigt wird. Weitere Informationen finden Sie auf dem REST-Tab unter Suchergebnisse für eine App mit Websitedaten abrufen und in der REST-Referenz unter der Methode
servingConfigs.search. Wie Sie die Ergebnisse Ihrer Websuchanfragen sortieren, erfahren Sie unter Websuchergebnisse sortieren.
Suchanwendung bereitstellen (API-Schlüssel)
So stellen Sie Ihre Such-App mit einem API-Schlüssel für die Authentifizierung bereit:
Erstellen Sie den API-Schlüssel:
Wechseln Sie in der Google Cloud Console zur Seite Anmeldedaten.
Falls Sie sich nicht bereits in Ihrem Projekt befinden, wählen Sie es in der Projektliste oben auf der Google Cloud Console-Seite aus.
Klicken Sie auf Anmeldedaten erstellen und wählen Sie anschließend API-Schlüssel aus. Fügen Sie keine Verweiseinschränkungen hinzu. Einige Datenschutzeinstellungen für Nutzer übergeben die Referrer-URL nicht.
- Notieren Sie sich den generierten API-Schlüssel, da Sie ihn beim Aufrufen der
searchLite-Methode verwenden.
- Notieren Sie sich den generierten API-Schlüssel, da Sie ihn beim Aufrufen der
Für mehr Sicherheit fügen Sie Ihrem API-Schlüssel eine HTTP-Einschränkung hinzu, um den Zugriff auf den Vertex AI Agent Builder-Dienst unter
https://discoveryengine.googleapis.com/*einzuschränken.
Stellen Sie Ihre Suchanwendung mithilfe der API bereit. Weitere Informationen finden Sie unter Suchergebnisse für eine App mit Websitedaten abrufen (API-Schlüssel) und in der REST-Referenz unter
servingConfigs.searchLite. Wie Sie die Ergebnisse Ihrer Websuchanfragen sortieren, erfahren Sie unter Websuchergebnisse sortieren.
Authentifizierung
Die Custom Search Site Restricted JSON API der Programmable Search Engine wird mit einem API-Schlüssel authentifiziert. Für Vertex AI Search ist mit wenigen Ausnahmen OAuth 2.0 erforderlich.
Wenn Sie weiterhin einen API-Schlüssel für die Authentifizierung verwenden möchten, müssen Sie die Methode searchLite über API-Aufrufe verwenden.
Wenn Sie sich über OAuth 2.0 authentifizieren, müssen Sie die Methode search und die Methode answer verwenden, um Ihre Website abzufragen. Außerdem können Sie Ihre Such-App über das No-Code-Such-Widget bereitstellen.
In der folgenden Tabelle sind die Unterschiede zwischen der Verwendung der Methode searchLite mit API-Schlüsselauthentifizierung und der Verwendung der Methoden search und answer mit OAuth 2.0-Authentifizierung aufgeführt.
| Funktion/Methoden | Methode searchLite |
Methode search |
|---|---|---|
| Authentifizierung | API-Schlüssel | oauth 2.0 |
| Such-Widget verfügbar | ✘ | ✔ |
| Suchergebnisse ‒ Zusammenfassungen | ✔ | ✔ |
| Öffentliche Websites durchsuchen | ✔ | ✔ |
Nächste Schritte
Wenn Sie die Suchergebnisse filtern möchten, lesen Sie den Hilfeartikel Filterausdrücke für die grundlegende Websitesuche.
Wenn Sie eine Bildersuche bereitstellen müssen, lesen Sie den Hilfeartikel Nach Bildern auf Websites suchen.
Wenn Sie die Suchergebnisse sortieren möchten, z. B. nach Datum, lesen Sie den Hilfeartikel Suchergebnisse für die grundlegende Websitesuche sortieren.
Wenn Sie eine mehrstufige Suche benötigen, lesen Sie den Hilfeartikel Befehle für Anschlussfragen.