Class GoogleCloudRetailV2Model

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.

Inheritance
object
GoogleCloudRetailV2Model
Implements
Inherited Members
Namespace: Google.Apis.CloudRetail.v2.Data
Assembly: Google.Apis.CloudRetail.v2.dll
Syntax
public class GoogleCloudRetailV2Model : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp the Recommendation Model was created at.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DataState

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.

Declaration
[JsonProperty("dataState")]
public virtual string DataState { get; set; }
Property Value
Type Description
string

DisplayName

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.

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

FilteringOption

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

Declaration
[JsonProperty("filteringOption")]
public virtual string FilteringOption { get; set; }
Property Value
Type Description
string

LastTuneTime

object representation of LastTuneTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastTuneTimeDateTimeOffset instead.")]
public virtual object LastTuneTime { get; set; }
Property Value
Type Description
object

LastTuneTimeDateTimeOffset

DateTimeOffset representation of LastTuneTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastTuneTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

LastTuneTimeRaw

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

Declaration
[JsonProperty("lastTuneTime")]
public virtual string LastTuneTimeRaw { get; set; }
Property Value
Type Description
string

ModelFeaturesConfig

Optional. Additional model features config.

Declaration
[JsonProperty("modelFeaturesConfig")]
public virtual GoogleCloudRetailV2ModelModelFeaturesConfig ModelFeaturesConfig { get; set; }
Property Value
Type Description
GoogleCloudRetailV2ModelModelFeaturesConfig

Name

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.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

OptimizationObjective

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.

Declaration
[JsonProperty("optimizationObjective")]
public virtual string OptimizationObjective { get; set; }
Property Value
Type Description
string

PeriodicTuningState

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.

Declaration
[JsonProperty("periodicTuningState")]
public virtual string PeriodicTuningState { get; set; }
Property Value
Type Description
string

ServingConfigLists

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

Declaration
[JsonProperty("servingConfigLists")]
public virtual IList<GoogleCloudRetailV2ModelServingConfigList> ServingConfigLists { get; set; }
Property Value
Type Description
IList<GoogleCloudRetailV2ModelServingConfigList>

ServingState

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

Declaration
[JsonProperty("servingState")]
public virtual string ServingState { get; set; }
Property Value
Type Description
string

TrainingState

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.

Declaration
[JsonProperty("trainingState")]
public virtual string TrainingState { get; set; }
Property Value
Type Description
string

TuningOperation

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.

Declaration
[JsonProperty("tuningOperation")]
public virtual string TuningOperation { get; set; }
Property Value
Type Description
string

Type

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.

Declaration
[JsonProperty("type")]
public virtual string Type { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

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.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements