Cette documentation de Recommendations AI fait référence à la console Recommendations. Nous vous recommandons de passer à la console Retail et d'utiliser la documentation pour le commerce de détail, qui fournit des informations sur Recommendations AI, la console et sur Retail Search.

Si vous utilisez la version v1beta de Recommendations AI, migrez vers la version Retail API.

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

Recommendations AI 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 (point de terminaison de service https://retail.googleapis.com) accessible à tous.

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

Ce document ne vous concerne que si vous avez commencé à utiliser Recommendations AI en version bêta.

Bonnes pratiques

  • Envoyez le trafic de validation uniquement avant la migration complète.
  • Il est préférable de procéder à la migration progressive du trafic plutôt que de tous les utiliser en même temps. Si possible, migrez progressivement votre trafic de la version 1beta1 vers la version 2.
  • 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 les pannes mondiales.

Modifications apportées à la documentation

Cet ensemble de documentation ne concerne que Recommendations AI et la console Recommendations Manager. Nous vous recommandons de déplacer les projets Recommendations AI vers la nouvelle console Retail et d'utiliser la documentation Retail, qui fait référence à la console Retail.

La documentation de Retail couvre Recommendations AI, la console Retail et Retail Search:

La documentation de la version bêta de l'API Recommendations Engine et de son ensemble de documentation reste disponible, mais elle ne sera plus mise à jour. Vous trouverez la documentation sur la version bêta ci-dessous:

Modifications apportées à la console

La console Recommendations AI remplace la console Recommendations AI.

Le service Retail Cloud Console est accessible au public à compter du 20 janvier 2022. Si vous utilisez la console Recommendations AI, nous vous recommandons d'accéder à vos projets Recommendations AI depuis la console Retail.

Pour obtenir une explication des modifications apportées aux fonctionnalités et à la terminologie de la console Recommendations AI par rapport à celle-ci, consultez la section Passer à la console Retail dans la documentation Retail.

Configurations et emplacements de diffusion

L'API Retail propose des configurations de diffusion, qui remplacent le concept d'emplacements utilisés par l'API Recommendations Engine.

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

Si vous disposez déjà d'emplacements ou si vous créez des emplacements, 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 l'emplacement correspondant.

La suppression d'une configuration de diffusion entraîne la suppression de l'emplacement correspondant. La suppression d'un emplacement entraîne la suppression de la configuration de diffusion correspondante.

Les configurations de diffusion vous permettent de modifier les options de reclassement et de reclassement des prix, et de les appliquer quasiment en temps réel. Pour 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 dans la documentation Retail.

Chemins d'accès REST et RPC

De nombreux changements ont été apportés aux chemins REST et RPC. Consultez la documentation de l'API Retail pour vous assurer que vous appelez correctement l'API Retail.

Tous les chemins d'accès utilisent désormais retail.googleapis.com au lieu de recommendationengine.googleapis.com.

Exemple:

API v1beta1 Recommendations Engine:

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

API v2 Retail:

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 récemment. Utilisez le tableau ci-dessous pour comparer les ressources v1beta1 à celles de la version 2.

Notez que les liens vers des ressources de la version v1beta1 permettent de consulter la documentation de l'API pour cette version.

Ressource v1beta1 Méthode Ressource v2 Méthode
catalogs list catalogs list
patch patch
ND 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
ND operations get
list

Modifications d'IAM

Les modifications suivantes ont été introduites dans les rôles et les autorisations IAM (Identity and Access Management) de Recommendations AI:

  • Recommendations AI utilise les rôles et autorisations IAM de l'espace de noms retail au lieu de 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.

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

Les schémas des événements catalogue et utilisateur ont changé dans l'API Retail.