google-apis-retail_v2 0.62.0 → 0.63.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9e324a6f5306d41a7e392e641c5732433802d42b1e2ab755f89bbefe4f31fcf
-  data.tar.gz: d0b5caa8995e29482f38f2d6920cd21fdeee93a47ccfce26b596361ff4b4bc85
+  metadata.gz: 58dc56bee1093c5aaa2f43ab4052a10878c000f3127f927a9b40c9139c365642
+  data.tar.gz: 7ff126a16b1b10d09686b7a96972aa7f1a3243b59eaf661515a3d5c93ae97cd2
 SHA512:
-  metadata.gz: 8aa16469e510eb29518d359803ce97b5bbc2105e912dbc5bb9ec7415004a94fa5179578bc52fa934617d15000b1d696f939df47f95670274c53bb3b56e3ff459
-  data.tar.gz: 26bd2355b5096960a6b7bddb34f29ee9b75dfda6594b6d04fc04e785e0113d7bec0e576627e01e470586ec85cedd767f401ba3326855d2225ea95abcce2b5a5a
+  metadata.gz: c060be16604fb4631d480cb1962aabb2b58d91426579961675d796847591d82454f49d985f961e821f43b7626704314b5044497c7b4894790e9d7bf96aa4cfde
+  data.tar.gz: 0b193bcfffdbd091b1908444022c9969499eb67cda810f9079bac6d1a817006bed310d12c7397c0305e0278cbe47a46f5fc3431e010a2685a750cc35fd7d1699

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-retail_v2
 
+### v0.63.0 (2023-01-29)
+
+* Regenerated from discovery document revision 20230119
+
 ### v0.62.0 (2023-01-22)
 
 * Regenerated from discovery document revision 20230117

data/lib/google/apis/retail_v2/classes.rb

@@ -1193,6 +1193,27 @@ module Google
         end
       end
       
+      # Metadata associated with a create operation.
+      class GoogleCloudRetailV2CreateModelMetadata
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of the model that this create applies to. Format: `projects/`
+        # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # `
+        # Corresponds to the JSON property `model`
+        # @return [String]
+        attr_accessor :model
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @model = args[:model] if args.key?(:model)
+        end
+      end
+      
       # A custom attribute that is not explicitly modeled in Product.
       class GoogleCloudRetailV2CustomAttribute
         include Google::Apis::Core::Hashable
@@ -1250,6 +1271,62 @@ module Google
         end
       end
       
+      # Metadata for active A/B testing Experiments.
+      class GoogleCloudRetailV2ExperimentInfo
+        include Google::Apis::Core::Hashable
+      
+        # The fully qualified resource name of the experiment that provides the serving
+        # config under test, should an active experiment exist. For example: `projects/*/
+        # locations/global/catalogs/default_catalog/experiments/experiment_id`
+        # Corresponds to the JSON property `experimentName`
+        # @return [String]
+        attr_accessor :experiment_name
+      
+        # Metadata for active serving config A/B tests.
+        # Corresponds to the JSON property `servingConfigExperiment`
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfoServingConfigExperiment]
+        attr_accessor :serving_config_experiment
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @experiment_name = args[:experiment_name] if args.key?(:experiment_name)
+          @serving_config_experiment = args[:serving_config_experiment] if args.key?(:serving_config_experiment)
+        end
+      end
+      
+      # Metadata for active serving config A/B tests.
+      class GoogleCloudRetailV2ExperimentInfoServingConfigExperiment
+        include Google::Apis::Core::Hashable
+      
+        # The fully qualified resource name of the serving config VariantArm.
+        # serving_config_id responsible for generating the search response. For example:
+        # `projects/*/locations/*/catalogs/*/servingConfigs/*`.
+        # Corresponds to the JSON property `experimentServingConfig`
+        # @return [String]
+        attr_accessor :experiment_serving_config
+      
+        # The fully qualified resource name of the original SearchRequest.placement in
+        # the search request prior to reassignment by experiment API. For example: `
+        # projects/*/locations/*/catalogs/*/servingConfigs/*`.
+        # Corresponds to the JSON property `originalServingConfig`
+        # @return [String]
+        attr_accessor :original_serving_config
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @experiment_serving_config = args[:experiment_serving_config] if args.key?(:experiment_serving_config)
+          @original_serving_config = args[:original_serving_config] if args.key?(:original_serving_config)
+        end
+      end
+      
       # Fulfillment information, such as the store IDs for in-store pickup or region
       # IDs for different shipping methods.
       class GoogleCloudRetailV2FulfillmentInfo
