Filtrer les recommandations

Cette page explique comment filtrer les résultats des recommandations à l'aide d'attributs de produit.

Vous pouvez filtrer les résultats de prédiction en spécifiant une expression de filtre dans les requêtes de prédiction. L'expression de filtre est une expression logique évaluée pour chaque produit. La liste des produits de la réponse est limitée aux produits pour lesquels l'expression renvoie la valeur "true".

Il existe deux versions de filtrage pour les recommandations:

• Nous vous recommandons d'utiliser la version 2.
• La version 1 est obsolète, mais elle peut toujours être utilisée.

Les sections de ce guide d'utilisation ne s'appliquent qu'à la version 2 du filtrage, qui filtre les recommandations à l'aide d'attributs de produits.

Filtrage des recommandations, version 2

La version 2 utilise des attributs de produit. Les expressions de filtre sont basées sur les attributs des produits. Il peut s'agir d'attributs système prédéfinis, tels que categories et colors, ou d'attributs personnalisés que vous définissez, tels que attributes.styles. Lorsque vous définissez un attribut de produit comme filtrable, les recommandations peuvent automatiquement utiliser ces attributs comme tags pour le filtrage des recommandations, au lieu de vous demander d'ajouter manuellement des tags de filtre.

Lorsque vous utilisez des attributs pour filtrer des produits, la réponse de prédiction renvoie des produits principaux contenant au moins un produit principal ou une variante dont la valeur d'attribut correspond à l'expression de filtre. Pour en savoir plus sur les produits principaux et les variantes, consultez la section Niveaux de produit.

L'exemple d'expression de filtre suivant filtre également les produits rouges ou bleus définis comme "Nouveauté" et non comme promotionnels:

colors: ANY("red", "blue") AND attributes.status: ANY("New-Arrival") AND NOT attributes.is_promotional: ANY("true")

Pour utiliser la version 2 du filtrage pour les recommandations, suivez ces procédures. Chaque procédure est décrite plus loin sur cette page.

1. Activez le filtrage des recommandations pour un modèle qui diffusera des recommandations filtrées.
2. Activez le filtrage des recommandations pour les attributs de produit sur lesquels vous prévoyez de filtrer.
3. Utilisez des attributs de produits filtrables dans les requêtes de prédiction.

Filtrage des recommandations, version 1 (obsolète)

La version 1 utilise des balises de filtre créées manuellement. Les expressions de filtre sont basées sur des balises de filtre, que vous devez ajouter manuellement à tous les produits de votre catalogue que vous prévoyez de filtrer.

L'exemple d'expression de filtre suivant utilise des balises de filtre pour spécifier les produits tagués comme "Rouge" ou "Bleu", ainsi que la balise "Nouveauté", et qui ne sont pas tagués comme "promotionnels":

tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")

Consultez la documentation de référence de l'API pour le champ Product.tags[].

Les expressions de tag peuvent contenir les opérateurs booléens OR ou NOT, qui doivent être séparés des valeurs de tag par un ou plusieurs espaces. Les valeurs de tag peuvent également être immédiatement précédées d'un tiret (-), ce qui équivaut à l'opérateur NOT. Les expressions de tag qui utilisent les opérateurs booléens doivent être placées entre parenthèses.

En plus des tags, vous pouvez filtrer par filterOutOfStockItems. L'indicateur filterOutOfStockItems filtre tous les produits dont le champ stockState a la valeur OUT_OF_STOCK.

Vous pouvez combiner des filtres de balise et des filtres de rupture de stock afin que seuls les articles qui répondent à toutes les expressions de filtre spécifiées soient renvoyés.

Voici quelques exemples de chaînes de filtre :

"filter": "tag=\"spring-sale\""

"filter": "filterOutOfStockItems"

"filter": "tag=\"spring-sale\" tag=\"exclusive\" filterOutOfStockItems"

L'exemple suivant renvoie uniquement les articles en stock qui ont le tag spring-sale ou exclusive (ou les deux), mais pas le tag items-to-exclude.

"filter": "tag=(\"spring-sale\" OR \"exclusive\") tag=(-\"items-to-exclude\") filterOutOfStockItems"

Compatibilité des filtres d'attributs et de tags

Si un modèle comporte à la fois des balises créées manuellement et des attributs de produit filtrables, il peut répondre aux requêtes de prédiction à l'aide de l'une ou l'autre version de filtrage. Toutefois, il n'est pas possible d'inclure à la fois des expressions de filtrage v1 et v2 dans la même requête de prédiction.

Limites de filtrage des recommandations

Chaque attribut filtrable consomme de la mémoire dans chacun de vos modèles. Les limites suivantes permettent d'éviter les effets négatifs sur les performances de diffusion:

• Vous pouvez définir jusqu'à 10 attributs personnalisés comme filtrables dans votre catalogue.

• Votre catalogue peut contenir jusqu'à 100 000 000 valeurs d'attribut filtrables.

  Vous pouvez estimer le nombre total de valeurs d'attributs dans votre catalogue en multipliant le nombre de produits par le nombre d'attributs filtrables.

  Par exemple, si votre catalogue comporte 1 000 produits et que trois attributs sont définis comme filtrables, le nombre total de valeurs d'attribut peut être estimé à 3 x 1 000=3 000.

  Si vous utilisez le filtrage des recommandations de la version 1 avec la version 2, le nombre de balises de filtre est comptabilisé dans votre quota. Assurez-vous que le nombre de balises de filtre ajoutées au nombre total de valeurs d'attribut est inférieur à 100 000 000.

Si vous dépassez ces limites, vous ne pouvez pas définir d'attributs supplémentaires comme filtrables. Si vous devez dépasser ces limites, demandez une augmentation de quota.

Le nombre total de balises est calculé lors de l'entraînement du modèle. Si le nombre total dépasse la limite, l'entraînement du modèle échoue. Si plus de 10 attributs personnalisés filtrables sont détectés lors de l'entraînement du modèle, seuls 10 d'entre eux sont utilisés.

Syntaxe de l'expression de filtre "Recommandations"

Les syntaxes des expressions de filtre pour la recherche et les recommandations sont similaires. Toutefois, les recommandations présentent plusieurs limites.

La syntaxe de l'expression de filtre de recommandations peut être résumée au format EBNF comme suit:

  # A single expression or multiple expressions that are joined by "AND" or "OR".
  filter = expression, { " AND " | "OR", expression };

  # An expression can be prefixed with "-" or "NOT" to express a negation.
  expression = [ "-" | "NOT " ],
                    # A parenthesized expression
                    | "(", expression, ")"
                    # A simple expression applying to a textual field.
                    # Function "ANY" returns true if the field contains any of the literals.
                    ( textual_field, ":", "ANY", "(", literal, { ",", literal }, ")"

  # A literal is any double-quoted case sensitive string. You must escape backslash (\) and
  # quote (") characters. We do not support textual values containing `/` characters, or partial string matches.

  # The literal must be an exact match for products in the catalog. The Predict
  # API returns empty results when no possible matches exist.

  literal = double-quoted string;

  textual_field = see the tables below;

Restrictions de syntaxe des filtres

Les restrictions suivantes s'appliquent :

• La profondeur d'intégration des opérateurs AND et OR entre parenthèses est limitée. Les expressions logiques du filtre doivent être au format forme normale conjonctive (CNF). L'expression logique la plus complexe acceptée peut être une liste de clauses connectée par AND ne contenant que des opérateurs OR, par exemple: (... OR ... OR ...) AND (... OR ...) AND (... OR ...)
• Les expressions peuvent être annulées à l'aide du mot clé NOT ou de -. Cette opération ne fonctionne que avec des expressions ANY() avec un seul argument qui n'incluent pas d'attributs liés à l'inventaire.
• Les restrictions basées sur availability doivent se trouver au niveau supérieur. Elles ne peuvent pas être utilisées dans une clause OR ni dans une négation (NOT).
• Étant donné que le filtrage des recommandations standards n'est compatible qu'avec les champs textuels, les opérations inférieures à, supérieures à et de vérification de plage ne sont pas acceptées pour le filtrage des recommandations standards. Les opérations inférieures et supérieures ne peuvent être utilisées que avec les conditions de contrôle de promotion/d'enterrement des recommandations, qui acceptent certains champs numériques (voir Champs acceptés pour la promotion/l'enterrement).
• Le nombre maximal de termes dans la clause AND de premier niveau est de 20.
• Une clause OR peut comporter jusqu'à 100 arguments inclus dans des expressions ANY(). Si une clause OR comporte plusieurs expressions ANY(), leurs arguments sont tous comptabilisés dans cette limite. Par exemple, colors: ANY("red", "green") OR colors: ANY("blue") comporte trois arguments.

