Daten der automatischen Vervollständigung für die Suche importieren

Die automatische Vervollständigung ist eine Funktion, mit der sich die vom Nutzer eingegebenen Wörter vorhersagen lassen. Dadurch kann die Suche verbessert werden. Sie kann Vorschläge basierend auf dem bereitgestellten Dataset oder auf der Grundlage von Nutzerereignissen bereitstellen, die Sie angegeben haben.

Sie sollten nur dann Daten zur automatischen Vervollständigung importieren, wenn Sie zusätzliche Steuerelemente verwenden möchten („Liste nicht entfernen“, „Sperrliste“) oder wenn Sie eigene Daten für die automatische Vervollständigung verwenden müssen. In den meisten Fällen, in denen eine automatische Vervollständigung erforderlich ist, reicht es in den meisten Fällen aus, das automatische Lernen zu aktivieren. Beim automatischen Lernen wird ein durch maschinelles Lernen unterstütztes Dataset mit Vorschlägen bereitgestellt, das auf Suchereignissen der Nutzer basiert. Informationen zum Aktivieren des automatischen Lernens finden Sie unter Automatische Vervollständigung.

Hinweis :Ab September 2022 können Sie den Datenimport über Cloud Console > Steuerelemente > Steuerelemente für die automatische Vervollständigung auslösen.

Diese Anleitung bezieht sich nur auf das Hochladen Ihrer eigenen Daten für die automatische Vervollständigung. Halten Sie diese auf dem neuesten Stand, wenn Sie das Dataset zur automatischen Vervollständigung immer verwenden möchten. Informationen zum Abrufen von Ergebnissen der automatischen Vervollständigung zum Zeitpunkt der Abfrage finden Sie unter CompletionService.CompleteQuery. Die Daten der automatischen Vervollständigung werden nur für die Suche verwendet. Diese Daten werden nicht für Empfehlungen verwendet.

Hinweise

Bevor Sie die Informationen zur automatischen Vervollständigung importieren können, müssen Sie der Anleitung unter Vorbereitung folgen, insbesondere Ihr Projekt einrichten, ein Dienstkonto erstellen und das Dienstkonto Ihrer lokalen Umgebung hinzufügen.

Sie benötigen die IAM-Rolle Retail-Editor, um den Import durchzuführen.

Best Practices für die automatische Vervollständigung des Imports

Beachten Sie beim Importieren von Daten zur automatischen Vervollständigung die folgenden Best Practices:

• Lesen Sie das in den folgenden Abschnitten und die API-Dokumentation aufgeführte BigQuery-Schema.

• Verwenden Sie keine Platzhalterwerte.

• Wir empfehlen, so viele Felder wie möglich auszufüllen.

• Halten Sie Ihr eigenes Dataset zur automatischen Vervollständigung auf dem neuesten Stand, wenn Sie ein eigenes hochgeladenes Dataset verwenden möchten.

• Das Importieren von Daten aus einem anderen Projekt ist nicht zulässig.

Daten zur automatischen Vervollständigung importieren

Daten zur automatischen Vervollständigung aus BigQuery importieren

Vertex AI Search for Retail unterstützt den BigQuery-Datenimport für Sperrlisten, „Nicht entfernen“-Listen und Listen mit Vorschlagsbegriffen. Weitere Informationen finden Sie unter Automatische Vervollständigung.

Wenn Sie Daten zur automatischen Vervollständigung im richtigen Format aus BigQuery importieren möchten, verwenden Sie das Schema zur automatischen Vervollständigung von Vertex AI Search for Retail, um eine BigQuery-Tabelle mit dem richtigen Format zu erstellen und die Tabelle mit den Daten der automatischen Vervollständigung zu laden. Laden Sie Ihre Daten dann in Vertex AI Search for Retail hoch.

Weitere Informationen zu BigQuery-Tabellen finden Sie unter Einführung in Tabellen. Hilfe zu BigQuery-Abfragen finden Sie unter BigQuery-Daten abfragen.

Standort des BigQuery-Datasets

