Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig (v2.3.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig.

Additional config specs for a Media Recommendation engine.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#engine_features_config

def engine_features_config() -> ::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig
Returns

#engine_features_config=

def engine_features_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig
Parameter
Returns

#optimization_objective

def optimization_objective() -> ::String
Returns
  • (::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=

def optimization_objective=(value) -> ::String
Parameter
  • value (::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

Returns
  • (::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

def optimization_objective_config() -> ::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig
Returns

#optimization_objective_config=

def optimization_objective_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig
Parameter
Returns

#training_state

def training_state() -> ::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState
Returns
  • (::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::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.

#training_state=

def training_state=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::TrainingState
Parameter
  • value (::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::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.

Returns
  • (::Google::Cloud::DiscoveryEngine::V1::Engine::MediaRecommendationEngineConfig::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.

#type

def type() -> ::String
Returns
  • (::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.

#type=

def type=(value) -> ::String
Parameter
  • value (::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.

Returns
  • (::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.