@@ -1753,6 +1830,31 @@ module Google
         end
       end
       
+      # Response to a ListModelRequest.
+      class GoogleCloudRetailV2ListModelsResponse
+        include Google::Apis::Core::Hashable
+      
+        # List of Models.
+        # Corresponds to the JSON property `models`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2Model>]
+        attr_accessor :models
+      
+        # Pagination token, if not returned indicates the last page.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @models = args[:models] if args.key?(:models)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+        end
+      end
+      
       # Response message for ProductService.ListProducts method.
       class GoogleCloudRetailV2ListProductsResponse
         include Google::Apis::Core::Hashable
@@ -1857,6 +1959,179 @@ module Google
         end
       end
       
+      # 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.
+      class GoogleCloudRetailV2Model
+        include Google::Apis::Core::Hashable
+      
+        # Output only. Timestamp the Recommendation Model was created at.
+        # Corresponds to the JSON property `createTime`
+        # @return [String]
+        attr_accessor :create_time
+      
+        # 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`
+        # @return [String]
+        attr_accessor :data_state
+      
+        # 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`
+        # @return [String]
+        attr_accessor :display_name
+      
+        # Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by
+        # attributes is enabled for the model.
+        # Corresponds to the JSON property `filteringOption`
+        # @return [String]
+        attr_accessor :filtering_option
+      
+        # Output only. The timestamp when the latest successful tune finished.
+        # Corresponds to the JSON property `lastTuneTime`
+        # @return [String]
+        attr_accessor :last_tune_time
+      
+        # 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`
+        # @return [String]
+        attr_accessor :name
+      
+        # 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`
+        # @return [String]
+        attr_accessor :optimization_objective
+      
+        # 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`
+        # @return [String]
+        attr_accessor :periodic_tuning_state
+      
+        # Output only. The list of valid serving configs associated with the
+        # PageOptimizationConfig.
+        # Corresponds to the JSON property `servingConfigLists`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2ModelServingConfigList>]
+        attr_accessor :serving_config_lists
+      
+        # Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
+        # Corresponds to the JSON property `servingState`
+        # @return [String]
+        attr_accessor :serving_state
+      
+        # 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`
+        # @return [String]
+        attr_accessor :training_state
+      
+        # 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`
+        # @return [String]
+        attr_accessor :tuning_operation
+      
+        # 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`
+        # @return [String]
+        attr_accessor :type
+      
+        # 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`
+        # @return [String]
+        attr_accessor :update_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        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)
+          @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
+      end
+      
+      # Represents an ordered combination of valid serving configs, which can be used
+      # for `PAGE_OPTIMIZATION` recommendations.
+      class GoogleCloudRetailV2ModelServingConfigList
+        include Google::Apis::Core::Hashable
+      
+        # Optional. A set of valid serving configs that may be used for `
+        # PAGE_OPTIMIZATION`.
+        # Corresponds to the JSON property `servingConfigIds`
+        # @return [Array<String>]
+        attr_accessor :serving_config_ids
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @serving_config_ids = args[:serving_config_ids] if args.key?(:serving_config_ids)
+        end
+      end
+      
+      # Request for pausing training of a model.
+      class GoogleCloudRetailV2PauseModelRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Request message for Predict method.
       class GoogleCloudRetailV2PredictRequest
         include Google::Apis::Core::Hashable
@@ -3105,6 +3380,19 @@ module Google
         end
       end
       
+      # Request for resuming training of a model.
+      class GoogleCloudRetailV2ResumeModelRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # A rule is a condition-action pair * A condition defines when a rule is to be
       # triggered. * An action specifies what occurs on that trigger. Currently rules
       # only work for controls with SOLUTION_TYPE_SEARCH.
@@ -4007,6 +4295,12 @@ module Google
         # @return [String]
         attr_accessor :corrected_query
       
+        # Metadata related to A/B testing Experiment associated with this response. Only
+        # exists when an experiment is triggered.
+        # Corresponds to the JSON property `experimentInfo`
+        # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo>]
+        attr_accessor :experiment_info
+      
         # Results of facets requested by user.
         # Corresponds to the JSON property `facets`
         # @return [Array<Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet>]