Le tableau suivant présente des exemples d'expressions de filtre valides, ainsi que des exemples non valides et les raisons pour lesquelles ils ne le sont pas.

Filtrage des attributs liés à l'inventaire

Le filtrage des attributs liés à l'inventaire est basé sur l'état en temps réel de vos produits. Pour le filtrage availability: ANY("IN_STOCK"), la réponse de prédiction renvoie les produits principaux pour lesquels le produit principal ou une variante a la valeur correspondante de IN_STOCK. Pour en savoir plus sur les produits principaux et les variantes, consultez la section Niveaux de produit. Le filtrage Primary only ou Variant only n'est pas pris en charge.

IN_STOCK est la seule valeur d'attribut availability compatible avec la version 2 du filtrage des recommandations.

Les attributs liés à l'inventaire peuvent être utilisés dans les clauses AND, mais pas dans les clauses OR.

Champs pris en charge

Le tableau suivant récapitule les champs textuels acceptés.

L'optimisation/l'oubli des recommandations est compatible avec des champs supplémentaires qui ne sont pas acceptés par le filtrage standard des recommandations. Pour obtenir la liste des champs supplémentaires compatibles avec la mise en avant/l'oubli pour les recommandations, consultez la section Champs compatibles avec la mise en avant/l'oubli.

Champs compatibles avec le boosting/la rétrogradation

La fonctionnalité Boost/Bury accepte certains champs supplémentaires qui ne sont pas acceptés par le filtrage standard des recommandations, y compris les champs numériques.

En plus des champs listés dans Champs compatibles, la fonctionnalité de mise en avant/d'oubli pour les recommandations accepte les champs suivants:

Champs textuels

Champs numériques

Définir le filtrage des recommandations pour un modèle

Vous pouvez activer le filtrage des recommandations à l'aide de la console de recherche pour le commerce ou de la ressource de l'API Models.

Dans la console, vous pouvez créer un modèle avec le filtrage des recommandations activé. Vous pouvez également modifier cette option pour les modèles existants.

À l'aide de la ressource d'API Models, vous pouvez créer un modèle avec le filtrage des recommandations activé ou mettre à jour ce paramètre pour un modèle existant à l'aide de models.Patch.

Notez que si la correspondance de catégorie est activée dans la configuration de diffusion qui renvoie les prédictions, le filtrage ne fonctionne pas avec l'attribut "categories", car la réponse ne renvoie que les résultats de produits qui partagent une catégorie avec le produit de contexte.

Définir le filtrage d'un modèle à l'aide de la console

Dans la console Search for Retail, sélectionnez l'option Générer automatiquement des balises lors de la création du modèle pour permettre le filtrage des recommandations pour ce modèle.

Vérifiez la compatibilité avec d'autres paramètres tels que diversity-level et category-match-level, etc., car les effets totaux se combinent et le filtrage se produit en dernier.

