Diese Seite wurde von der Cloud Translation API übersetzt.

Erweiterte automatische Vervollständigung konfigurieren

Auf dieser Seite wird die erweiterte Funktion für die automatische Vervollständigung der Vertex AI Search beschrieben.

Ähnlich wie bei der einfachen automatischen Vervollständigung werden auch bei der erweiterten automatischen Vervollständigung Abfragevorschläge basierend auf den ersten eingegebenen Zeichen generiert.

Bevor Sie diese Seite lesen, sollten Sie sich mit der grundlegenden automatischen Vervollständigung von Vertex AI Search vertraut machen. Siehe Autocomplete konfigurieren.

Wichtige Funktionen der erweiterten automatischen Vervollständigung

Die wichtigsten Funktionen der erweiterten automatischen Vervollständigung, die sie von der einfachen automatischen Vervollständigung unterscheiden, sind:

Kombinierte Suche:Die erweiterte automatische Vervollständigung kann mit Apps für die kombinierte Suche verwendet werden. Das sind allgemeine Suchanwendungen, die mit mehreren Datenspeichern verbunden sind.
Zugriffssteuerung:Die erweiterte automatische Vervollständigung berücksichtigt die Zugriffssteuerung. (Zugriffssteuerungen werden auch als ACLs bezeichnet, Access Control Lists.) Bei der erweiterten automatischen Vervollständigung werden nur Suchanfragen vorgeschlagen, die sich auf Dokumente beziehen, auf die der Suchende Zugriff hat. Weitere Informationen zur Zugriffssteuerung finden Sie unter Zugriffssteuerung für Datenquellen verwenden.
Sprachoptimierung:Die erweiterte automatische Vervollständigung kann so konfiguriert werden, dass Vorschläge in einer oder mehreren Sprachen optimiert werden. Wenn die Browsersprache beispielsweise Niederländisch ist, können Vorschläge für die automatische Vervollständigung in dieser Sprache verstärkt werden. Weitere Informationen finden Sie unter Abschlussvorschlagsanfrage mit Sprachoptimierung senden.
Verschiedene Arten von Vorschlägen:Bei der erweiterten automatischen Vervollständigung können Sie anstelle der normalen Vorschläge für die automatische Vervollständigung von Suchanfragen verschiedene Arten von Vorschlägen angeben:
- Ausführliche Vorschläge:Nutzer erhalten Informationen zu Dokumenten, deren Titel mit den Buchstaben beginnen, die sie eingeben. Weitere Informationen finden Sie unter Autocomplete-Anfrage senden und aussagekräftige Vorschläge zurückgeben.
- Letzte Suchanfragen:Als Vorschläge für die automatische Vervollständigung werden Nutzern ihre letzten Suchanfragen angezeigt, die mit den von ihnen eingegebenen Buchstaben beginnen. Weitere Informationen finden Sie unter Abschlussvorschlagsanfrage senden und letzte Suchanfragen zurückgeben.

Hinweise

Prüfen und bearbeiten Sie gegebenenfalls die Einstellungen für die automatische Vervollständigung für Ihre App. Weitere Informationen finden Sie unter Einstellungen für die automatische Vervollständigung aktualisieren.

Insbesondere bei Tests für kleinere Datenspeicher empfehlen wir, Autocomplete aktivieren auf Jetzt festzulegen. Das liegt daran, dass kleine Datenspeicher möglicherweise nicht genügend Daten enthalten, um genaue Vorschläge zu machen.

Autocomplete-Anfragen senden

Im Folgenden wird gezeigt, wie Sie erweiterte Vorschläge mit der Methode completionConfig.completeQuery senden.

REST

So senden Sie eine autocomplete-Anfrage über die API:

Suchen Sie Ihre App-ID. Wenn Sie bereits eine App-ID haben, fahren Sie mit dem nächsten Schritt fort.
1. Rufen Sie in der Google Cloud Console die Seite Agent Builder auf.
  
  Zu Apps wechseln
