Dies ist die Dokumentation für Recommendations AI, Retail Search und die neue Retail Console.

Von der Betaversion zur Retail API migrieren

Recommendations AI verwendet jetzt die Retail API. Auf dieser Seite werden die eingeführten Änderungen und Best Practices für die Migration beim Wechsel von der v1beta1-Version der Recommendations Engine API (Dienstendpunkt https://recommendationengine.googleapis.com) zur allgemein verfügbaren Retail API (Dienstendpunkt https://retail.googleapis.com) erläutert.

Die Recommendations Engine API und ihr Dokumentationssatz sind weiterhin verfügbar, werden jedoch nicht mehr aktualisiert.

Dieses Dokument betrifft Sie nur, wenn Sie die Recommendations AI mit der Betaversion genutzt haben.

Best Practices

  • Senden Sie nur validierten Traffic vor der vollständigen Migration.
  • Die inkrementelle Trafficmigration ist besser als die gleichzeitige Umstellung. Migrieren Sie Ihren Traffic nach Möglichkeit schrittweise von v1beta1 zu v2.
  • Wenn Sie Dienste in verschiedenen Regionen ausführen, ist es besser, die Regionen nacheinander zu migrieren, um einen globalen Ausfall zu vermeiden.

Änderungen in der Dokumentation

Diese Dokumentationsreihe bezieht sich auf die allgemein verfügbare Retail API.

Die Beta-Dokumentation für die Recommendations Engine API und deren Dokumentation ist weiterhin verfügbar, wird jedoch nicht mehr aktualisiert. Die Beta-Dokumentation finden Sie unten:

Console-Änderungen

Die Einzelhandelskonsole ersetzt die Empfehlungskonsole.

Die Cloud Console für den Einzelhandel ist seit dem 20. Januar 2022 öffentlich verfügbar. Wenn Sie die Recommendations Console verwenden, empfehlen wir, über die Retail Console auf Ihre Recommendations AI-Projekte zuzugreifen.

Eine Erläuterung der Änderungen in der Funktionalität und der Terminologie in der Einzelhandelskonsole im Vergleich zur Empfehlungskonsole finden Sie unter Zur Einzelhandelskonsole wechseln.

Bereitstellungskonfigurationen und Placements

Die Retail API führt Konfigurationen für die Anzeigenbereitstellung ein, die das Konzept der Placements ersetzen, die von der Recommendations Engine API verwendet werden.

Bereitstellungskonfigurationen sind ab Recommendations AI Version 2 und Retail Search Version 2 (Alpha) verfügbar.

Die Ressource servingConfig ist in den Retail API-Versionen v2beta und v2alpha verfügbar. Sie können diese Ressource verwenden, um Bereitstellungskonfigurationen zu erstellen, anzusehen, zu bearbeiten und zu entfernen.

Wenn Sie bereits Placements oder neue Placements haben, wird für die Retail API automatisch eine Bereitstellungskonfiguration erstellt, die mit jedem Placement verknüpft ist. Wenn Sie eine Bereitstellungskonfiguration erstellen, wird kein entsprechendes Placement erstellt.

Wenn Sie eine Bereitstellungskonfiguration löschen, wird auch das entsprechende Placement gelöscht. Wenn Sie ein Placement löschen, wird auch die entsprechende Bereitstellungskonfiguration gelöscht.

Mit Bereitstellungskonfigurationen können Sie Diversität und Preis-Reranking-Optionen bearbeiten und nahezu in Echtzeit wirksam werden. Bei Placements können Diversitäts- und Preiseinstellungen nur vom Empfehlungsmodell geändert werden, auf das das Placement verweist.

Placements werden weiterhin unterstützt, aber die Verwendung von Bereitstellungskonfigurationen wird empfohlen.

Weitere Informationen zum Verwenden von Bereitstellungskonfigurationen finden Sie unter Bereitstellungskonfigurationen und Erstellen von Bereitstellungskonfigurationen.

REST- und RPC-Pfade

An den REST- und RPC-Pfaden wurden viele Änderungen vorgenommen. Lesen Sie die API-Dokumentation für die Retail API, um sicherzustellen, dass Sie die Retail API ordnungsgemäß aufrufen.

Für alle Pfade wird jetzt retail.googleapis.com anstelle von recommendationengine.googleapis.com verwendet.

Beispiel:

v1beta1 Recommendations Engine API:

GET https://recommendationengine.googleapis.com/v1beta1/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID

V2 Retail API:

GET https://retail.googleapis.com/v2/projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/operations/OPERATION_ID

Einige Ressourcen und Methoden wurden umbenannt, entfernt oder neu hinzugefügt. In der folgenden Tabelle werden v1beta1- und v2-Ressourcen sowie die zugehörigen Methoden nebeneinander verglichen.

Die v1beta1-Ressource catalogs.catalogItems entspricht beispielsweise der v2-Ressource catalogs.branches.products. Die Methode list, die in catalogs.catalogItems für v1beta1 verfügbar war, ist für catalogs.branches.products in v2 nicht verfügbar. Daher wird sie als Entfernt angezeigt.

Links zu v1beta1-Ressourcen finden Sie in der API-Dokumentation für v1beta1.

v1beta1-Ressource Methode v2-Ressource Methode
catalogs list catalogs list
patch patch
catalogs.branches.operations get
catalogs.catalogItems create catalogs.branches.products create
delete delete
get get
import import
list Entfernt
patch patch
catalogs.operations get catalogs.operations get
list list
catalogs.eventStores.operations get Entfernt
list
catalogs.eventStores.placements predict catalogs.placements predict
catalogs.eventStores.predictionApiKeyRegistrations create Entfernt
delete
list
catalogs.eventStores.userEvents collect catalogs.userEvents collect
import import
list Entfernt
purge purge
rejoin rejoin
write write
operations get
list

IAM-Änderungen

Die folgenden Änderungen wurden an Rollen und Berechtigungen für die Identitäts- und Zugriffsverwaltung (IAM) für Retail eingeführt:

  • Retail verwendet IAM-Rollen und -Berechtigungen im Namespace retail anstelle des Namespace automlrecommendations, der von Recommendations Engine v1beta1 verwendet wurde.
  • Die Rolle Admin Viewer wurde entfernt.
  • Berechtigungen für apiKeys wurden entfernt, da die predict-Methode keinen eigenen API-Schlüssel mehr benötigt.

Katalog- und Nutzerereignisschemas

Die Schemas für Katalog- und Nutzerereignisse wurden in der Retail API geändert.