Wenn Sie das BigQuery-Dataset zum ersten Mal für Ihre BigQuery-Tabellen mit automatischer Vervollständigung erstellen, müssen Sie als Dataset-Speicherort den multiregionalen Standort "US" festlegen. Andernfalls schlägt die Importanfrage fehl. Weitere Informationen zu den BigQuery-Dataset-Standorten finden Sie unter Dataset-Standorte in der BigQuery-Dokumentation.

Daten in BigQuery einfügen

Verwenden Sie das Vertex AI Search for Retail Schema für die automatische Vervollständigung, um Ihre Daten zur automatischen Vervollständigung in BigQuery hochzuladen.

BigQuery kann mit dem Schema prüfen, ob JSON-formatierte Daten die richtigen Feldnamen und -typen haben (z. B. STRING, INTEGER und RECORD), kann aber keine Validierungen wie die Bestimmung durchführen:

• Ob ein Stringfeld einem erkennbaren Enum-Wert zugeordnet ist.
• Ob ein Stringfeld das richtige Format hat.
• Ob ein Ganzzahl- oder ein Gleitkommafeld einen Wert in einem gültigen Bereich enthält.
• Ob ein fehlendes Feld ein Pflichtfeld ist.

Um die Qualität Ihrer Daten und die Sucherfahrung für den Nutzer zu verbessern, sollten Sie das Schema und die Referenzdokumentation beachten, um Details über Werte und Format zu erfahren.

Zugriff auf BigQuery-Dataset einrichten

Achten Sie beim Einrichten des Zugriffs darauf, dass sich Ihr BigQuery-Dataset im selben Projekt wie Ihr Vertex AI Search for Retail-Dienst befindet, und führen Sie die folgenden Schritte aus.

1. Öffnen Sie in der Google Cloud Console die Seite IAM.

   Zur Seite "IAM"

2. Wählen Sie Ihr Vertex AI Search for Retail-Projekt aus.

3. Klicken Sie auf der Seite IAM und Verwaltung auf  Zugriff gewähren.

4. Geben Sie unter Neue Hauptkonten den Wert [e-mail] ein und wählen Sie die Rolle BigQuery > BigQuery-Datenbetrachter aus.

   Wenn Sie die Rolle „Datenbetrachter“ nicht für das gesamte Projekt bereitstellen möchten, können Sie diese Rolle direkt dem Dataset hinzufügen. Weitere Informationen

5. Klicken Sie auf Speichern.

Datenimport in Vertex AI Search for Retail auslösen

Console

1. Zur Seite "Steuerelemente"

2. Rufen Sie den Tab Steuerelemente für die automatische Vervollständigung auf.

3. Suchen Sie im Abschnitt Term Lists den Listentyp, den Sie importieren möchten (Ablehnungsliste, Liste nicht entfernen oder Liste der vorgeschlagenen Begriffe) und klicken Sie auf Importieren oder Ersetzen.

   Der Bereich Importieren wird geöffnet.

4. Geben Sie den BigQuery-Pfad Ihres Datenspeicherorts ein oder wählen Sie Durchsuchen aus, um den Speicherort auszuwählen.

   Der BigQuery-Pfad muss sich im selben Projekt befinden und sein Schema sollte korrekt sein. Um dies zu überprüfen, klicken Sie auf Durchsuchen und dann auf den Tabellennamen, um den Inhalt in der BigQuery-Konsole anzuzeigen.

5. Klicken Sie im Bereich Importieren auf Importieren.

   Der Import beginnt. Sie können die Seite verlassen, ohne den Import zu unterbrechen.

cURL

1. Erstellen Sie eine Datendatei für die Eingabeparameter für den Import. Ihre Eingabeparameterwerte hängen davon ab, ob Sie Daten aus Cloud Storage oder BigQuery importieren.

   Verwenden Sie das Objekt BigQuerySource, um auf Ihr BigQuery-Dataset zu verweisen.

   • dataset-id: Die ID des BigQuery-Datasets.
   • table-id: Die ID der BigQuery-Tabelle, die Ihre Daten enthält.
   • data-schema: Verwenden Sie für das Attribut dataSchema den Wert suggestions (Standard), allowlist oder denylist. Verwenden Sie das Schema für die automatische Vervollständigung von Vertex AI Search for Retail.

   {
     "inputConfig":{
       "bigQuerySource": {
         "datasetId":"dataset-id",
         "tableId":"table-id",
         "dataSchema":"data-schema"
       }
     }
   }
   