2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und sehen Sie sich die ID der App in der Spalte ID an.

Rufen Sie die Methode completionConfig.completeQuery auf.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
-d '{
      "query":"QUERY_STRING"
    }'

PROJECT_ID ist die ID Ihres Google Cloud-Projekts.
APP_ID: die ID der Vertex AI Search-Anwendung.
QUERY_STRING: Die Eingabevorschau, mit der Vorschläge abgerufen werden.

Anfrage zur automatischen Vervollständigung mit Sprachoptimierung senden

Sie können die automatische Vervollständigung von Vorschlägen nach Sprachcode hervorheben oder unterdrücken, z. B. die Wahrscheinlichkeit erhöhen oder verringern, dass Vorschläge in bestimmten Sprachen angezeigt werden.

Der Wert für die Steigerung muss zwischen -1 und 1 liegen. Wenn Sie eine negative Zahl festlegen, werden Vorschläge für die automatische Vervollständigung in dieser Sprache unterdrückt. Eine positive Zahl erhöht die Gewichtung der Sprache.

Verwenden Sie zweistellige Sprachtags gemäß BCP 47, z. B. en, fr, hi und zh.

REST

So senden Sie eine autocomplete-Anfrage mit einem Sprach-Boost-Wert:

Suchen Sie Ihre App-ID. Wenn Sie bereits eine App-ID haben, fahren Sie mit dem nächsten Schritt fort.
1. Rufen Sie in der Google Cloud Console die Seite Agent Builder auf.
  
  Zu Apps wechseln
2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und sehen Sie sich die ID der App in der Spalte ID an.

Rufen Sie die Methode completionConfig.completeQuery auf.

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
-d '{
      "query":"QUERY_STRING",
      "boostSpec": {
         "conditionBoostSpecs": [{
           "condition": "(langCode: ANY(LANG_CODE))",
           "boost": BOOST_VALUE
         }]
      }
    }'

PROJECT_ID ist die ID Ihres Google Cloud-Projekts.
APP_ID: die ID der Vertex AI Search-Anwendung.
QUERY_STRING: Die Eingabe, die zum Abrufen von Vorschlägen verwendet wird.
LANG_CODE: Der zweistellige Code für eine oder mehrere Sprachen in doppelten Anführungszeichen. Beispiel: \"fr\", \"es\", um den Wert für Spanisch und Französisch anzuwenden.
BOOST_VALUE: eine Gleitkommazahl zwischen −1 und 1. Wenn der Wert negativ ist, werden die automatischen Vorschläge in der Sprache herabgestuft (sie werden weiter unten in der Liste der Vorschläge angezeigt). Wenn der Wert positiv ist, werden Vorschläge hervorgehoben (sie werden weiter oben in der Liste angezeigt).

Beispielbefehl

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery" \
-d '{
     "query": { "text": "Co"}
     "boostSpec": {
        "conditionBoostSpecs": [{
          "condition": "(langCode: ANY(\"es\", \"fr\"))",
          "boost": 0.75 }, {
          "condition": "(langCode: ANY(\"en\"))",
          "boost": -1
        }]
      }
    }'

In diesem Beispiel werden die automatischen Vervollständigungsvorschläge für die Suchanfrage Co hervorgehoben (sie werden weiter oben in der Liste der automatischen Vervollständigungen angezeigt), wenn sie auf Französisch oder Spanisch sind, und werden unterdrückt (sie werden weiter unten in der Liste der automatischen Vervollständigungen angezeigt), wenn sie auf Englisch sind.

Anfrage für die automatische Vervollständigung senden und Rich-Vorschläge zurückgeben

Die erweiterte Autocomplete-Funktion gibt Inhalte (Dokumente) zurück, deren Titel Wörter enthalten, die mit der Suchanfrage beginnen.

