Retail v2 API - Class Model (2.9.0) 

public sealed class Model : IMessage<Model>, IEquatable<Model>, IDeepCloneable<Model>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class Model.

Metadata that describes the training and serving parameters of a [Model][google.cloud.retail.v2.Model]. A [Model][google.cloud.retail.v2.Model] can be associated with a [ServingConfig][google.cloud.retail.v2.ServingConfig] and then queried through the Predict API.

Inheritance

object > Model

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

Model()

public Model()

Model(Model)

public Model(Model other)
Parameter
Name Description
other Model

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp the Recommendation Model was created at.

Property Value
Type Description
Timestamp

DataState

public Model.Types.DataState DataState { get; set; }

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.

Property Value
Type Description
ModelTypesDataState

DisplayName

public string DisplayName { get; set; }

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.

Property Value
Type Description
string

FilteringOption

public RecommendationsFilteringOption FilteringOption { get; set; }

Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model.

Property Value
Type Description
RecommendationsFilteringOption

LastTuneTime

public Timestamp LastTuneTime { get; set; }

Output only. The timestamp when the latest successful tune finished.

Property Value
Type Description
Timestamp

ModelName

public ModelName ModelName { get; set; }

ModelName-typed view over the Name resource name property.

Property Value
Type Description
ModelName

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

OptimizationObjective

public string OptimizationObjective { get; set; }

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][google.cloud.retail.v2.Model.type] 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.

Property Value
Type Description
string

PeriodicTuningState

public Model.Types.PeriodicTuningState PeriodicTuningState { get; set; }

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.

Property Value
Type Description
ModelTypesPeriodicTuningState

ServingConfigLists

public RepeatedField<Model.Types.ServingConfigList> ServingConfigLists { get; }

Output only. The list of valid serving configs associated with the PageOptimizationConfig.

Property Value
Type Description
RepeatedFieldModelTypesServingConfigList

ServingState

public Model.Types.ServingState ServingState { get; set; }

Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.

Property Value
Type Description
ModelTypesServingState

TrainingState

public Model.Types.TrainingState TrainingState { get; set; }

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.

Property Value
Type Description
ModelTypesTrainingState

TuningOperation

public string TuningOperation { get; set; }

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.

Property Value
Type Description
string

Type

public string Type { get; set; }

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][google.cloud.retail.v2.Model.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.

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

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.

Property Value
Type Description
Timestamp