public sealed class Engine.Types.MediaRecommendationEngineConfig : IMessage<Engine.Types.MediaRecommendationEngineConfig>, IEquatable<Engine.Types.MediaRecommendationEngineConfig>, IDeepCloneable<Engine.Types.MediaRecommendationEngineConfig>, IBufferMessage, IMessage
Reference documentation and code samples for the Discovery Engine v1 API class Engine.Types.MediaRecommendationEngineConfig.
Additional config specs for a Media Recommendation engine.
Implements
IMessageEngineTypesMediaRecommendationEngineConfig, IEquatableEngineTypesMediaRecommendationEngineConfig, IDeepCloneableEngineTypesMediaRecommendationEngineConfig, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
MediaRecommendationEngineConfig()
public MediaRecommendationEngineConfig()
MediaRecommendationEngineConfig(MediaRecommendationEngineConfig)
public MediaRecommendationEngineConfig(Engine.Types.MediaRecommendationEngineConfig other)
Parameter | |
---|---|
Name | Description |
other |
EngineTypesMediaRecommendationEngineConfig |
Properties
EngineFeaturesConfig
public Engine.Types.MediaRecommendationEngineConfig.Types.EngineFeaturesConfig EngineFeaturesConfig { get; set; }
Optional. Additional engine features config.
Property Value | |
---|---|
Type | Description |
EngineTypesMediaRecommendationEngineConfigTypesEngineFeaturesConfig |
OptimizationObjective
public string OptimizationObjective { get; set; }
The optimization objective. e.g., cvr
.
This field together with [optimization_objective][google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.type] 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
Property Value | |
---|---|
Type | Description |
string |
OptimizationObjectiveConfig
public Engine.Types.MediaRecommendationEngineConfig.Types.OptimizationObjectiveConfig OptimizationObjectiveConfig { get; set; }
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).
Property Value | |
---|---|
Type | Description |
EngineTypesMediaRecommendationEngineConfigTypesOptimizationObjectiveConfig |
TrainingState
public Engine.Types.MediaRecommendationEngineConfig.Types.TrainingState TrainingState { get; set; }
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.
Property Value | |
---|---|
Type | Description |
EngineTypesMediaRecommendationEngineConfigTypesTrainingState |
Type
public string Type { get; set; }
Required. The type of engine. e.g., recommended-for-you
.
This field together with [optimization_objective][google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.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
.
Property Value | |
---|---|
Type | Description |
string |