Passer de la version bêta à l'API Retail

Recommendations utilise désormais l'API Retail. Cette page décrit les modifications introduites et les bonnes pratiques de migration lors du passage de la version v1beta1 de l'API Recommendations Engine (point de terminaison de service https://recommendationengine.googleapis.com) à l'API Retail en disponibilité générale (point de terminaison de service https://retail.googleapis.com)

L'API Recommendations Engine et son ensemble de documentation restent disponibles, mais ils ne sont plus mis à jour.

Ce document ne vous concerne que si vous avez commencé à utiliser les recommandations lorsqu'elle était en version bêta.

Bonnes pratiques

  • Avant d'avoir effectué la migration complète, envoyez exclusivement le trafic de validation.
  • Il est préférable de migrer le trafic de manière incrémentale plutôt que d'un seul coup. Si possible, migrez progressivement votre trafic de la version v1beta1 vers la version v2.
  • Si vous exécutez des services dans différentes régions, il est préférable de migrer les régions une par une pour éviter une pannes globale.

Modifications de la documentation

Après être passé à la console Retail, nous vous recommandons de n'utiliser que la documentation Retail : https://cloud.google.com/retail/docs.

La documentation de la version bêta pour l'API Recommendations Engine reste disponible, mais n'est plus mise à jour.

Modifications apportées à la console

La console Retail remplace la console Recommandations.

La console Google Cloud destinée au commerce est accessible au public depuis le 20 janvier 2022. Si vous utilisez la console de recommandations, nous vous recommandons d'accéder à vos projets de recommandations à partir de la console Retail.

Pour en savoir plus sur les modifications apportées aux fonctionnalités et à la terminologie de la console Retail par rapport à la console Recommandations, consultez Passer à la console Retail.

Schémas de catalogue et d'événement utilisateur

Les schémas de catalogue et d'événement utilisateur ont été modifiés dans l'API Retail.

Configurations de diffusion et emplacements

L'API Retail introduit les configurations de diffusion, qui remplacent le concept d'emplacement utilisé par l'API Recommendations Engine.

Les configurations de diffusion sont disponibles à partir de Recommendations v2 et Retail Search v2alpha, à l'aide de l'API Retail.

La ressource servingConfig est disponible dans les versions v2beta et v2alpha de l'API Retail. Vous pouvez utiliser cette ressource pour créer, afficher, modifier et supprimer des configurations de diffusion.

Si vous disposez déjà d'emplacements, ou si vous en créez d'autres, l'API Retail crée automatiquement une configuration de diffusion associée à chaque emplacement. La création d'une configuration de diffusion ne crée pas d'emplacement correspondant.

La suppression d'une configuration de diffusion entraîne la suppression de l'emplacement correspondant. De plus, la suppression d'un emplacement entraîne la suppression de la configuration de diffusion qui lui correspond.

Les configurations de diffusion vous permettent de modifier les options de diversité et de reclassement du prix, et de les appliquer quasiment en temps réel. Avec les emplacements, les paramètres de diversité et de tarification ne peuvent être modifiés qu'à partir du modèle de recommandation vers lequel pointe l'emplacement.

Les emplacements sont toujours acceptés, mais nous vous recommandons d'utiliser plutôt des configurations de diffusion.

Pour en savoir plus sur l'utilisation des configurations de diffusion, consultez les pages Configurations de diffusion et Créer des configurations de diffusion.

Chemins d'accès REST et RPC

De nombreuses modifications ont été apportées aux chemins d'accès REST et RPC. Consultez la documentation de l'API Retail pour vous assurer que vos appels sont correctement formulés.

Tous les chemins utilisent désormais retail.googleapis.com au lieu de recommendationengine.googleapis.com.

Exemple :

API Recommendations Engine v1beta1 : 

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

API Retail v2 :

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

Certaines ressources et méthodes ont été renommées, supprimées ou ajoutées. Le tableau ci-dessous compare côte à côte les ressources v1beta1 et v2, ainsi que les méthodes associées.

Par exemple, la ressource v1beta1 catalogs.catalogItems équivaut à la ressource v2 catalogs.branches.products. La méthode list, disponible dans catalogs.catalogItems pour la version v1beta1, n'est pas disponible pour catalogs.branches.products dans la version 2, elle est donc marquée comme Supprimée.

Notez que les liens vers les ressources v1beta1 renvoient à la documentation de l'API pour la version v1beta1.

Ressource v1beta1 Méthode Ressource v2 Méthode
catalogs list catalogs list
patch patch
Non disponible catalogs.branches.operations get
catalogs.catalogItems create catalogs.branches.products create
delete delete
get get
import import
list Supprimé
patch patch
catalogs.operations get catalogs.operations get
list list
catalogs.eventStores.operations get Supprimé
list
catalogs.eventStores.placements predict catalogs.placements predict
catalogs.eventStores.predictionApiKeyRegistrations create Supprimé
delete
list
catalogs.eventStores.userEvents collect catalogs.userEvents collect
import import
list Supprimé
purge purge
rejoin rejoin
write write
Non disponible operations get
list

Modifications apportées à IAM

Les modifications suivantes ont été apportées aux rôles et autorisations IAM (Identity and Access Management) pour Retail :

  • Retail utilise des rôles et des autorisations IAM dans l'espace de noms retail plutôt que dans l'espace de noms automlrecommendations utilisé par Recommendations Engine v1beta1.
  • Le rôle Admin Viewer a été supprimé.
  • Les autorisations pour apiKeys ont été supprimées, car la méthode predict ne nécessite plus sa propre clé API.