Von der Custom Search Site Restricted JSON API migrieren

Wenn Sie die Custom Search Site Restricted JSON API der Programmable Search Engine verwenden, können Sie mit Vertex AI Search in wenigen Minuten eine qualitativ hochwertige, auf Websites beschränkte Suche erstellen und bereitstellen. Um Ihre App bereitzustellen, können Sie das Such-Widget verwenden. Dazu kopieren Sie einfach Code aus der Google Cloud Konsole direkt auf eine Webseite. Es ist keine Programmierung 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 kurzen 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, kontextbezogene Suchanfragen mit Follow-up-Fragen und extrahierte Antworten, bei denen mit jedem Suchergebnis extrahierter Text zurückgegeben wird. Wenn Sie diese erweiterten Funktionen für Ihre Websuche nutzen möchten, ist eine Domainbestätigung erforderlich. Außerdem fallen zusätzliche Indexierungskosten an.

Sie können Ihre Suchergebnisse auch filtern oder sortieren und Steuerelemente zum Bewerben anwenden, um einen Link als beworbenes Ergebnis anzuzeigen.

Weitere Informationen finden Sie auf der Seite AI Applications – Preise.

Vertex AI Search einrichten

So richten Sie Vertex AI Search ein:

  1. Wählen Sie in der Google Cloud Console auf der Seite für die Projektauswahl das Projekt aus, das Sie für die Custom Search Site Restricted JSON API verwendet haben.

  2. KI-Anwendungen aktivieren

Suchanwendung erstellen

So erstellen Sie eine Such-App:

  1. Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.

    KI-Anwendungen

  2. Klicken Sie auf Anwendung erstellen.

  3. Klicken Sie auf der Seite App erstellen unter Site Search mit KI-Modus auf Erstellen.

  4. Die Features der Enterprise-Version müssen aktiviert sein. Dies ist für die Websitesuche erforderlich. Weitere Informationen finden Sie unter Funktionen der Enterprise-Version.

  5. Deaktivieren Sie Erweiterte LLM-Features. Wenn Sie diese Option deaktivieren, erhalten Sie eine ähnliche Funktionalität wie bei der Custom Search Site Restricted JSON API der Programmable Search Engine. Deaktivieren Sie diese Option, wenn Sie keine Zusammenfassungen oder Suchanfragen mit Follow-ups benötigen. Weitere Informationen finden Sie unter Erweiterte LLM-Funktionen.

  6. Geben Sie im Feld Name der App einen Namen für die App ein.

  7. Geben Sie im Feld Externer Name Ihres Unternehmens oder Ihrer Organisation den üblichen Namen Ihres Unternehmens oder Ihrer Organisation ein.

  8. Wählen Sie als Standort für Ihre App Global aus und klicken Sie dann auf Weiter.

  9. Klicken Sie auf der Seite Datenspeicher auf Neuen Datenspeicher erstellen.

  10. Wählen Sie im Bereich Datenquelle auswählen die Option Websiteinhalte aus.

  11. Deaktivieren Sie die Indexierung für die erweiterte Websiteindexierung. Wenn Sie diese Option deaktivieren, erhalten Sie Funktionen, die der Custom Search Site Restricted JSON API der Programmable Search Engine ähneln. Deaktivieren Sie diese Option, wenn Sie keine Zusammenfassung der Suche oder keine Suche mit Follow-ups benötigen oder wenn Sie nicht der Inhaber der angegebenen Domains sind. Weitere Informationen finden Sie unter Erweiterte Websiteindexierung.

  12. Geben Sie im Bereich URL-Muster für die Indexierung angeben im Feld Einzuschließende Websites die URL-Muster der Websites ein, die Sie durchsuchen möchten, und klicken Sie dann auf Weiter.

  13. Geben Sie im Bereich Datenspeicher konfigurieren einen Anzeigenamen für den Datenspeicher ein und klicken Sie dann auf Erstellen.

  14. 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:

  1. Informationen zum Einrichten von OAuth 2.0 finden Sie unter In Google Cloud im Dokument Bei KI-Anwendungen authentifizieren. Fügen Sie dem Dienstkonto die Rolle Discovery Engine-Nutzer oder Discovery Engine-Betrachter hinzu.

  2. Sie haben für die Bereitstellung Ihrer Such-App folgende Möglichkeiten:

Suchanwendung bereitstellen (API-Schlüssel)

So stellen Sie Ihre Such-App mit einem API-Schlüssel zur Authentifizierung bereit:

  1. API-Schlüssel erstellen:

    1. Rufen Sie in der Google Cloud Console die Seite Anmeldedaten auf.

      Anmeldedaten

    2. Wenn Sie sich noch nicht in Ihrem Projekt befinden, wählen Sie es in der Projektliste oben auf der Google Cloud -Console-Seite aus.

    3. Klicken Sie auf Anmeldedaten erstellen und wählen Sie anschließend API-Schlüssel aus. Fügen Sie keine Verweiseinschränkungen hinzu. Bei einigen Datenschutzeinstellungen für Nutzer wird die Referrer-URL nicht übergeben.

      • Notieren Sie sich den generierten API-Schlüssel, da Sie ihn beim Aufrufen der searchLite-Methode verwenden.
    4. Für mehr Sicherheit fügen Sie Ihrem API-Schlüssel eine HTTP-Einschränkung hinzu, um den Zugriff auf den AI Applications-Dienst unter https://discoveryengine.googleapis.com/* einzuschränken.

  2. Suchanwendung mit der API bereitstellen Weitere Informationen finden Sie unter Suchergebnisse für eine App mit Websitedaten abrufen (API-Schlüssel) und in der REST-Referenz unter der Methode servingConfigs.searchLite. Informationen zum Sortieren der Ergebnisse Ihrer Websuche finden Sie unter Websuchergebnisse sortieren.

Authentifizierung

Die Authentifizierung der Custom Search Site Restricted JSON API der Programmable Search Engine erfolgt über einen API-Schlüssel. Für Vertex AI Search ist mit einigen Ausnahmen OAuth 2.0 erforderlich. Wenn Sie weiterhin einen API-Schlüssel zur Authentifizierung verwenden möchten, müssen Sie die Methode searchLite über API-Aufrufe verwenden.

Wenn Sie die Authentifizierung über OAuth 2.0 wählen, 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 searchLite-Methode mit API-Schlüsselauthentifizierung und der search- und answer-Methoden mit OAuth 2.0-Authentifizierung aufgeführt.

Funktion/Methoden Methode searchLite Methode search
Authentifizierung API-Schlüssel oauth 2.0
Such-Widget verfügbar
Zusammenfassungen in der Suche
Öffentliche Websites durchsuchen

Nächste Schritte