Diese Recommendations AI-Dokumentation verweist auf die Recommendations Console. Wir empfehlen, zur Retail Console zu wechseln und die Dokumentation für Einzelhändler zu verwenden. Darin werden Recommendations AI, die Retail Console und Retail Search dokumentiert.

Wenn Sie die v1beta-Version von Recommendations AI verwenden, migrieren Sie zur Retail API-Version.

Von der Betaversion zur Retail API migrieren

Recommendations AI verwendet jetzt die Retail API. Auf dieser Seite werden die eingeführten Änderungen und die 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 die zugehörige Dokumentation sind weiterhin verfügbar, werden aber nicht mehr aktualisiert.

Dieses Dokument gilt nur für Sie, wenn Sie mit der Verwendung von Recommendations AI in der Betaphase begonnen haben.

Best Practices

  • Senden Sie vor der vollständigen Migration nur validierten Traffic.
  • Die schrittweise Trafficmigration ist besser, als alle gleichzeitig zu wechseln. Migrieren Sie den Traffic nach Möglichkeit von v1beta1 zu v2.
  • Wenn Sie Dienste in verschiedenen Regionen ausführen, sollten Sie Regionen nach und nach migrieren, um einen globalen Ausfall zu vermeiden.

Änderungen an der Dokumentation

Dieser Dokumentationssatz gilt nur für Recommendations AI und die Recommendations-Konsole. Wir empfehlen Recommendations AI-Projekte in die neuere Retail Console und unter Verwendung der Retail-Dokumentation, die auf die Retail Console verweist.

Die Dokumentation zu Retail behandelt Recommendations AI, die Retail Console und Retail Search:

Die Beta-Dokumentation für die Recommendations Engine API und ihre Dokumentation sind weiterhin verfügbar, werden aber nicht mehr aktualisiert. Die Beta-Dokumentation finden Sie unten:

Änderungen in der Console

Die Recommendations AI-Konsole ersetzt die Recommendations Console.

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

Eine Beschreibung der Änderungen bei den Funktionen und der Terminologie in der Recommendations AI-Konsole im Vergleich zur Recommendations-Konsole finden Sie in der Retail-Dokumentation unter Zur Retail-Konsole wechseln.

Bereitstellungskonfigurationen und -Placements

Mit der Retail API werden Bereitstellungskonfigurationen eingeführt, die das Konzept der von der Recommendations Engine API verwendeten Placements ersetzen.

Bereitstellungskonfigurationen sind über die Retail API ab Recommendations AI V2 und Retail Search V2Alpha verfügbar.

Wenn Sie bereits Placements haben oder neue Placements erstellen, wird von der Retail API automatisch eine Auslieferungskonfiguration für jedes Placement erstellt. Beim Erstellen einer Bereitstellungskonfiguration wird kein entsprechendes Placement erstellt.

Beim Löschen einer Bereitstellungskonfiguration wird das entsprechende Placement gelöscht. Beim Löschen eines Placements wird auch die entsprechende Auslieferungskonfiguration gelöscht.

Mit Bereitstellungskonfigurationen können Sie die Optionen für Vielfalt und Preis-Reranking bearbeiten, sodass sie nahezu in Echtzeit wirksam werden. Bei Placements können die Einstellungen für Variante und Preis nur über das Empfehlungsmodell geändert werden, auf das das Placement verweist.

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

Weitere Informationen zur Verwendung von Bereitstellungskonfigurationen finden Sie unter Bereitstellungskonfigurationen und Bereitstellungskonfigurationen erstellen in der Retail-Dokumentation.

REST- und RPC-Pfade

An den REST- und RPC-Pfaden wurden zahlreiche Änderungen vorgenommen. Lesen Sie in der API-Dokumentation zur Retail API nach, ob Sie die Retail API korrekt aufrufen.

In allen Pfaden wird jetzt retail.googleapis.com anstelle von recommendationengine.googleapis.com verwendet.

Beispiele:

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 finden Sie einen Vergleich der v1beta1-Ressourcen mit denen von v2.

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

v1beta1-Ressource Methode v2-Ressource Methode
catalogs list catalogs list
patch patch
Nicht zutreffend 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
Nicht zutreffend operations get
list

IAM-Änderungen

Die folgenden Änderungen wurden an Recommendations AI-Rollen und -Berechtigungen (Identity and Access Management, IAM) eingeführt:

  • Recommendations AI 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 für die Methode predict kein eigener API-Schlüssel mehr erforderlich ist.

Katalog- und Nutzerereignisschemas

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