• Par exemple, la combinaison de diversity-level et de category attribute filtering basés sur des règles entraîne souvent une sortie vide.
  • diversity-level=high-diversity force le modèle à limiter le nombre maximal de résultats pour les mêmes chaînes de catégorie. Par exemple, un résultat pour la catégorie 1, un résultat pour la catégorie 2, etc.
  • Le filtrage des attributs à l'aide des métadonnées de catégorie (Product.categories = ANY ("category2")) entraîne le rejet des éléments qui ne correspondent pas.
  • Le résultat final comporte moins de trois résultats.
• Pour le modèle similar-items, il contient déjà une amélioration supplémentaire de la pertinence des catégories avec le category-match-level = relaxed-category-match par défaut. Passez à category-match-level=no-category-match pour désactiver ce comportement et utiliser des règles de filtrage personnalisées.

Pour savoir comment créer un modèle de recommandation à l'aide de la console, consultez la section Créer des modèles de recommandation.

Vous ne pouvez pas modifier ce paramètre dans la console pour les modèles existants. Pour mettre à jour ce paramètre pour un modèle, utilisez la méthode API models.Patch.

Définir le filtrage pour un modèle à l'aide de l'API

Vous pouvez activer le filtrage des recommandations pour un modèle à l'aide de models.Create lorsque vous créez un modèle ou de models.Patch lorsque vous mettez à jour un modèle existant.

Pour autoriser le filtrage, définissez le champ filteringOption pour votre modèle. Les valeurs autorisées pour ce champ sont les suivantes:

• RECOMMENDATIONS_FILTERING_DISABLED (par défaut): le filtrage est désactivé pour le modèle.
• RECOMMENDATIONS_FILTERING_ENABLED: le filtrage est activé pour les produits principaux.

L'exemple curl suivant crée un modèle avec le filtrage des recommandations activé.

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -H "X-Goog-User-Project: PROJECT_NUMBER" \
     --data "{
       'name': 'MODEL_NAME',
       'displayName': 'MODEL_DISPLAY_NAME',
       'type': 'home-page',
       'filteringOption': 'RECOMMENDATIONS_FILTERING_ENABLED',
     }" \
     "https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/models"

L'exemple curl suivant met à jour le paramètre d'option de filtrage d'un modèle existant.

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -H "X-Goog-User-Project: PROJECT_NUMBER" \
     --data "{
       'filteringOption': 'RECOMMENDATIONS_FILTERING_ENABLED',
     }" \
     "https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/models/MODEL_ID?updateMask=filteringOption"

Définir des attributs comme filtrables

Pour filtrer les produits recommandés, activez le filtrage pour les attributs de produit que vous utiliserez dans les expressions de filtre. Vous pouvez modifier ce paramètre à l'aide de la console de recherche pour le commerce ou de la ressource de l'API Attributes.

Ne faites pas de filtres plus que nécessaire. Le nombre d'attributs filtrables est limité.

Définir des attributs comme filtrables à l'aide de la console

Vous pouvez définir un attribut comme filtrable sur la page "Contrôles" de la console Retail Search.

1. Accédez à la page Commandes dans la console de la recherche pour les marchands.
   
   Accéder à la page "Contrôles"

2. Accédez à l'onglet Commandes d'attribut.

   Cet onglet affiche un tableau de tous les attributs de produit pour lesquels vous pouvez définir des contrôles à l'échelle du site.

3. Cliquez sur editModifier les contrôles.

4. Définissez Filtrable sur True pour l'attribut produit.

5. Cliquez sur Enregistrer les contrôles.

Vous pouvez commencer à utiliser l'attribut pour le filtrage une fois le prochain cycle d'entraînement du modèle terminé.

Définir des attributs comme filtrables à l'aide de l'API

AttributesConfig représente une liste d'attributs pour un catalogue.

Définissez le champ AttributesConfig.filteringOption pour CatalogAttribute. Les valeurs autorisées pour ce champ sont les suivantes:

