Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb
Overview
Additional config specs for a Media Recommendation engine.
Instance Attribute Summary collapse
-
#optimization_objective ⇒ String
The optimization objective.
-
#optimization_objective_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
Custom threshold for
cvr
optimization_objective. -
#training_state ⇒ String
The training state that the engine is in (e.g.
TRAINING
orPAUSED
). -
#type ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig
Returns a new instance of GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig.
11075 11076 11077 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11075 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
11050 11051 11052 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11050 def optimization_objective @optimization_objective end |
#optimization_objective_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig
Custom threshold for cvr
optimization_objective.
Corresponds to the JSON property optimizationObjectiveConfig
11055 11056 11057 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11055 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
11065 11066 11067 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11065 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
11073 11074 11075 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11073 def type @type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
11080 11081 11082 11083 11084 11085 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 11080 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 |