Additional config specs for a Media Recommendation engine.
Attributes
Name
Description
type_
str
Required. The type of engine. e.g., recommended-for-you.
This field together with
optimization_objective][Engine.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
str
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 => ctrothers-you-may-like => ctr
optimization_objective_config
google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig.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
google.cloud.discoveryengine_v1alpha.types.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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Class MediaRecommendationEngineConfig (0.13.11)\n\nVersion latestkeyboard_arrow_down\n\n- [0.13.11 (latest)](/python/docs/reference/discoveryengine/latest/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.13.10](/python/docs/reference/discoveryengine/0.13.10/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.12.3](/python/docs/reference/discoveryengine/0.12.3/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.11.14](/python/docs/reference/discoveryengine/0.11.14/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.10.0](/python/docs/reference/discoveryengine/0.10.0/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.9.1](/python/docs/reference/discoveryengine/0.9.1/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.8.1](/python/docs/reference/discoveryengine/0.8.1/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.7.0](/python/docs/reference/discoveryengine/0.7.0/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.6.0](/python/docs/reference/discoveryengine/0.6.0/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.5.0](/python/docs/reference/discoveryengine/0.5.0/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.4.1](/python/docs/reference/discoveryengine/0.4.1/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.3.1](/python/docs/reference/discoveryengine/0.3.1/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.2.1](/python/docs/reference/discoveryengine/0.2.1/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig)\n- [0.1.1](/python/docs/reference/discoveryengine/0.1.1/google.cloud.discoveryengine_v1alpha.types.Engine.MediaRecommendationEngineConfig) \n\n MediaRecommendationEngineConfig(\n mapping=None, *, ignore_unknown_fields=False, **kwargs\n )\n\nAdditional config specs for a Media Recommendation engine.\n\nClasses\n-------\n\n### OptimizationObjectiveConfig\n\n OptimizationObjectiveConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nCustom threshold for `cvr` optimization_objective.\n\n### TrainingState\n\n TrainingState(value)\n\nThe training state of the engine."]]