Class PageOptimizationConfig (1.10.0)

PageOptimizationConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The PageOptimizationConfig for model training.

This determines how many panels to optimize for, and which serving configurations to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey.

Attributes

NameDescription
page_optimization_event_type str
Required. The type of UserEvent this page optimization is shown for. Each page has an associated event type - this will be the corresponding event type for the page that the page optimization model is used on. Supported types: - ``add-to-cart``: Products being added to cart. - ``detail-page-view``: Products detail page viewed. - ``home-page-view``: Homepage viewed - ``category-page-view``: Homepage viewed - ``shopping-cart-page-view``: User viewing a shopping cart. ``home-page-view`` only allows models with type ``recommended-for-you``. All other page_optimization_event_type allow all Model.types.
panels Sequence[google.cloud.retail_v2alpha.types.Model.PageOptimizationConfig.Panel]
Required. A list of panel configurations. Limit = 5.
restriction google.cloud.retail_v2alpha.types.Model.PageOptimizationConfig.Restriction
Optional. How to restrict results across panels e.g. can the same ServingConfig be shown on multiple panels at once. If unspecified, default to ``UNIQUE_MODEL_RESTRICTION``.

Inheritance

builtins.object > proto.message.Message > PageOptimizationConfig

Classes

Candidate

Candidate(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A candidate to consider for a given panel. Currently only ServingConfig are valid candidates.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Panel

Panel(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An individual panel with a list of ServingConfigs to consider for it.

Restriction

Restriction(value)

Restrictions of expected returned results.