@@ -4058,6 +4352,7 @@ module Google
           @applied_controls = args[:applied_controls] if args.key?(:applied_controls)
           @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
           @corrected_query = args[:corrected_query] if args.key?(:corrected_query)
+          @experiment_info = args[:experiment_info] if args.key?(:experiment_info)
           @facets = args[:facets] if args.key?(:facets)
           @invalid_condition_boost_specs = args[:invalid_condition_boost_specs] if args.key?(:invalid_condition_boost_specs)
           @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@@ -4545,6 +4840,54 @@ module Google
         end
       end
       
+      # Metadata associated with a tune operation.
+      class GoogleCloudRetailV2TuneModelMetadata
+        include Google::Apis::Core::Hashable
+      
+        # The resource name of the model that this tune applies to. Format: `projects/`
+        # project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        # `
+        # Corresponds to the JSON property `model`
+        # @return [String]
+        attr_accessor :model
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @model = args[:model] if args.key?(:model)
+        end
+      end
+      
+      # Request to manually start a tuning process now (instead of waiting for the
+      # periodically scheduled tuning to happen).
+      class GoogleCloudRetailV2TuneModelRequest
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
+      # Response associated with a tune operation.
+      class GoogleCloudRetailV2TuneModelResponse
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # UserEvent captures all metadata information Retail API needs to know about how
       # end users interact with customers' website.
       class GoogleCloudRetailV2UserEvent

data/lib/google/apis/retail_v2/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module RetailV2
       # Version of the google-apis-retail_v2 gem
-      GEM_VERSION = "0.62.0"
+      GEM_VERSION = "0.63.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.11.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230117"
+      REVISION = "20230119"
     end
   end
 end

data/lib/google/apis/retail_v2/representations.rb

@@ -208,12 +208,30 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2CreateModelMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2CustomAttribute
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2ExperimentInfo
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2ExperimentInfoServingConfigExperiment
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2FulfillmentInfo
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -304,6 +322,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2ListModelsResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2ListProductsResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -322,6 +346,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2Model
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2ModelServingConfigList
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2PauseModelRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2PredictRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -490,6 +532,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2ResumeModelRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2Rule
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -658,6 +706,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleCloudRetailV2TuneModelMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2TuneModelRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class GoogleCloudRetailV2TuneModelResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleCloudRetailV2UserEvent
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -1433,6 +1499,13 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2CreateModelMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :model, as: 'model'
+        end
+      end
+      
       class GoogleCloudRetailV2CustomAttribute
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1443,6 +1516,23 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2ExperimentInfo
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :experiment_name, as: 'experimentName'
+          property :serving_config_experiment, as: 'servingConfigExperiment', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfoServingConfigExperiment, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfoServingConfigExperiment::Representation
+      
+        end
+      end
+      
+      class GoogleCloudRetailV2ExperimentInfoServingConfigExperiment
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :experiment_serving_config, as: 'experimentServingConfig'
+          property :original_serving_config, as: 'originalServingConfig'
+        end
+      end
+      
       class GoogleCloudRetailV2FulfillmentInfo
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1587,6 +1677,15 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2ListModelsResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :models, as: 'models', class: Google::Apis::RetailV2::GoogleCloudRetailV2Model, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
+      
+          property :next_page_token, as: 'nextPageToken'
+        end
+      end
+      
       class GoogleCloudRetailV2ListProductsResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1617,6 +1716,40 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2Model
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :create_time, as: 'createTime'
+          property :data_state, as: 'dataState'
+          property :display_name, as: 'displayName'
+          property :filtering_option, as: 'filteringOption'
+          property :last_tune_time, as: 'lastTuneTime'
+          property :name, as: 'name'
+          property :optimization_objective, as: 'optimizationObjective'
+          property :periodic_tuning_state, as: 'periodicTuningState'
+          collection :serving_config_lists, as: 'servingConfigLists', class: Google::Apis::RetailV2::GoogleCloudRetailV2ModelServingConfigList, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ModelServingConfigList::Representation
+      
+          property :serving_state, as: 'servingState'
+          property :training_state, as: 'trainingState'
+          property :tuning_operation, as: 'tuningOperation'
+          property :type, as: 'type'
+          property :update_time, as: 'updateTime'
+        end
+      end
+      
+      class GoogleCloudRetailV2ModelServingConfigList
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :serving_config_ids, as: 'servingConfigIds'
+        end
+      end
+      
+      class GoogleCloudRetailV2PauseModelRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2PredictRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1895,6 +2028,12 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2ResumeModelRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2Rule
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2094,6 +2233,8 @@ module Google
           collection :applied_controls, as: 'appliedControls'
           property :attribution_token, as: 'attributionToken'
           property :corrected_query, as: 'correctedQuery'
