Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb

Overview

Additional config specs for a Media Recommendation engine.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig

Returns a new instance of GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig.



2990
2991
2992
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2990

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#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 Corresponds to the JSON property optimizationObjective

Returns:

  • (String) 


2965
2966
2967
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2965

def optimization_objective
  @optimization_objective
end

#optimization_objective_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig

Custom threshold for cvr optimization_objective. Corresponds to the JSON property optimizationObjectiveConfig

Returns:



2970
2971
2972
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2970

def optimization_objective_config
  @optimization_objective_config
end

#training_state ⇒ String

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. Corresponds to the JSON property trainingState

Returns:

  • (String) 


2980
2981
2982
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2980

def training_state
  @training_state
end

#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. Corresponds to the JSON property type

Returns:

  • (String) 


2988
2989
2990
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2988

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2995
2996
2997
2998
2999
3000
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2995

def update!(**args)
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
  @optimization_objective_config = args[:optimization_objective_config] if args.key?(:optimization_objective_config)
  @training_state = args[:training_state] if args.key?(:training_state)
  @type = args[:type] if args.key?(:type)
end