Struct MediaRecommendationEngineConfig 

#[non_exhaustive]
pub struct MediaRecommendationEngineConfig {
    pub type: String,
    pub optimization_objective: String,
    pub optimization_objective_config: Option<OptimizationObjectiveConfig>,
    pub training_state: TrainingState,
    pub engine_features_config: Option<EngineFeaturesConfig>,
    /* private fields */
}

Available on crate feature engine-service only.

Additional config specs for a Media Recommendation engine.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

type: String

Required. The type of engine. e.g., recommended-for-you.

This field together with optimization_objective describe engine metadata to use to control engine training and serving.

Currently supported values: recommended-for-you, others-you-may-like, more-like-this, most-popular-items.

optimization_objective: String

The optimization objective. e.g., cvr.

This field together with optimization_objective describe engine metadata to use to control engine training and serving.

Currently supported values: ctr, cvr.

If not specified, we choose default based on engine type. Default depends on type of recommendation:

recommended-for-you => ctr

others-you-may-like => ctr

optimization_objective_config: Option<OptimizationObjectiveConfig>

Name and value of the custom threshold for cvr optimization_objective. For target_field watch-time, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field watch-percentage, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5).

training_state: TrainingState

The training state that the engine is in (e.g. TRAINING or PAUSED).

Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for CreateEngine method is TRAINING. The default value for UpdateEngine method is to keep the state the same as before.

engine_features_config: Option<EngineFeaturesConfig>

Optional. Additional engine features config.

Implementations

impl MediaRecommendationEngineConfig

pub fn new() -> Self

pub fn set_type<T: Into<String>>(self, v: T) -> Self

Sets the value of r#type.

Example

let x = MediaRecommendationEngineConfig::new().set_type("example");

pub fn set_optimization_objective<T: Into<String>>(self, v: T) -> Self

Sets the value of optimization_objective.

Example

let x = MediaRecommendationEngineConfig::new().set_optimization_objective("example");

pub fn set_optimization_objective_config<T>(self, v: T) -> Self

where T: Into<OptimizationObjectiveConfig>,

Sets the value of optimization_objective_config.

Example

use google_cloud_discoveryengine_v1::model::engine::media_recommendation_engine_config::OptimizationObjectiveConfig;
let x = MediaRecommendationEngineConfig::new().set_optimization_objective_config(OptimizationObjectiveConfig::default()/* use setters */);

pub fn set_or_clear_optimization_objective_config<T>(self, v: Option<T>) -> Self

where T: Into<OptimizationObjectiveConfig>,

Sets or clears the value of optimization_objective_config.

Example

use google_cloud_discoveryengine_v1::model::engine::media_recommendation_engine_config::OptimizationObjectiveConfig;
let x = MediaRecommendationEngineConfig::new().set_or_clear_optimization_objective_config(Some(OptimizationObjectiveConfig::default()/* use setters */));
let x = MediaRecommendationEngineConfig::new().set_or_clear_optimization_objective_config(None::<OptimizationObjectiveConfig>);

pub fn set_training_state<T: Into<TrainingState>>(self, v: T) -> Self

Sets the value of training_state.

Example

use google_cloud_discoveryengine_v1::model::engine::media_recommendation_engine_config::TrainingState;
let x0 = MediaRecommendationEngineConfig::new().set_training_state(TrainingState::Paused);
let x1 = MediaRecommendationEngineConfig::new().set_training_state(TrainingState::Training);

pub fn set_engine_features_config<T>(self, v: T) -> Self

where T: Into<EngineFeaturesConfig>,

Sets the value of engine_features_config.

Example

use google_cloud_discoveryengine_v1::model::engine::media_recommendation_engine_config::EngineFeaturesConfig;
let x = MediaRecommendationEngineConfig::new().set_engine_features_config(EngineFeaturesConfig::default()/* use setters */);

pub fn set_or_clear_engine_features_config<T>(self, v: Option<T>) -> Self

where T: Into<EngineFeaturesConfig>,

Sets or clears the value of engine_features_config.

Example

use google_cloud_discoveryengine_v1::model::engine::media_recommendation_engine_config::EngineFeaturesConfig;
let x = MediaRecommendationEngineConfig::new().set_or_clear_engine_features_config(Some(EngineFeaturesConfig::default()/* use setters */));
let x = MediaRecommendationEngineConfig::new().set_or_clear_engine_features_config(None::<EngineFeaturesConfig>);

Trait Implementations

impl Clone for MediaRecommendationEngineConfig

fn clone(&self) -> MediaRecommendationEngineConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MediaRecommendationEngineConfig

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

Formats the value using the given formatter.

impl Default for MediaRecommendationEngineConfig

fn default() -> MediaRecommendationEngineConfig

Returns the “default value” for a type.

impl Message for MediaRecommendationEngineConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for MediaRecommendationEngineConfig

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for MediaRecommendationEngineConfig