+          collection :experiment_info, as: 'experimentInfo', class: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2ExperimentInfo::Representation
+      
           collection :facets, as: 'facets', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchResponseFacet::Representation
       
           collection :invalid_condition_boost_specs, as: 'invalidConditionBoostSpecs', class: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec, decorator: Google::Apis::RetailV2::GoogleCloudRetailV2SearchRequestBoostSpecConditionBoostSpec::Representation
@@ -2210,6 +2351,25 @@ module Google
         end
       end
       
+      class GoogleCloudRetailV2TuneModelMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :model, as: 'model'
+        end
+      end
+      
+      class GoogleCloudRetailV2TuneModelRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
+      class GoogleCloudRetailV2TuneModelResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleCloudRetailV2UserEvent
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/lib/google/apis/retail_v2/service.rb

@@ -583,8 +583,7 @@ module Google
         # returned Operations will be obsolete after 1 day, and GetOperation API will
         # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
         # associated with the stale updates will not be marked as done until being
-        # obsolete. This feature is only available for users who have Retail Search
-        # enabled. Enable Retail Search on Cloud Console before using this feature.
+        # obsolete.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -632,9 +631,7 @@ module Google
         # inventories. The returned Operations will be obsolete after 1 day, and
         # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
         # issued, the Operations associated with the stale updates will not be marked as
-        # done until being obsolete. This feature is only available for users who have
-        # Retail Search enabled. Enable Retail Search on Cloud Console before using this
-        # feature.
+        # done until being obsolete.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -944,8 +941,7 @@ module Google
         # returned Operations will be obsolete after 1 day, and GetOperation API will
         # return NOT_FOUND afterwards. If conflicting updates are issued, the Operations
         # associated with the stale updates will not be marked as done until being
-        # obsolete. This feature is only available for users who have Retail Search
-        # enabled. Enable Retail Search on Cloud Console before using this feature.
+        # obsolete.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -991,9 +987,7 @@ module Google
         # inventories. The returned Operations will be obsolete after 1 day, and
         # GetOperation API will return NOT_FOUND afterwards. If conflicting updates are
         # issued, the Operations associated with the stale updates will not be marked as
-        # done until being obsolete. This feature is only available for users who have
-        # Retail Search enabled. Enable Retail Search on Cloud Console before using this
-        # feature.
+        # done until being obsolete.
         # @param [String] product
         #   Required. Full resource name of Product, such as `projects/*/locations/global/
         #   catalogs/default_catalog/branches/default_branch/products/some_product_id`. If
@@ -1049,9 +1043,7 @@ module Google
         # RemoveFulfillmentPlaces. The returned Operations is obsolete after one day,
         # and the GetOperation API returns `NOT_FOUND` afterwards. If conflicting
         # updates are issued, the Operations associated with the stale updates are not
-        # marked as done until they are obsolete. This feature is only available for
-        # users who have Retail Search enabled. Enable Retail Search on Cloud Console
-        # before using this feature.
+        # marked as done until they are obsolete.
         # @param [String] name
         #   Immutable. Full resource name of the product, such as `projects/*/locations/
         #   global/catalogs/default_catalog/branches/default_branch/products/product_id`.