Neben dem Titel des Dokuments gibt die autocomplete-Anfrage source_type und entity_type sowie, falls verfügbar, die Schlüsseleigenschaften uri, create_time und update_time zurück. Sie können Schlüsseleigenschaftszuordnungen auf der Seite „Datenspeicher“ auf dem Tab Schema aufrufen und bearbeiten.

Wie bei allen erweiterten Vorschlägen für die automatische Vervollständigung werden für alle vorgeschlagenen Dokumente ACLs berücksichtigt.

Beispiel

Ein Mitarbeiter sucht auf der Intranet-Website seines Unternehmens nach technischen Informationen zu Zugriffsberechtigungen.

Der Mitarbeiter beginnt mit der Eingabe von tec. Die folgenden Dokumente werden möglicherweise zurückgegeben: Data technicians handbook, Access technology guide und Techniques for troubleshooting access issues.

Bei umfassenden Vorschlägen können Sie für jedes dieser vorgeschlagenen Dokumente alle folgenden Informationen anzeigen: den Dokumenttitel (title), einen Link zum Dokument (uri), das Datum der letzten Aktualisierung (update_time) und die Quelle (source_type), z. B. ob das Dokument in Confluence Cloud oder Slack gefunden wurde. Wenn der Mitarbeiter weiß, wann ein Dokument zuletzt aktualisiert wurde und woher es stammt, kann er leichter entscheiden, welches Dokument er sich zuerst ansehen soll.

Beschränkungen

Die erweiterte automatische Vervollständigung gilt nur für Drittanbieter-Connectors und nur für bestimmte Entitätsdatenspeicher für diese Drittanbieter-Connectors. In der folgenden Tabelle sehen Sie, welche Entitäten für welche Connectors unterstützt werden.

Drittanbieter-Connector	Unterstützte Entitäten
Hinweise für Box	Datei
Confluence Cloud	Seite	Leertaste
Dropbox	Datei
Jira Cloud	Problem	Leertaste
OneDrive	Datei
Salesforce	Konto	Lead	Empfehlung
ServiceNow	Vorfall	Wissen
SharePoint Online	Anhang	Ereignis	Datei	Seite
Slack	Meldung

Prozedur

So senden Sie eine Anfrage für die automatische Vervollständigung, die einen ausführlichen Vorschlag zurückgibt:

REST

Suchen Sie Ihre App-ID. Wenn Sie bereits eine App-ID haben, fahren Sie mit dem nächsten Schritt fort.
1. Rufen Sie in der Google Cloud Console die Seite Agent Builder auf.
  
  Zu Apps wechseln
2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und sehen Sie sich die ID der App in der Spalte ID an.

Rufen Sie die Methode completionConfig.completeQuery auf.


curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
-d '{
      "query":"QUERY_STRING",
      "suggestionTypes": ["CONTENT"]
    }'

PROJECT_ID ist die ID Ihres Google Cloud-Projekts.
APP_ID: die ID der Vertex AI Search-Anwendung.
QUERY_STRING: Die Eingabevorschau, mit der Vorschläge abgerufen werden.

Beispielbefehl und -ergebnis

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery" \
- d {
      "query": "C",
      "suggestionTypes": ["CONTENT"]
    }'

{
  "contentSuggestions": [{
    "suggestion": "critical crash in payment module",
    "document": {
      "name": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store/branches/0/documents/10000",
      "derivedStructData": {
        "title": "Critical Crash in Payment Module",
        "uri": "https://cymballabs.atlassian.net/browse/CPT-1",
        "source_type": "jira",
        "entity_type": "issue"
      }
    },
    "dataStore": "projects/123456/locations/global/collections/default_collection/dataStores/my-data-store"
  }]
}

Anfrage für die automatische Vervollständigung senden und letzte Suchanfragen zurückgeben

Als Vorschläge werden die letzten Suchanfragen des Nutzers zurückgegeben, die mit der Suchanfrage in der Anfrage übereinstimmen.

