Class: Google::Apis::RetailV2::GoogleCloudRetailV2alphaModel

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaModel

Returns a new instance of GoogleCloudRetailV2alphaModel.



4254
4255
4256
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4254

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#create_time ⇒ String

Output only. Timestamp the Recommendation Model was created at. Corresponds to the JSON property createTime

Returns:

  • (String) 


4158
4159
4160
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4158

def create_time
  @create_time
end

#data_state ⇒ String

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. Corresponds to the JSON property dataState

Returns:

  • (String) 


4167
4168
4169
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4167

def data_state
  @data_state
end

#display_name ⇒ String

Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Pantheon Dashboard. UTF-8 encoded string with limit of 1024 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


4174
4175
4176
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4174

def display_name
  @display_name
end

#filtering_option ⇒ String

Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering by attributes is enabled for the model. Corresponds to the JSON property filteringOption

Returns:

  • (String) 


4180
4181
4182
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4180

def filtering_option
  @filtering_option
end

#last_tune_time ⇒ String

Output only. The timestamp when the latest successful tune finished. Corresponds to the JSON property lastTuneTime

Returns:

  • (String) 


4185
4186
4187
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4185

def last_tune_time
  @last_tune_time
end

#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. Corresponds to the JSON property name

Returns:

  • (String) 


4192
4193
4194
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4192

def name
  @name
end

#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 Corresponds to the JSON property optimizationObjective

Returns:

  • (String) 


4201
4202
4203
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4201

def optimization_objective
  @optimization_objective
end

#page_optimization_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2alphaModelPageOptimizationConfig

The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configurations to consider for each panel. The purpose of this model is to optimize which ServingConfig to show on which panels in way that optimizes the visitors shopping journey. Corresponds to the JSON property pageOptimizationConfig

Returns:



4209
4210
4211
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4209

def page_optimization_config
  @page_optimization_config
end

#periodic_tuning_state ⇒ String

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. Corresponds to the JSON property periodicTuningState

Returns:

  • (String) 


4216
4217
4218
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4216

def periodic_tuning_state
  @periodic_tuning_state
end

#serving_state ⇒ String

Output only. The serving state of the model: ACTIVE, NOT_ACTIVE. Corresponds to the JSON property servingState

Returns:

  • (String) 


4221
4222
4223
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4221

def serving_state
  @serving_state
end

#training_state ⇒ String

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. Corresponds to the JSON property trainingState

Returns:

  • (String) 


4230
4231
4232
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4230

def training_state
  @training_state
end

#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. Corresponds to the JSON property tuningOperation

Returns:

  • (String) 


4237
4238
4239
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4237

def tuning_operation
  @tuning_operation
end

#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', recently-viewed( readonly value). Corresponds to the JSON property type

Returns:

  • (String) 


4245
4246
4247
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4245

def type
  @type
end

#update_time ⇒ String

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. Corresponds to the JSON property updateTime

Returns:

  • (String) 


4252
4253
4254
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4252

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
 
# File 'lib/google/apis/retail_v2/classes.rb', line 4259

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_state = args[:data_state] if args.key?(:data_state)
  @display_name = args[:display_name] if args.key?(:display_name)
  @filtering_option = args[:filtering_option] if args.key?(:filtering_option)
  @last_tune_time = args[:last_tune_time] if args.key?(:last_tune_time)
  @name = args[:name] if args.key?(:name)
  @optimization_objective = args[:optimization_objective] if args.key?(:optimization_objective)
  @page_optimization_config = args[:page_optimization_config] if args.key?(:page_optimization_config)
  @periodic_tuning_state = args[:periodic_tuning_state] if args.key?(:periodic_tuning_state)
  @serving_state = args[:serving_state] if args.key?(:serving_state)
  @training_state = args[:training_state] if args.key?(:training_state)
  @tuning_operation = args[:tuning_operation] if args.key?(:tuning_operation)
  @type = args[:type] if args.key?(:type)
  @update_time = args[:update_time] if args.key?(:update_time)
end