2. Importieren Sie die Informationen zur automatischen Vervollständigung in Vertex AI Search for Retail. Stellen Sie dazu eine POST-Anfrage an die REST-Methode CompletionData:import und geben Sie den Namen der Datendatei an (im Beispiel unten als input.json dargestellt).

   curl -X POST \
   -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   -H "Content-Type: application/json; charset=utf-8" -d @./input.json
   "https://retail.googleapis.com/v2alpha/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/completionData:import"
   

   Sie können den Status programmatisch mit der API prüfen. Sie sollten ein Antwortobjekt erhalten, das in etwa so aussieht:

   {
     "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456",
     "done": false
   }
   

   Das Feld "Name" ist die ID des Vorgangsobjekts. Ersetzen Sie das Feld „name“ durch den von der Importmethode zurückgegebenen Wert, um den Status dieses Objekts anzufordern. Wenn der Import abgeschlossen ist, wird im Feld done der Wert true zurückgegeben:

   curl -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
   "https://retail.googleapis.com/v2alpha/projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456"
   

   Wenn der Vorgang abgeschlossen ist, hat das zurückgegebene Objekt den done-Wert true und enthält ein Statusobjekt, das dem folgenden Beispiel ähnelt:

   {
     "name": "projects/PROJECT_ID/locations/global/catalogs/default_catalog/operations/123456",
     "metadata": {
       "@type": "type.googleapis.com/google.cloud.retail.v2alpha.ImportMetadata",
       "createTime": "2020-01-01T03:33:33.000001Z",
       "updateTime": "2020-01-01T03:34:33.000001Z",
       "successCount": "2",
       "failureCount": "1"
     },
     "done": true
     "response": {
       "@type": "type.googleapis.com/google.cloud.retail.v2alpha.ImportCompletionDataResponse",
     }
   }
   

Datenformat für die automatische Vervollständigung

Ihre JSON-Datei sollte wie im folgenden Beispiel aussehen. Die Zeilenumbrüche dienen der besseren Lesbarkeit. Sie sollten einen Vorschlag in einer einzigen Zeile angeben. Jeder Vorschlag sollte in einer eigenen Zeile stehen.

Mindestens erforderliche Felder für Vorschläge:

{
  "suggestion": "ABC",
  "globalScore": "0.5"
}

oder:

{
  "suggestion": "ABC",
  "frequency": "100"
}

Dauer des Datenimports für die automatische Vervollständigung

Ein Import aus BigQuery dauert in der Regel nur wenige Minuten bis zu einer Stunde.

Wenn der Import des Datasets abgeschlossen ist, ist das Feld done im Vorgangsobjekt als „true“ markiert. Danach kann es weitere 1–2 Tage dauern, bis die Daten indexiert und in der Produktion verwendet werden.

Dataset zur automatischen Vervollständigung auf dem neuesten Stand halten

Wenn Sie ein eigenes hochgeladenes Dataset verwenden möchten, empfiehlt es sich, das hochgeladene Dataset regelmäßig zu aktualisieren.

Batch-Update

Sie können die Importmethode verwenden, um die automatische Vervollständigung im Batch zu aktualisieren. Gehen Sie dabei genauso vor wie beim ersten Import. Führen Sie die Schritte unter Daten zur automatischen Vervollständigung importieren aus. Damit wird das gesamte importierte Dataset ersetzt.

Importzustand überwachen

Es ist wichtig, dass Sie Ihr eigenes Dataset auf dem neuesten Stand halten, damit qualitativ hochwertige Vorschlagsergebnisse ausgegeben werden. Sie sollten die Importfehlerraten überwachen und bei Bedarf Maßnahmen ergreifen.

Vertex AI Search for Retail Schema für die automatische Vervollständigung

Verwenden Sie beim Importieren eines Datasets zur automatischen Vervollständigung aus BigQuery das unten angegebene Schema von Vertex AI Search for Retail, um BigQuery-Tabellen im richtigen Format zu erstellen und mit den Daten der automatischen Vervollständigung zu laden.