Die übereinstimmenden Suchvorschläge werden vom neuesten zum ältesten aufgeführt. Wenn Sie die letzten Suchanfragen verwenden möchten, muss die Pseudo-ID des Nutzers angegeben werden.

Beispiel

Ein Mitarbeiter sucht auf der Intranet-Website seines Unternehmens nach Informationen zu Urlaubstagen. Der Mitarbeiter hat die folgenden Abfragen ausgeführt, sortiert nach Datum (neueste zuerst):

PTO, Vacation blackout periods, How much vacation time do I have?, Time off, Vacation policy, covering a vacant position during absences und Can I take unpaid time off?.

Wenn der Mitarbeiter nun vac in das Suchfeld eingibt, werden folgende Vorschläge zur automatischen Vervollständigung angezeigt:

Vacation blackout periods
How much vacation time do I have?
Vacation policy
Covering a vacant position during absences

Prozedur

So senden Sie eine automatische Vervollständigungsanfrage, die die letzten Suchanfragen des Nutzers zurückgibt:

REST

Suchen Sie Ihre App-ID. Wenn Sie bereits eine App-ID haben, fahren Sie mit dem nächsten Schritt fort.
1. Rufen Sie in der Google Cloud Console die Seite Agent Builder auf.
  
  Zu Apps wechseln
2. Suchen Sie auf der Seite Apps nach dem Namen Ihrer App und sehen Sie sich die ID der App in der Spalte ID an.

Rufen Sie die Methode completionConfig.completeQuery auf.


curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/PROJECT_ID/locations/global/collections/default_collection/engines/APP_ID/completionConfig:completeQuery" \
-d '{
      "query":"QUERY_STRING",
      "suggestionTypes": ["RECENT_SEARCH"],
      "userPseudoId": "USER_PSEUDO_ID"
    }'

PROJECT_ID ist die ID Ihres Google Cloud-Projekts.
APP_ID: die ID der Vertex AI Search-Anwendung.
QUERY_STRING: Die Eingabe, die zum Abrufen von Vorschlägen verwendet wird.
USER_PSEUDO_ID: eine pseudonymisierte Kennung des Nutzers. Sie können für dieses Feld ein HTTP-Cookie verwenden, das einen Besucher auf einem einzelnen Gerät eindeutig identifiziert. Legen Sie für dieses Feld nicht dieselbe Kennung für mehrere Nutzer fest. Dadurch werden die Suchverläufe der Nutzer kombiniert. Geben Sie in dieses Feld keine personenidentifizierbaren Informationen an.

Beispielbefehl und -ergebnis

curl -X POST -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
"https://discoveryengine.googleapis.com/v1beta/projects/my-project-123/locations/global/collections/default_collection/engines/my-app/completionConfig:completeQuery" \
-d '{
      "query": "hol",
      "suggestionTypes": ["RECENT_SEARCH"],
      "userPseudoId": "test_user"
    }'

{
  "recentSearchSuggestions": [
    {
      "suggestion": "holiday readiness",
      "recentSearchTime": "2024-11-19T18:27:07.261698Z"
    },
    {
      "suggestion": "holiday freeze",
      "recentSearchTime": "2024-11-19T18:25:45.744021Z"
    },
    {
      "suggestion": "holiday",
      "recentSearchTime": "2024-11-19T18:20:08.916884Z"
    }
  ]
}

Sperrliste für die automatische Vervollständigung verwenden

Mithilfe einer Sperrliste können Sie verhindern, dass bestimmte Begriffe als automatisch vervollständigte Vorschläge angezeigt werden.

Die erweiterte automatische Vervollständigung erfolgt zwar auf App-Ebene, aber Sperrlisten auf Datenspeicherebene. Das ist wichtig, wenn es sich bei Ihrer App um eine App mit kombinierter Suche handelt. Erstellen Sie eine Sperrliste für jeden Datenspeicher, der mit der App verbunden ist.

Informationen zum Erstellen und Verwenden von Sperrlisten finden Sie unter Sperrliste für automatische Vervollständigung verwenden.