Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModel

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2alpha/classes.rb,
lib/google/apis/retail_v2alpha/representations.rb,
lib/google/apis/retail_v2alpha/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.



3778
3779
3780
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3778

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) 


3658
3659
3660
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3658

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) 


3667
3668
3669
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3667

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 Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


3674
3675
3676
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3674

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) 


3680
3681
3682
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3680

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) 


3685
3686
3687
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3685

def last_tune_time
  @last_tune_time
end

#model_features_config ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelModelFeaturesConfig

Additional model features config. Corresponds to the JSON property modelFeaturesConfig

Returns:



3690
3691
3692
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3690

def model_features_config
  @model_features_config
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) 


3698
3699
3700
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3698

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

Returns:

  • (String) 


3713
3714
3715
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3713

def optimization_objective
  @optimization_objective
end

#page_optimization_config ⇒ Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelPageOptimizationConfig

The PageOptimizationConfig for model training. This determines how many panels to optimize for, and which serving configs 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:



3721
3722
3723
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3721

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) 


3728
3729
3730
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3728

def periodic_tuning_state
  @periodic_tuning_state
end

#serving_config_lists ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaModelServingConfigList>

Output only. The list of valid serving configs associated with the PageOptimizationConfig. Corresponds to the JSON property servingConfigLists

Returns:



3734
3735
3736
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3734

def serving_config_lists
  @serving_config_lists
end

#serving_state ⇒ String

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

Returns:

  • (String) 


3739
3740
3741
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3739

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) 


3748
3749
3750
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3748

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) 


3755
3756
3757
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3755

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

Returns:

  • (String) 


3769
3770
3771
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3769

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) 


3776
3777
3778
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3776

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 3783

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)
  @model_features_config = args[:model_features_config] if args.key?(:model_features_config)
  @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_config_lists = args[:serving_config_lists] if args.key?(:serving_config_lists)
  @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