Struct google_api_proto::google::cloud::retail::v2alpha::model::PageOptimizationConfig

pub struct PageOptimizationConfig {
    pub page_optimization_event_type: String,
    pub panels: Vec<Panel>,
    pub restriction: i32,
}

The PageOptimizationConfig for model training.

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

Fields

page_optimization_event_type: String

Required. The type of [UserEvent][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Model.type].

panels: Vec<Panel>

Required. A list of panel configurations.

Limit = 5.

restriction: i32

Optional. How to restrict results across panels e.g. can the same [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] be shown on multiple panels at once.

If unspecified, default to UNIQUE_MODEL_RESTRICTION.

Implementations

impl PageOptimizationConfig

pub fn restriction(&self) -> Restriction

Returns the enum value of restriction, or the default if the field is set to an invalid enum value.

pub fn set_restriction(&mut self, value: Restriction)

Sets restriction to the provided enum value.

Trait Implementations

impl Clone for PageOptimizationConfig

fn clone(&self) -> PageOptimizationConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PageOptimizationConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PageOptimizationConfig

fn default() -> Self

Returns the “default value” for a type.

impl Message for PageOptimizationConfig

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PageOptimizationConfig

fn eq(&self, other: &PageOptimizationConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PageOptimizationConfig