Schema für Vorschläge

Dieses Dataset wird verwendet, um eigene Vorschläge für die automatische Vervollständigung mit Ihren eigenen Punktzahlen bereitzustellen.

Schema für automatische Vervollständigungsvorschläge von Vertex AI Search for Retail

JSON

[
  {
    "description": "The suggestion text",
    "mode": "NULLABLE",
    "name": "suggestion",
    "type": "STRING"
  },
  {
    "description": "Global score of this suggestion. Control how this suggestion would be scored / ranked. Only one of this and frequency should be set.",
    "mode": "NULLABLE",
    "name": "globalScore",
    "type": "FLOAT"
  },
  {
    "description": "Frequency of this suggestion. Will be used to rank suggestions when score is not available.",
    "mode": "NULLABLE",
    "name": "frequency",
    "type": "INTEGER"
  },
  {
    "description": "BCP-47 language code of this suggestion.",
    "mode": "NULLABLE",
    "name": "languageCode",
    "type": "STRING"
  },
  {
    "description": "If two suggestions have the same groupID, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.",
    "mode": "NULLABLE",
    "name": "groupID",
    "type": "STRING"
  },
  {
    "description": "The score of this suggestion within its group",
    "mode": "NULLABLE",
    "name": "groupScore",
    "type": "FLOAT"
  },
  {
    "description": "Device type for this suggestion.",
    "mode": "NULLABLE",
    "name": "deviceType",
    "type": "STRING"
  },
  {
    "description": "Alternative matching phrases for this suggestion.",
    "mode": "REPEATED",
    "name": "alternativePhrases",
    "type": "STRING"
  },
  {
    "fields": [
      {
        "description": "The name of the custom attribute.",
        "mode": "NULLABLE",
        "name": "key",
        "type": "STRING"
      },
      {
        "fields": [
          {
            "description": "The textual values of this custom attribute.",
            "mode": "REPEATED",
            "name": "text",
            "type": "STRING"
          },
          {
            "description": "The numerical values of this custom attribute.",
            "mode": "REPEATED",
            "name": "numbers",
            "type": "FLOAT"
          }
        ],
        "mode": "NULLABLE",
        "name": "value",
        "type": "RECORD"
      }
    ],
    "description": "A custom attribute that is not explicitly modeled, which can be retrieved together with the suggestion at serving time.",
    "mode": "REPEATED",
    "name": "customAttributes",
    "type": "RECORD"
  }
]

Schema für Sperrliste

Dieses Dataset wird als Sperrliste verwendet, um das Vorschlagen von Wortgruppen zu verhindern.

Vertex AI Search für den Einzelhandel – Schema für die automatische Vervollständigung der Sperrliste (JSON)

JSON

[
  {
    "description": "The phrase to block from autocomplete suggestions.",
    "mode": "REQUIRED",
    "name": "phrase",
    "type": "STRING"
  },
  {
    "description": "The operator to apply for this phrase. Choose whether to block the exact phrase, or block any suggestions containing this phrase. Supported value \"EXACT_MATCH\", \"CONTAINS\"",
    "mode": "REQUIRED",
    "name": "operator",
    "type": "STRING"
  }
]

Schema für die Zulassungsliste

Mit diesem Dataset werden Post-Prozesse für alle Wortgruppen in dieser Zulassungsliste übersprungen (z. B. Rechtschreibkorrektur und Filterung nach Nullergebnis).

Schema der Zulassungsliste für die automatische Vervollständigung von Vertex AI Search für den Einzelhandel (JSON)

JSON

[
  {
    "description": "The phrase to be exempted from autocomplete post processing, e.g. spell correction, filtering",
    "mode": "REQUIRED",
    "name": "phrase",
    "type": "STRING"
  },
  {
    "description": "The operator to apply for this phrase. Whether to match the exact phrase, or any suggestions contain this phrase. Supported values are \"EXACT_MATCH\", \"CONTAINS\".",
    "mode": "REQUIRED",
    "name": "operator",
    "type": "STRING"
  }
]