• RECOMMENDATIONS_FILTERING_DISABLED (par défaut): le filtrage est désactivé pour l'attribut.
• RECOMMENDATIONS_FILTERING_ENABLED: le filtrage est activé pour l'attribut.

L'exemple curl suivant interroge vos attributs de produit existants.

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -H "X-Goog-User-Project: PROJECT_NUMBER" \ "https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/attributesConfig"

L'exemple curl suivant définit l'attribut produit categories comme filtrable.

Lorsque vous modifiez un attribut existant, conservez les valeurs d'origine de l'attribut pour indexableOption, dynamicFacetableOption et searchableOption telles qu'elles apparaissent à l'étape précédente. Si l'attribut de votre choix ne s'est pas affiché lorsque vous avez consulté attributesConfig comme dans l'exemple précédent, utilisez les paramètres par défaut, comme illustré dans l'exemple suivant.

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -H "X-Goog-User-Project: PROJECT_NUMBER" \
     --data "{
        'name': 'projects/PROJECT_NUMBER/locations/global/catalogs/default_catalog/attributesConfig',
        'catalogAttributes': {
          'categories': {
            'key': 'categories',
            'indexableOption': 'INDEXABLE_ENABLED',
            'dynamicFacetableOption': 'DYNAMIC_FACETABLE_DISABLED',
            'searchableOption': 'SEARCHABLE_DISABLED',
            'recommendationsFilteringOption': 'RECOMMENDATIONS_FILTERING_ENABLED'
          }
        },
        'attributeConfigLevel': 'CATALOG_LEVEL_ATTRIBUTE_CONFIG'
     }" \
"https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/attributesConfig"

Vous pouvez commencer à utiliser l'attribut pour le filtrage une fois le prochain cycle d'entraînement du modèle terminé. Cette opération prend généralement au moins huit heures.

Utiliser des attributs filtrables dans une requête de prédiction

Une fois votre modèle réentraîné, vous pouvez utiliser des attributs de produits filtrables dans vos requêtes de prédiction.

Définissez la valeur du paramètre de requête filterSyntaxV2 sur "true" pour activer le filtrage des recommandations de la version 2. Si le paramètre n'est pas défini, le filtrage de la version 1 reste actif. Si un modèle comporte à la fois des balises créées manuellement et des attributs de produit filtrables, il peut répondre aux requêtes de prédiction à l'aide de l'une ou l'autre version de filtrage. Toutefois, vous ne pouvez pas inclure à la fois des expressions de filtrage v1 et v2 dans la même requête de prédiction.

L'exemple de curl partiel suivant montre filterSyntaxV2 défini sur "true" et une expression de filtre utilisant les attributs de produit colors et categories. Cet exemple suppose que colors et categories sont définis comme filtrables.

"params": {
  "filterSyntaxV2": true
},
"filter": "(categories: ANY(\"Phone > Android > Pixel\") OR colors: ANY(\"red\", \"green\")) AND (availability: ANY(\"IN_STOCK\"))"

L'exemple curl suivant montre une requête de prédiction complète.

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -H "X-Goog-User-Project: PROJECT_NUMBER" \
     --data "{
        'userEvent': {
          'eventType': 'detail-page-view',
          'visitorId': 'VISITOR_ID',
          'productDetails': {
            'product': {
              'id': 'PRODUCT_ID'
            }
          }
        },
        'params': {
          'returnProduct': true,
          'filterSyntaxV2': true,
          'strictFiltering': true,
        },
        'filter': 'categories: ANY(\"xyz\")'
     }" \
     "https://retail.googleapis.com/v2/projects/PROJECT_ID/locations/global/catalogs/default_catalog/placements/SERVING_CONFIG:predict"

En plus des filtres, le paramètre de diversification de la configuration de diffusion peut également affecter le nombre de résultats renvoyés par la réponse.