Auf dieser Seite wird die grundlegende Autocomplete-Funktion von Vertex AI Search beschrieben. Bei der automatischen Vervollständigung werden Vorschläge für Suchanfragen auf Grundlage der ersten Zeichen generiert, die für die Suchanfrage eingegeben wurden.
Die Vorschläge, die durch die automatische Vervollständigung generiert werden, hängen vom Datentyp ab, der von der Such-App verwendet wird:
Strukturierte und unstrukturierte Daten: Standardmäßig werden bei der automatischen Vervollständigung Vorschläge basierend auf den Inhalten von Dokumenten im Datenspeicher generiert. Nach dem Import von Dokumenten werden standardmäßig erst dann Vorschläge für die automatische Vervollständigung generiert, wenn genügend hochwertige Daten vorhanden sind. Das dauert in der Regel einige Tage. Wenn Sie Vervollständigungsanfragen über die API stellen, können Vorschläge generiert werden, die auf dem Suchverlauf oder Nutzerereignissen basieren.
Websitedaten: Standardmäßig werden Vorschläge für die automatische Vervollständigung aus dem Suchverlauf generiert. Für die automatische Vervollständigung ist echter Suchtraffic erforderlich. Nachdem Suchanfragen eingehen, kann es ein bis zwei Tage dauern, bis die automatische Vervollständigung Vorschläge generiert. Vorschläge können aus Web-Crawling-Daten von öffentlichen Websites mit dem experimentellen erweiterten Dokumentdatenmodell generiert werden.
Gesundheitsdaten: Standardmäßig wird eine kanonische medizinische Datenquelle verwendet, um Vorschläge für die automatische Vervollständigung für Datenspeicher für Gesundheitsdaten zu generieren.
Das Modell für Suchvorschläge bestimmt, welche Art von Daten für die automatische Vervollständigung verwendet werden, um Vorschläge zu generieren. Es gibt vier Modelle für Abfragevorschläge:
Document. Das Dokumentmodell generiert Vorschläge aus von Nutzern importierten Dokumenten. Dieses Modell ist nicht für Websitedaten oder Daten aus dem Gesundheitswesen verfügbar.
Vervollständigbare Felder: Das Modell für vervollständigbare Felder schlägt Text vor, der direkt aus strukturierten Datenfeldern stammt. Nur Felder, die mit
completable
gekennzeichnet sind, werden für Vorschläge zur automatischen Vervollständigung verwendet. Dieses Modell ist nur für strukturierte Daten verfügbar.Suchverlauf: Das Modell für den Suchverlauf generiert Vorschläge aus dem Verlauf der
SearchService.search
-API-Aufrufe. Verwenden Sie dieses Modell nicht, wenn keine Zugriffsdaten für die MethodeservingConfigs.search
verfügbar sind. Dieses Modell ist nicht für Gesundheitsdaten verfügbar.Nutzerereignis: Das Modell für Nutzerereignisse generiert Vorschläge aus vom Nutzer importierten Ereignissen vom Typ
search
. Dieses Modell ist nicht für Gesundheitsdaten verfügbar.
Autocomplete-Anfragen werden mit der Methode dataStores.completeQuery
gesendet.
Wenn Sie kein Modell für Suchvorschläge verwenden möchten, können Sie stattdessen importierte Vorschläge nutzen. Dabei werden Vorschläge zur automatischen Vervollständigung auf Grundlage einer importierten Liste von Vorschlägen generiert. Weitere Informationen finden Sie unter Importierte Liste mit Vorschlägen für die automatische Vervollständigung verwenden.
Verfügbare Modelltypen nach Datentyp
In der folgenden Tabelle sind die Modelltypen für Vorschläge für Suchanfragen aufgeführt, die für die einzelnen Datentypen verfügbar sind.
Modell für Vorschläge für Suchanfragen |
Datenquelle |
Website-Daten |
Strukturierte Daten |
Unstrukturierte Daten |
---|---|---|---|---|
Dokument | Importiert | ✔* (Standard) | ✔ (Standard) | |
Vervollständigbare Felder | Importiert | ✔ | ||
Suchverlauf | Automatisch erfasst | ✔ (Standard) | ✔ | ✔ |
Nutzerereignisse | Importiert oder automatisch vom Widget erfasst | ✔ | ✔ | ✔ |
Web-Crawling-Inhalte | Gecrawlt aus Inhalten von öffentlichen Websites, die Sie angeben | ✔† |
* : Das Dokumentschema muss die Felder title
oder description
enthalten oder es müssen Felder vorhanden sein, die als title
- oder description
-Schlüsselattribute angegeben wurden. Weitere Informationen finden Sie unter Schema für strukturierte Daten aktualisieren.
† : Über das Web gecrawlte Inhalte können nur als Datenquelle verwendet werden, wenn das experimentelle erweiterte Dokumentdatenmodell für die automatische Vervollständigung aktiviert ist. Weitere Informationen finden Sie unter Erweitertes Dokumentdatenmodell.
Wenn Sie nicht das Standardmodell für Ihren Datentyp verwenden möchten, können Sie ein anderes Modell angeben, wenn Sie Ihre Anfrage zur automatischen Vervollständigung senden. Vervollständigungsanfragen werden mit der Methode dataStores.completeQuery
gesendet. Weitere Informationen finden Sie unter API-Anleitung: Autocomplete-Anfrage senden, um ein anderes Modell auszuwählen.
Funktionen für die automatische Vervollständigung
Vertex AI Search unterstützt die folgenden Funktionen für die automatische Vervollständigung, um bei der Suche die hilfreichsten Vorhersagen zu präsentieren:
Funktion | Beschreibung | Beispiel oder weitere Informationen |
---|---|---|
Tippfehler korrigieren | Korrigieren Sie Tippfehler in Wörtern. | Milc → Milk
|
Nicht sichere Begriffe entfernen |
|
Anstößige Texte, z. B. pornografische, anzügliche, vulgäre oder gewaltverherrlichende Inhalte |
Anzeige grundlegender personenidentifizierbarer Informationen verhindern | Vertex AI Search basiert auf Sensitive Data Protection und unternimmt angemessene Anstrengungen, um die Anzeige grundlegender Arten von personenidentifizierbaren Informationen wie Telefonnummern und E-Mail-Adressen zu verhindern. |
Wenn im Datenspeicher eine E-Mail-Adresse Um sich noch besser vor dem Verlust personenbezogener Daten zu schützen, empfiehlt Google, dass Sie zusätzlich zu den von Vertex AI Search bereitgestellten Detektoren Ihre eigene Data Loss Prevention-Lösung (DLP) einsetzen. Weitere Informationen finden Sie unter Schutz vor PII-Leaks. |
Sperrliste |
|
Weitere Informationen finden Sie unter Sperrliste für automatische Vervollständigung verwenden. |
Begriffe deduplizieren |
|
Shoes for Women , Womens Shoes und Womans Shoes werden dedupliziert und nur der beliebteste Vorschlag wird angezeigt. |
Vorschläge für genau passende Keywords |
|
Weitere Informationen finden Sie unter Vorschläge für den Tail-Abgleich. |
Vorschläge für genau passende Keywords
Vorschläge für das Ende einer Suchanfrage werden durch exakten Präfixabgleich mit dem letzten Wort in einem Suchanfragestring erstellt.
Angenommen, die Anfrage „songs with he“ wird in einer Anfrage zur automatischen Vervollständigung gesendet. Wenn die Endübereinstimmung aktiviert ist, kann es sein, dass die automatische Vervollständigung feststellt, dass das vollständige Präfix „songs with he“ keine Übereinstimmungen hat. Das letzte Wort in der Anfrage, „he“, hat jedoch eine genaue Präfixübereinstimmung mit „hello world“ und „hello kitty“. In diesem Fall sind die zurückgegebenen Vorschläge „Songs mit Hello World“ und „Songs mit Hello Kitty“, da es keine Vorschläge für eine genaue Übereinstimmung gibt.
Mit dieser Funktion können Sie leere Vorschlagsergebnisse reduzieren und die Vielfalt der Vorschläge erhöhen. Das ist besonders nützlich, wenn die Datenquellen (Anzahl der Nutzerereignisse, Suchverlauf und Abdeckung von Dokumentthemen) begrenzt sind. Wenn Sie jedoch Vorschläge für den Tail-Abgleich aktivieren, kann dies die Gesamtqualität der Vorschläge beeinträchtigen. Da bei der Endübereinstimmung nur das letzte Wort des Präfixes berücksichtigt wird, sind einige der zurückgegebenen Vorschläge möglicherweise nicht sinnvoll. Bei einer Anfrage wie „Lieder mit er“ wird möglicherweise der Vorschlag „Lieder mit Helfern“ angezeigt.
Vorschläge für die Endübereinstimmung werden nur zurückgegeben, wenn:
include_tail_suggestions
ist in derdataStores.completeQuery
-Anfrage auftrue
festgelegt.Für die Abfrage gibt es keine Vorschläge für vollständige Präfixübereinstimmungen.
Schutz vor PII-Leaks
Die Definition von PII ist weit gefasst und PII können schwer zu erkennen sein. Daher kann Vertex AI Search nicht garantieren, dass keine personenbezogenen Daten in Vorschlägen zur automatischen Vervollständigung zurückgegeben werden.
Vertex AI Search verwendet den Schutz sensibler Daten, um nach gängigen Arten von personenbezogenen Daten zu suchen und zu verhindern, dass sie als Vorschläge angezeigt werden. Wenn Ihre Datenspeicher jedoch personenbezogene Daten enthalten oder Sie die Modelle für Suchverlauf oder Nutzerereignisse verwenden, sollten Sie die folgenden Informationen lesen und entsprechende Maßnahmen ergreifen:
Wenn die Arten von personenidentifizierbaren Informationen, die Sie schützen möchten, relativ standardmäßig sind, z. B. Telefonnummern und E‑Mail-Adressen, sollten Sie zuerst die Vorschläge zur automatischen Vervollständigung für Ihre App ausführlich testen. Vertex AI Search kann nicht garantieren, dass keine personenidentifizierbaren Informationen in Vorschlägen zur automatischen Vervollständigung zurückgegeben werden.
Wenn während der Tests zur automatischen Vervollständigung Lecks bei personenidentifizierbaren Informationen entdeckt werden oder Sie bereits wissen, dass Sie nicht standardmäßige personenidentifizierbare Informationen schützen müssen (z. B. proprietäre Nutzer-IDs), sollten Sie den Schwellenwert für die automatische Vervollständigung und die Parameter für die Bereitstellung von Inhalten anpassen. Weitere Informationen finden Sie unter Risiko reduzieren, dass Vorschläge mit personenbezogenen Daten zurückgegeben werden.
Wenn das Anpassen der Parameter nicht ausreicht, um das Offenlegen personenbezogener Daten zu verhindern, implementieren Sie Ihre eigene DLP-Lösung. Passen Sie die DLP-Lösung an die Arten von personenbezogenen Daten an, die am wahrscheinlichsten in Ihren Datenspeichern, Nutzerereignissen oder Suchanfragen von Nutzern zu finden sind. Sie können den Schutz sensibler Daten oder einen DLP-Drittanbieterdienst verwenden. Führen Sie eine der folgenden Aktionen aus:
Filtern Sie personenidentifizierbare Informationen heraus, bevor Sie die Dokumente und Nutzerereignisse in Ihre Datenspeicher importieren.
Prüfen Sie die Vorschläge für die automatische Vervollständigung, bevor Sie sie dem Nutzer bei der Bereitstellung präsentieren, und blockieren Sie die Vorschläge, die personenbezogene Daten enthalten.
Wenn Sie das Modell für den Suchverlauf oder Nutzerereignisse verwenden, fügen Sie der Suchleiste einen Informationstext hinzu, in dem Sie Nutzer darauf hinweisen, keine personenbezogenen Daten in ihre Suchanfragen einzugeben.
Wenn Sie Fragen haben oder besondere Probleme beim Blockieren personenbezogener Daten auftreten, wenden Sie sich an Ihren Customer Engineer (CE) oder Ihr Google-Kontoteam.
Autocomplete für ein Widget aktivieren oder deaktivieren
So aktivieren oder deaktivieren Sie die automatische Vervollständigung für ein Widget:
Console
Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.
Klicken Sie auf den Namen der App, die Sie bearbeiten möchten.
Klicken Sie auf Configurations (Konfigurationen).
Klicken Sie auf den Tab Benutzeroberfläche.
Aktivieren oder deaktivieren Sie die Option Automatische Vervollständigungsvorschläge anzeigen, um die automatische Vervollständigung für das Widget zu aktivieren oder zu deaktivieren. Wenn Sie die automatische Vervollständigung aktivieren, kann es ein bis zwei Tage dauern, bis Vorschläge angezeigt werden.
Einstellungen für die automatische Vervollständigung aktualisieren
So konfigurieren Sie die Einstellungen für die automatische Vervollständigung in der Benutzeroberfläche:
Console
Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.
Klicken Sie auf den Namen der App, die Sie bearbeiten möchten.
Klicken Sie auf Configurations (Konfigurationen).
Klicken Sie auf den Tab Automatische Vervollständigung.
Geben Sie neue Werte für die Einstellungen für die automatische Vervollständigung ein, die Sie aktualisieren möchten, oder wählen Sie sie aus:
- Maximale Anzahl von Vorschlägen:Die maximale Anzahl von Vorschlägen für die automatische Vervollständigung, die für eine Abfrage angeboten werden können.
- Mindestlänge zum Auslösen:Die Mindestanzahl an Zeichen, die eingegeben werden können, bevor automatisch vervollständigte Vorschläge angezeigt werden.
- Abgleichreihenfolge: Die Position in einem Abfragestring, ab der die automatische Vervollständigung mit dem Abgleich ihrer Vorschläge beginnen kann.
- Modell für Suchvorschläge: Das Modell für Suchvorschläge, das zum Generieren der abgerufenen Vorschläge verwendet wird. Dies kann in der
dataStores.completeQuery
mit dem ParameterqueryModel
überschrieben werden. Automatische Vervollständigung aktivieren: Standardmäßig werden erst dann Vorschläge für die automatische Vervollständigung angezeigt, wenn genügend hochwertige Daten vorhanden sind. Das dauert in der Regel einige Tage. Wenn Sie diese Standardeinstellung überschreiben und früher Vorschläge für die automatische Vervollständigung erhalten möchten, wählen Sie Jetzt aus.
Auch wenn Sie Jetzt auswählen, kann es einen Tag dauern, bis Vorschläge generiert werden. Bis genügend gute Daten vorhanden sind, fehlen möglicherweise einige Vorschläge für die automatische Vervollständigung oder sie sind von schlechter Qualität.
Sperrliste: Importieren Sie eine Sperrliste als JSON-Datei in einen Cloud Storage-Bucket. Weitere Informationen zu den Einschränkungen und Spezifikationen der Sperrliste finden Sie unter Sperrliste für automatische Vervollständigung verwenden.
Klicken Sie auf Speichern und veröffentlichen. Änderungen werden innerhalb weniger Minuten für Engines wirksam, bei denen die automatische Vervollständigung bereits aktiviert ist.
Risiko von Vorschlägen mit personenbezogenen Daten reduzieren
Endnutzer haben alle Arten von personenidentifizierbaren Informationen, z. B. Führerscheine und Telefonnummern, die sie privat halten sollen. Nutzer, die nach Ergebnissen suchen, die sich auf sie beziehen, geben diese personenbezogenen Daten jedoch möglicherweise in die Suchleiste ein.
Wenn Sie das Modell für Suchverlauf oder Nutzerereignisse verwenden und es wahrscheinlich ist, dass Ihre Nutzer personenidentifizierbare Informationen in die Suchleiste eingeben, können Sie das Risiko von PII-Leaks verringern, indem Sie die folgenden Parameter anpassen:
queryFrequencyThreshold
: Bevor eine Anfrage als Vorschlag für die automatische Vervollständigung zurückgegeben werden kann, muss sie so oft eingegeben worden sein.numUniqueUsersThreshold
: Bevor eine Anfrage als Vorschlag für die automatische Vervollständigung zurückgegeben werden kann, muss sie von so vielen einzelnen Nutzern eingegeben worden sein. Der Wert des FeldsuserPseudoId
im Suchnutzerereignis bestimmt, ob der Nutzer eindeutig ist.
Beispiel für einen Anwendungsfall
Nehmen wir beispielsweise an, Nutzer haben Kontonummern, die privat bleiben sollen.
Wenn das Vorschlagsmodell für Suchverlauf oder Nutzerereignisse verwendet wird, werden diese Kontonummern zusammen mit allen anderen Begriffen, nach denen Endnutzer suchen, verwendet, um Vorschläge zu generieren. Wenn die Kontonummer YZ-46789A
von Nutzer A wiederholt in die Suchleiste eingegeben wurde und Nutzer B die Kontonummer YZ-42345B
hat, kann es sein, dass die automatische Vervollständigung die Kontonummer von Nutzer A vorschlägt, wenn Nutzer B YZ-4
in die Suchleiste eingibt.
Um die Wahrscheinlichkeit dieser Art von Datenlecks zu verringern, entscheidet der Administrator für KI-Anwendungen,
Erhöhen Sie den Wert des Parameters
queryFrequencyThreshold
auf30
. In diesem Fall ist es sehr unwahrscheinlich, dass eine Kontonummer so oft eingegeben wird. Beliebte Suchanfragen werden jedoch mindestens so oft eingegeben.Erhöhen Sie den Wert des Parameters
numUniqueUsersThreshold
auf6
. Der Administrator hält es für unwahrscheinlich, dass dieselbe Kontonummer bei sechs Suchvorgängen, die jeweils mit einer anderenuserPseudoId
verknüpft sind, in die Suchleiste eingegeben wird.
Prozedur
Es gibt zwei Schwellenwertparameter für die automatische Vervollständigung.
Diese Parameter sind nicht in der Google Cloud -Konsole verfügbar, können aber mit einem REST API-Aufruf der Methode updateCompletionConfig
festgelegt werden.
So konfigurieren Sie die Einstellungen für den Autocomplete-Schwellenwert: Die einzelnen Schritte sind optional und hängen vom Parameter ab, den Sie ändern möchten.
REST
Aktualisieren Sie das Feld
CompletionConfig.queryFrequencyThreshold
:curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig?updateMask=queryFrequencyThreshold \ -d '{ "name": "projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig", "queryFrequencyThreshold": QUERY_FREQUENCY_THRESHOLD }'
Ersetzen Sie Folgendes:
PROJECT_ID
: die Nummer oder ID Ihres Google Cloud Projekts.DATA_STORE_ID
: die ID des Datenspeichers, der mit Ihrer App verknüpft ist.QUERY_FREQUENCY_THRESHOLD
: Ein Ganzzahlwert, der angibt, wie oft eine Suchanfrage mindestens eingegeben werden muss, bevor sie als Vorschlag für die automatische Vervollständigung zurückgegeben werden kann. Die Anzahl wird über ein monatelanges, fortlaufendes Zeitfenster summiert. Der Standardwert ist8
.
Aktualisieren Sie das Feld
CompletionConfig.numUniqueUsersThreshold
:curl -X PATCH \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json" \ -H "X-Goog-User-Project: PROJECT_ID" \ https://discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig?updateMask=numUniqueUsersThreshold \ -d '{ "name": "projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID/completionConfig", "numUniqueUsersThreshold": UNIQUE_USERS }'
Ersetzen Sie
UNIQUE_USERS
durch einen ganzzahligen Wert, der die Mindestanzahl eindeutiger Nutzer angibt, die eine bestimmte Suchanfrage eingeben müssen, bevor sie als Vorschlag für die automatische Vervollständigung zurückgegeben werden kann. Die Anzahl wird über ein monatelanges, fortlaufendes Zeitfenster summiert. Der Standardwert ist3
.
Anmerkungen für vervollständigbare Felder im Schema aktualisieren
So aktivieren Sie die automatische Vervollständigung für Felder im Schema für strukturierte Daten:
Console
Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf.
Klicken Sie auf den Namen der App, die Sie bearbeiten möchten. Es müssen strukturierte Daten verwendet werden.
Klicken Sie auf Daten.
Klicken Sie auf den Tab Schema.
Klicken Sie auf Bearbeiten, um die Schemafelder auszuwählen, die als
completable
markiert werden sollen.Klicken Sie auf Speichern, um die aktualisierten Feldkonfigurationen zu speichern. Es dauert etwa einen Tag, bis diese Vorschläge generiert und zurückgegeben werden.
Autocomplete-Anfragen senden
In den folgenden Beispielen wird gezeigt, wie Sie Vervollständigungsanfragen senden.
REST
So senden Sie eine Vervollständigungsanfrage über die API:
Suchen Sie nach Ihrer Datenspeicher-ID. Wenn Sie die ID Ihres Datenspeichers bereits haben, fahren Sie mit dem nächsten Schritt fort.
Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf und klicken Sie im Navigationsmenü auf Datenspeicher.
Klicken Sie auf den Namen des Datenspeichers.
Rufen Sie auf der Datenseite Ihres Datenspeichers die Datenspeicher-ID ab.
Rufen Sie die Methode
dataStores.completeQuery
auf.curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID:completeQuery?query=QUERY_STRING"
Ersetzen Sie Folgendes:
PROJECT_ID
: die Nummer oder ID Ihres Google Cloud Projekts.DATA_STORE_ID
: die ID des Datenspeichers, der mit Ihrer App verknüpft ist.QUERY_STRING
: Die Typeahead-Eingabe, die zum Abrufen von Vorschlägen verwendet wird.
Anfrage zur automatischen Vervollständigung an ein anderes Modell senden
So senden Sie eine Anfrage zur automatischen Vervollständigung mit einem anderen Modell für Suchvorschläge:
Suchen Sie nach Ihrer Datenspeicher-ID. Wenn Sie die ID Ihres Datenspeichers bereits haben, fahren Sie mit dem nächsten Schritt fort.
Rufen Sie in der Google Cloud Console die Seite KI-Anwendungen auf und klicken Sie im Navigationsmenü auf Datenspeicher.
Klicken Sie auf den Namen des Datenspeichers.
Rufen Sie auf der Datenseite Ihres Datenspeichers die Datenspeicher-ID ab.
Rufen Sie die Methode
dataStores.completeQuery
auf.curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/collections/default_collection/dataStores/DATA_STORE_ID:completeQuery?query=QUERY_STRING&query_model=QUERY_SUGGESTIONS_MODEL"
Ersetzen Sie Folgendes:
PROJECT_ID
: die Nummer oder ID Ihres Google Cloud Projekts.DATA_STORE_ID
: die eindeutige ID des Datenspeichers, der mit Ihrer App verknüpft ist.QUERY_STRING
: Die Typeahead-Eingabe, die zum Abrufen von Vorschlägen verwendet wird.AUTOCOMPLETE_MODEL
: die Daten zur automatischen VervollständigungQUERY_SUGGESTIONS_MODEL
: Das Modell für Vorschläge für Suchanfragen, das für die Anfrage verwendet werden soll:document
,document-completable
,search-history
oderuser-event
. Verwenden Siehealthcare-default
für Gesundheitsdaten.
C#
Weitere Informationen finden Sie in der Referenzdokumentation zur AI Applications C# API.
Richten Sie zur Authentifizierung bei AI Applications Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Go
Weitere Informationen finden Sie in der Referenzdokumentation zur AI Applications Go API.
Richten Sie zur Authentifizierung bei AI Applications Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Weitere Informationen finden Sie in der Referenzdokumentation zur AI Applications Java API.
Richten Sie zur Authentifizierung bei AI Applications Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Node.js
Weitere Informationen finden Sie in der Referenzdokumentation zur AI Applications Node.js API.
Richten Sie zur Authentifizierung bei AI Applications Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Python
Weitere Informationen finden Sie in der Referenzdokumentation zur AI Applications Python API.
Richten Sie zur Authentifizierung bei AI Applications Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Ruby
Weitere Informationen finden Sie in der Referenzdokumentation zur AI Applications Ruby API.
Richten Sie zur Authentifizierung bei AI Applications Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Sperrliste für automatische Vervollständigung verwenden
Mithilfe einer Sperrliste können Sie verhindern, dass bestimmte Begriffe als automatisch vervollständigte Vorschläge angezeigt werden.
Nehmen wir zum Beispiel ein Pharmaunternehmen. Wenn ein Medikament nicht mehr von der FDA zugelassen ist, aber in Dokumenten im Datenspeicher erwähnt wird, möchten sie möglicherweise verhindern, dass dieses Medikament als vorgeschlagene Suchanfrage angezeigt wird. Das Unternehmen könnte den Namen dieses Medikaments auf eine Sperrliste setzen, um zu verhindern, dass es vorgeschlagen wird.
Die folgenden Begrenzungen gelten:
- Eine Sperrliste pro Datenspeicher
- Beim Hochladen einer Sperrliste wird eine eventuell vorhandene Sperrliste für diesen Datenspeicher überschrieben.
- Bis zu 1.000 Begriffe pro Sperrliste
- Bei Begriffen wird die Groß-/Kleinschreibung nicht berücksichtigt.
- Nach dem Importieren einer Sperrliste dauert es ein bis zwei Tage, bis sie wirksam wird.
Jeder Eintrag in Ihrer Sperrliste besteht aus einem blockPhrase
und einem matchOperator
:
blockPhrase
: Geben Sie einen String als Begriff für die Sperrliste ein. Bei Begriffen wird die Groß- und Kleinschreibung nicht berücksichtigt.matchOperator
: Kann die folgenden Werte haben:EXACT_MATCH
: Verhindert, dass eine genaue Übereinstimmung des Begriffs in der Sperrliste als vorgeschlagene Suchanfrage angezeigt wird.CONTAINS
: Verhindert, dass Vorschläge mit dem Begriff aus der Sperrliste angezeigt werden.
Das folgende Beispiel zeigt eine Sperrliste mit vier Einträgen:
{ "entries": [ {"blockPhrase":"Oranges","matchOperator":"CONTAINS"}, {"blockPhrase":"bAd apples","matchOperator":"EXACT_MATCH"}, {"blockPhrase":"Cool as A Cucumber","matchOperator":"EXACT_MATCH"}, {"blockPhrase":"cherry pick","matchOperator":"CONTAINS"} ] }
Prüfen Sie vor dem Importieren einer Sperrliste, ob die erforderlichen Zugriffssteuerungen für den Zugriff auf den Discovery Engine-Editor festgelegt sind.
Sperrlisten können entweder aus lokalen JSON-Daten oder aus Cloud Storage importiert werden. Wenn Sie eine Sperrliste aus einem Datenspeicher entfernen möchten, löschen Sie sie dauerhaft.
Sperrliste aus lokalen JSON-Daten importieren
So importieren Sie eine Sperrliste aus einer lokalen JSON-Datei, die Ihre Sperrliste enthält:
Erstellen Sie Ihre Sperrliste in einer lokalen JSON-Datei im folgenden Format. Achten Sie darauf, dass jeder Eintrag auf der Sperrliste in einer neuen Zeile ohne Zeilenumbrüche steht.
{ "inlineSource": { "entries": [ { "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" }, { "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" } ] } }
Stellen Sie eine POST-Anfrage an die Methode
suggestionDenyListEntries:import
und geben Sie den Namen Ihrer JSON-Datei an.curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ --data @DENYLIST_FILE \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"
Ersetzen Sie Folgendes:
DENYLIST_FILE
: Der lokale Pfad der JSON-Datei mit den Begriffen auf der Sperrliste.PROJECT_ID
: die Nummer oder ID Ihres Google Cloud Projekts.DATA_STORE_ID
: die ID des Datenspeichers, der mit Ihrer App verknüpft ist.
Nachdem Sie Ihre Sperrliste importiert haben, dauert es ein bis zwei Tage, bis Vorschläge gefiltert werden.
Sperrliste aus Cloud Storage importieren
So importieren Sie eine Sperrliste aus einer JSON-Datei in Cloud Storage:
Erstellen Sie Ihre Sperrliste in einer JSON-Datei mit dem folgenden Format und importieren Sie sie in einen Cloud Storage-Bucket. Jeder Eintrag in der Sperrliste muss sich in einer neuen Zeile ohne Zeilenumbruch befinden.
{ "blockPhrase":"TERM_1","matchOperator":"MATCH_OPERATOR_1" } { "blockPhrase":"TERM_2","matchOperator":"MATCH_OPERATOR_2" }
Erstellen Sie eine lokale JSON-Datei, die das
gcsSource
-Objekt enthält. Verwenden Sie diesen Parameter, um auf den Speicherort der Sperrlistendatei in einem Cloud Storage-Bucket zu verweisen.{ "gcsSource": { "inputUris": [ "DENYLIST_STORAGE_LOCATION" ] } }
Ersetzen Sie
DENYLIST_STORAGE_LOCATION
durch den Speicherort Ihrer Sperrliste in Cloud Storage. Sie können nur einen URI eingeben. Der URI muss in diesem Format eingegeben werden:gs://BUCKET/FILE_PATH
.Senden Sie eine POST-Anfrage an die Methode
suggestionDenyListEntries:import
und fügen Sie dasgcsSource
-Objekt ein.curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ --data @GCS_SOURCE_FILE \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:import"
Ersetzen Sie Folgendes:
GCS_SOURCE_FILE
: Der lokale Pfad der Datei, die dasgcsSource
-Objekt enthält, das auf Ihre Sperrliste verweist.PROJECT_ID
: die Nummer oder ID Ihres Google Cloud Projekts.DATA_STORE_ID
: die ID des Datenspeichers, der mit Ihrer App verknüpft ist.
Nachdem Sie Ihre Sperrliste importiert haben, dauert es ein bis zwei Tage, bis Vorschläge gefiltert werden.
Sperrliste dauerhaft löschen
So löschen Sie eine Sperrliste aus Ihrem Datenspeicher:
Stellen Sie eine POST-Anfrage an die Methode
suggestionDenyListEntries:purge
.curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/suggestionDenyListEntries:purge"
Ersetzen Sie Folgendes:
PROJECT_ID
: die Nummer oder ID Ihres Google Cloud Projekts.DATA_STORE_ID
: die ID des Datenspeichers, der mit Ihrer App verknüpft ist.
Importierte Liste mit Vorschlägen für die automatische Vervollständigung verwenden
Sie können eine eigene Liste mit Vorschlägen für die automatische Vervollständigung bereitstellen, anstatt Vorschläge zu verwenden, die aus einem Datenmodell für die automatische Vervollständigung generiert werden.
Bei den meisten Anwendungen werden mit generierten Vorschlägen aus einem der Autocomplete-Datenmodelle bessere Ergebnisse erzielt. In seltenen Fällen entsprechen die Vorschläge des Modells jedoch möglicherweise nicht Ihren Anforderungen. In solchen Fällen kann es sinnvoll sein, eine separate Liste mit Vorschlägen zu erstellen, um Ihren Nutzern eine bessere automatische Vervollständigung zu bieten.
Eine kleine Onlinebuchhandlung importiert beispielsweise ihre Liste mit Buchtiteln als Vorschläge für die automatische Vervollständigung. Wenn ein Kunde mit der Eingabe in der Suchleiste beginnt, ist der Vorschlag zur automatischen Vervollständigung immer ein Buchtitel aus der importierten Liste. Wenn sich die Liste der Bücher ändert, löscht der Buchhändler die aktuelle Liste und importiert die neue Liste. Ein Auszug aus der Liste könnte so aussehen:
{"suggestion": "Wuthering Heights", "globalScore": "0.52" },
{"suggestion": "The Time Machine", "globalScore": "0.26" },
{"suggestion": "Nicholas Nickleby", "globalScore": "0.38" },
{"suggestion": "A Little Princess", "globalScore": "0.71" },
{"suggestion": "The Scarlet Letter", "globalScore": "0.32" }
Der globalScore
ist eine Gleitkommazahl im Bereich [0, 1], die zum Ranking des Vorschlags verwendet wird. Alternativ können Sie einen frequency
-Wert verwenden, der eine Ganzzahl größer als 1 ist. Der frequency
-Wert wird verwendet, um Vorschläge zu sortieren, wenn globalScore
nicht verfügbar ist (als „null“ festgelegt).
Vorschläge für die automatische Vervollständigung einrichten und importieren
So richten Sie eine Liste mit Vorschlägen für die automatische Vervollständigung aus BigQuery ein und importieren sie:
Erstellen Sie eine Liste mit Vorschlägen und laden Sie sie in eine BigQuery-Tabelle.
Sie müssen mindestens jeden Vorschlag als String und entweder eine globale Punktzahl oder eine Häufigkeit angeben.
Verwenden Sie das folgende Tabellenschema für Ihre Liste mit Vorschlägen:
[ { "description": "The suggestion text", "mode": "REQUIRED", "name": "suggestion", "type": "STRING" }, { "description": "Global score of this suggestion. Control how this suggestion would be scored and ranked. Set global score or frequency; not both.", "mode": "NULLABLE", "name": "globalScore", "type": "FLOAT" }, { "description": "Frequency of this suggestion. Used to rank suggestions when the global score is not available.", "mode": "NULLABLE", "name": "frequency", "type": "INTEGER" } ]
Eine Anleitung zum Erstellen einer BigQuery-Tabelle und zum Laden der Tabelle mit Ihrer Liste der Vorschläge zur automatischen Vervollständigung finden Sie in der BigQuery-Dokumentation.
Importieren Sie die Liste aus BigQuery.
Senden Sie eine POST-Anfrage an die Methode
completionSuggestions:import
und fügen Sie dasbigquerySource
-Objekt ein.curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ -H "Content-Type: application/json; charset=utf-8" \ -H "X-Goog-User-Project: PROJECT_ID" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/completionSuggestions:import" \ -d '{ "bigquery_source": {"project_id": "PROJECT_ID_SOURCE", "dataset_id": "DATASET_ID", "table_id": "TABLE_ID"} }'
Ersetzen Sie Folgendes:
PROJECT_ID
: die Nummer oder ID Ihres Google Cloud Projekts.DATA_STORE_ID
: Die ID des Vertex AI Search-Datenspeichers.PROJECT_ID_SOURCE
: Das Projekt, das das Dataset enthält, das Sie importieren möchten.DATASET_ID
: die Dataset-ID für die Vorschlagsliste, die Sie importieren möchtenTABLE_ID
: Die Tabellen-ID für die Vorschlagsliste, die Sie importieren möchten
Optional: Notieren Sie sich den zurückgegebenen
name
-Wert und folgen Sie der Anleitung unter Details zu einem lang andauernden Vorgang abrufen, um zu sehen, wann der Importvorgang abgeschlossen ist.Wenn Sie die automatische Vervollständigung für die App nicht aktiviert haben, folgen Sie der Anleitung unter Einstellungen für die automatische Vervollständigung aktualisieren. Achten Sie darauf, dass Sie Automatische Vervollständigung aktivieren auf Jetzt festlegen.
Warten Sie einige Tage, bis die Indexierung abgeschlossen ist und die importierten Vorschläge verfügbar sind.
Autocomplete-Anfrage senden
So senden Sie eine Anfrage zur automatischen Vervollständigung, die einen importierten Vorschlag anstelle eines Vorschlags aus einem Modell für die automatische Vervollständigung zurückgibt:
- Folgen Sie der Anleitung zum Senden einer Anfrage zur automatischen Vervollständigung an ein anderes Modell und legen Sie
AUTOCOMPLETE_MODEL
aufimported-suggestion
fest.
Liste der importierten Vorschläge für die automatische Vervollständigung löschen
Bevor Sie eine neue Liste mit Vorschlägen für die automatische Vervollständigung importieren, müssen Sie die vorhandene Liste entfernen.
So löschen Sie eine vorhandene Liste mit Vorschlägen für die automatische Vervollständigung:
Stellen Sie eine POST-Anfrage an die Methode
completionSuggestions:purge
.curl -X POST \ -H "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://discoveryengine.googleapis.com/v1/projects/PROJECT_ID/locations/global/dataStores/DATA_STORE_ID/completionSuggestions:purge"
Ersetzen Sie Folgendes:
PROJECT_ID
: die Nummer oder ID Ihres Google Cloud Projekts.DATA_STORE_ID
: die ID des Datenspeichers, der mit Ihrer App verknüpft ist.
Erweitertes Dokumentdatenmodell
AI Applications bietet ein erweitertes Datenmodell für die automatische Vervollständigung. Anhand der von Ihnen importierten Dokumente generiert dieses Datenmodell hochwertige Vorschläge für die automatische Vervollständigung, indem es Large Language Models (LLMs) von Google nutzt.
Diese Funktion wird derzeit noch getestet. Wenn Sie diese Funktion nutzen möchten, wenden Sie sich an Ihr Google Cloud -Account-Management-Team und bitten Sie darum, auf die Zulassungsliste gesetzt zu werden.
Das erweiterte Dokumentdatenmodell ist nicht für die Healthcare-Suche oder in den multiregionalen Standorten „US“ und „EU“ verfügbar.