Reference documentation and code samples for the Google Cloud Retail V2 Client class Model.
Metadata that describes the training and serving parameters of a Model . A Model can be associated with a ServingConfig and then queried through the Predict API.
Generated from protobuf message google.cloud.retail.v2.Model
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The fully qualified resource name of the model. Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}
catalog_id has char limit of 50. recommendation_model_id has char limit of 40.
↳ display_name
string
Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
↳ training_state
int
Optional. The training state that the model 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 model in order to control cost. If not specified: the default value for CreateModel
method is TRAINING
. The default value for UpdateModel
method is to keep the state the same as before.
↳ serving_state
int
Output only. The serving state of the model: ACTIVE
, NOT_ACTIVE
.
↳ create_time
↳ update_time
Google\Protobuf\Timestamp
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
↳ type
string
Required. The type of model e.g. home-page
. Currently supported values: recommended-for-you
, others-you-may-like
, frequently-bought-together
, page-optimization
, similar-items
, buy-it-again
, on-sale-items
, and recently-viewed
(readonly value). This field together with optimization_objective
describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models
for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = frequently-bought-together
and optimization_objective = ctr
), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
↳ optimization_objective
string
Optional. The optimization objective e.g. cvr
. Currently supported values: ctr
, cvr
, revenue-per-order
. If not specified, we choose default based on model type. Default depends on type of recommendation: recommended-for-you
=> ctr
others-you-may-like
=> ctr
frequently-bought-together
=> revenue_per_order
This field together with optimization_objective
describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models
for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = frequently-bought-together
and optimization_objective = ctr
), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
↳ periodic_tuning_state
int
Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the TuneModel
method. Default value is PERIODIC_TUNING_ENABLED
.
↳ last_tune_time
↳ tuning_operation
string
Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
↳ data_state
int
Output only. The state of data requirements for this model: DATA_OK
and DATA_ERROR
. Recommendation model cannot be trained if the data is in DATA_ERROR
state. Recommendation model can have DATA_ERROR
state even if serving state is ACTIVE
: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
↳ filtering_option
int
Optional. If RECOMMENDATIONS_FILTERING_ENABLED
, recommendation filtering by attributes is enabled for the model.
↳ serving_config_lists
array< Google\Cloud\Retail\V2\Model\ServingConfigList
>
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
getName
Required. The fully qualified resource name of the model.
Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}
catalog_id has char limit of 50.
recommendation_model_id has char limit of 40.
string
setName
Required. The fully qualified resource name of the model.
Format: projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}
catalog_id has char limit of 50.
recommendation_model_id has char limit of 40.
var
string
$this
getDisplayName
Required. The display name of the model.
Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
string
setDisplayName
Required. The display name of the model.
Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
var
string
$this
getTrainingState
Optional. The training state that the model 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
model in order to control cost. If not specified: the default value for CreateModel
method is TRAINING
. The default value for UpdateModel
method is to keep the state the same as before.
int
setTrainingState
Optional. The training state that the model 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
model in order to control cost. If not specified: the default value for CreateModel
method is TRAINING
. The default value for UpdateModel
method is to keep the state the same as before.
var
int
$this
getServingState
Output only. The serving state of the model: ACTIVE
, NOT_ACTIVE
.
int
setServingState
Output only. The serving state of the model: ACTIVE
, NOT_ACTIVE
.
var
int
$this
getCreateTime
Output only. Timestamp the Recommendation Model was created at.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp the Recommendation Model was created at.
$this
getUpdateTime
Output only. Timestamp the Recommendation Model was last updated. E.g.
if a Recommendation Model was paused - this would be the time the pause was initiated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp the Recommendation Model was last updated. E.g.
if a Recommendation Model was paused - this would be the time the pause was initiated.
$this
getType
Required. The type of model e.g. home-page
.
Currently supported values: recommended-for-you
, others-you-may-like
, frequently-bought-together
, page-optimization
, similar-items
, buy-it-again
, on-sale-items
, and recently-viewed
(readonly value).
This field together with optimization_objective
describe model metadata to use to control model training and serving.
See https://cloud.google.com/retail/docs/models
for more details on what the model metadata control and which combination
of parameters are valid. For invalid combinations of parameters (e.g. type
= frequently-bought-together
and optimization_objective = ctr
), you
receive an error 400 if you try to create/update a recommendation with
this set of knobs.
string
setType
Required. The type of model e.g. home-page
.
Currently supported values: recommended-for-you
, others-you-may-like
, frequently-bought-together
, page-optimization
, similar-items
, buy-it-again
, on-sale-items
, and recently-viewed
(readonly value).
This field together with optimization_objective
describe model metadata to use to control model training and serving.
See https://cloud.google.com/retail/docs/models
for more details on what the model metadata control and which combination
of parameters are valid. For invalid combinations of parameters (e.g. type
= frequently-bought-together
and optimization_objective = ctr
), you
receive an error 400 if you try to create/update a recommendation with
this set of knobs.
var
string
$this
getOptimizationObjective
Optional. The optimization objective e.g. cvr
.
Currently supported
values: ctr
, cvr
, revenue-per-order
.
If not specified, we choose default based on model type.
Default depends on type of recommendation: recommended-for-you
=> ctr
others-you-may-like
=> ctr
frequently-bought-together
=> revenue_per_order
This field together with optimization_objective
describe model metadata to use to control model training and serving.
See https://cloud.google.com/retail/docs/models
for more details on what the model metadata control and which combination
of parameters are valid. For invalid combinations of parameters (e.g. type
= frequently-bought-together
and optimization_objective = ctr
), you
receive an error 400 if you try to create/update a recommendation with
this set of knobs.
string
setOptimizationObjective
Optional. The optimization objective e.g. cvr
.
Currently supported
values: ctr
, cvr
, revenue-per-order
.
If not specified, we choose default based on model type.
Default depends on type of recommendation: recommended-for-you
=> ctr
others-you-may-like
=> ctr
frequently-bought-together
=> revenue_per_order
This field together with optimization_objective
describe model metadata to use to control model training and serving.
See https://cloud.google.com/retail/docs/models
for more details on what the model metadata control and which combination
of parameters are valid. For invalid combinations of parameters (e.g. type
= frequently-bought-together
and optimization_objective = ctr
), you
receive an error 400 if you try to create/update a recommendation with
this set of knobs.
var
string
$this
getPeriodicTuningState
Optional. The state of periodic tuning.
The period we use is 3 months - to do a
one-off tune earlier use the TuneModel
method. Default value
is PERIODIC_TUNING_ENABLED
.
int
setPeriodicTuningState
Optional. The state of periodic tuning.
The period we use is 3 months - to do a
one-off tune earlier use the TuneModel
method. Default value
is PERIODIC_TUNING_ENABLED
.
var
int
$this
getLastTuneTime
Output only. The timestamp when the latest successful tune finished.
hasLastTuneTime
clearLastTuneTime
setLastTuneTime
Output only. The timestamp when the latest successful tune finished.
$this
getTuningOperation
Output only. The tune operation associated with the model.
Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
string
setTuningOperation
Output only. The tune operation associated with the model.
Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
var
string
$this
getDataState
Output only. The state of data requirements for this model: DATA_OK
and DATA_ERROR
.
Recommendation model cannot be trained if the data is in DATA_ERROR
state. Recommendation model can have DATA_ERROR
state even
if serving state is ACTIVE
: models were trained successfully before, but
cannot be refreshed because model no longer has sufficient
data for training.
int
setDataState
Output only. The state of data requirements for this model: DATA_OK
and DATA_ERROR
.
Recommendation model cannot be trained if the data is in DATA_ERROR
state. Recommendation model can have DATA_ERROR
state even
if serving state is ACTIVE
: models were trained successfully before, but
cannot be refreshed because model no longer has sufficient
data for training.
var
int
$this
getFilteringOption
Optional. If RECOMMENDATIONS_FILTERING_ENABLED
, recommendation filtering
by attributes is enabled for the model.
int
setFilteringOption
Optional. If RECOMMENDATIONS_FILTERING_ENABLED
, recommendation filtering
by attributes is enabled for the model.
var
int
$this
getServingConfigLists
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
setServingConfigLists
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
$this
