Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class MediaRecommendationEngineConfig.
Additional config specs for a Media Recommendation engine.
Generated from protobuf message google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig
Namespace
Google \ Cloud \ DiscoveryEngine \ V1 \ EngineMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ type |
string
Required. The type of engine. e.g., |
↳ optimization_objective |
string
The optimization objective. e.g., |
↳ optimization_objective_config |
MediaRecommendationEngineConfig\OptimizationObjectiveConfig
Name and value of the custom threshold for cvr optimization_objective. For target_field |
↳ training_state |
int
The training state that the engine is in (e.g. |
↳ engine_features_config |
MediaRecommendationEngineConfig\EngineFeaturesConfig
Optional. Additional engine features config. |
getType
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 | |
|---|---|
| Type | Description |
string |
|
setType
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOptimizationObjective
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 | |
|---|---|
| Type | Description |
string |
|
setOptimizationObjective
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
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOptimizationObjectiveConfig
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).
| Returns | |
|---|---|
| Type | Description |
MediaRecommendationEngineConfig\OptimizationObjectiveConfig|null |
|
hasOptimizationObjectiveConfig
clearOptimizationObjectiveConfig
setOptimizationObjectiveConfig
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).
| Parameter | |
|---|---|
| Name | Description |
var |
MediaRecommendationEngineConfig\OptimizationObjectiveConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrainingState
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 | |
|---|---|
| Type | Description |
int |
|
setTrainingState
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEngineFeaturesConfig
Optional. Additional engine features config.
| Returns | |
|---|---|
| Type | Description |
MediaRecommendationEngineConfig\EngineFeaturesConfig|null |
|
hasEngineFeaturesConfig
clearEngineFeaturesConfig
setEngineFeaturesConfig
Optional. Additional engine features config.
| Parameter | |
|---|---|
| Name | Description |
var |
MediaRecommendationEngineConfig\EngineFeaturesConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|