@@ -1315,6 +1307,260 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Creates a new model.
+        # @param [String] parent
+        #   Required. The parent resource under which to create the model. Format: `
+        #   projects/`project_number`/locations/`location_id`/catalogs/`catalog_id``
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2Model] google_cloud_retail_v2_model_object
+        # @param [Boolean] dry_run
+        #   Optional. Whether to run a dry run to validate the request (without actually
+        #   creating the model).
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def create_project_location_catalog_model(parent, google_cloud_retail_v2_model_object = nil, dry_run: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+parent}/models', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
+          command.request_object = google_cloud_retail_v2_model_object
+          command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
+          command.params['parent'] = parent unless parent.nil?
+          command.query['dryRun'] = dry_run unless dry_run.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Deletes an existing model.
+        # @param [String] name
+        #   Required. The resource name of the Model to delete. Format: `projects/`
+        #   project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        #   `
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2::GoogleProtobufEmpty] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleProtobufEmpty]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def delete_project_location_catalog_model(name, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v2/{+name}', options)
+          command.response_representation = Google::Apis::RetailV2::GoogleProtobufEmpty::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleProtobufEmpty
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Lists all the models linked to this event store.
+        # @param [String] parent
+        #   Required. The parent for which to list models. Format: `projects/`
+        #   project_number`/locations/`location_id`/catalogs/`catalog_id``
+        # @param [Fixnum] page_size
+        #   Optional. Maximum number of results to return. If unspecified, defaults to 50.
+        #   Max allowed value is 1000.
+        # @param [String] page_token
+        #   Optional. A page token, received from a previous `ListModels` call. Provide
+        #   this to retrieve the subsequent page.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def list_project_location_catalog_models(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v2/{+parent}/models', options)
+          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2ListModelsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Update of model metadata. Only fields that currently can be updated are: `
+        # filtering_option` and `periodic_tuning_state`. If other values are provided,
+        # this API method ignores them.
+        # @param [String] 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.
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2Model] google_cloud_retail_v2_model_object
+        # @param [String] update_mask
+        #   Optional. Indicates which fields in the provided 'model' to update. If not set,
+        #   by default updates all fields.
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2Model] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Model]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def patch_project_location_catalog_model(name, google_cloud_retail_v2_model_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:patch, 'v2/{+name}', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
+          command.request_object = google_cloud_retail_v2_model_object
+          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model
+          command.params['name'] = name unless name.nil?
+          command.query['updateMask'] = update_mask unless update_mask.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Pauses the training of an existing model.
+        # @param [String] name
+        #   Required. The name of the model to pause. Format: `projects/`project_number`/
+        #   locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2PauseModelRequest] google_cloud_retail_v2_pause_model_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2Model] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Model]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def pause_project_location_catalog_model(name, google_cloud_retail_v2_pause_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+name}:pause', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2PauseModelRequest::Representation
+          command.request_object = google_cloud_retail_v2_pause_model_request_object
+          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Resumes the training of an existing model.
+        # @param [String] name
+        #   Required. The name of the model to resume. Format: `projects/`project_number`/
+        #   locations/`location_id`/catalogs/`catalog_id`/models/`model_id``
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2ResumeModelRequest] google_cloud_retail_v2_resume_model_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2::GoogleCloudRetailV2Model] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleCloudRetailV2Model]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def resume_project_location_catalog_model(name, google_cloud_retail_v2_resume_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+name}:resume', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2ResumeModelRequest::Representation
+          command.request_object = google_cloud_retail_v2_resume_model_request_object
+          command.response_representation = Google::Apis::RetailV2::GoogleCloudRetailV2Model::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleCloudRetailV2Model
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
+        # Tunes an existing model.
+        # @param [String] name
+        #   Required. The resource name of the model to tune. Format: `projects/`
+        #   project_number`/locations/`location_id`/catalogs/`catalog_id`/models/`model_id`
+        #   `
+        # @param [Google::Apis::RetailV2::GoogleCloudRetailV2TuneModelRequest] google_cloud_retail_v2_tune_model_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::RetailV2::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::RetailV2::GoogleLongrunningOperation]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def tune_project_location_catalog_model(name, google_cloud_retail_v2_tune_model_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v2/{+name}:tune', options)
+          command.request_representation = Google::Apis::RetailV2::GoogleCloudRetailV2TuneModelRequest::Representation
+          command.request_object = google_cloud_retail_v2_tune_model_request_object
+          command.response_representation = Google::Apis::RetailV2::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::RetailV2::GoogleLongrunningOperation
+          command.params['name'] = name unless name.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Gets the latest state of a long-running operation. Clients can use this method
         # to poll the operation result at intervals as recommended by the API service.
         # @param [String] name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-retail_v2
 version: !ruby/object:Gem::Version
-  version: 0.62.0
+  version: 0.63.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.62.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-retail_v2/v0.63.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-retail_v2
 post_install_message: 
 rdoc_options: []