google-cloud-retail-v2 0.14.0 → 0.15.0

data/proto_docs/google/cloud/retail/v2/model_service.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        # Request for creating a model.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource under which to create the model. Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
+        # @!attribute [rw] model
+        #   @return [::Google::Cloud::Retail::V2::Model]
+        #     Required. The payload of the {::Google::Cloud::Retail::V2::Model Model}  to
+        #     create.
+        # @!attribute [rw] dry_run
+        #   @return [::Boolean]
+        #     Optional. Whether to run a dry run to validate the request (without
+        #     actually creating the model).
+        class CreateModelRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for updating an existing model.
+        # @!attribute [rw] model
+        #   @return [::Google::Cloud::Retail::V2::Model]
+        #     Required. The body of the updated {::Google::Cloud::Retail::V2::Model Model}.
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. Indicates which fields in the provided 'model' to
+        #     update. If not set, by default updates all fields.
+        class UpdateModelRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for getting a model.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the {::Google::Cloud::Retail::V2::Model Model} to
+        #     get. Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog}/models/{model_id}`
+        class GetModelRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for pausing training of a model.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the model to pause.
+        #     Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
+        class PauseModelRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for resuming training of a model.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the model to resume.
+        #     Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
+        class ResumeModelRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for listing models associated with a resource.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent for which to list models.
+        #     Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of results to return. If unspecified, defaults
+        #     to 50. Max allowed value is 1000.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListModels`
+        #     call. Provide this to retrieve the subsequent page.
+        class ListModelsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for deleting a model.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the {::Google::Cloud::Retail::V2::Model Model} to
+        #     delete. Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
+        class DeleteModelRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response to a ListModelRequest.
+        # @!attribute [rw] models
+        #   @return [::Array<::Google::Cloud::Retail::V2::Model>]
+        #     List of Models.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Pagination token, if not returned indicates the last page.
+        class ListModelsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request to manually start a tuning process now (instead of waiting for
+        # the periodically scheduled tuning to happen).
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the model to tune.
+        #     Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
+        class TuneModelRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata associated with a create operation.
+        # @!attribute [rw] model
+        #   @return [::String]
+        #     The resource name of the model that this create applies to.
+        #     Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
+        class CreateModelMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata associated with a tune operation.
+        # @!attribute [rw] model
+        #   @return [::String]
+        #     The resource name of the model that this tune applies to.
+        #     Format:
+        #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
+        class TuneModelMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response associated with a tune operation.
+        class TuneModelResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/retail/v2/prediction_service.rb

@@ -101,6 +101,9 @@ module Google
         #      * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
         #      * (availability: ANY("IN_STOCK")) AND
         #        (colors: ANY("Red") OR categories: ANY("Phones"))
+        #
+        #     For more information, see
+        #     [Filter recommendations](https://cloud.google.com/retail/docs/filter-recs).
         # @!attribute [rw] validate_only
         #   @return [::Boolean]
         #     Use validate only mode for this prediction query. If set to true, a

data/proto_docs/google/cloud/retail/v2/product.rb

@@ -496,12 +496,11 @@ module Google
         #   @return [::Array<::Google::Cloud::Retail::V2::LocalInventory>]
         #     Output only. A list of local inventories specific to different places.
         #
-        #     This is only available for users who have Retail Search enabled, and it can
-        #     be managed by
+        #     This field can be managed by
         #     {::Google::Cloud::Retail::V2::ProductService::Client#add_local_inventories ProductService.AddLocalInventories}
         #     and
         #     {::Google::Cloud::Retail::V2::ProductService::Client#remove_local_inventories ProductService.RemoveLocalInventories}
-        #     APIs.
+        #     APIs if fine-grained, high-volume updates are necessary.
         class Product
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/retail/v2/search_service.rb

@@ -124,7 +124,7 @@ module Google
         #   @return [::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec>]
         #     Facet specifications for faceted search. If empty, no facets are returned.
         #
-        #     A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error
+        #     A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error
         #     is returned.
         # @!attribute [rw] dynamic_facet_spec
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec]
@@ -275,6 +275,14 @@ module Google
         #   @return [::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec]
         #     The spell correction specification that specifies the mode under
         #     which spell correction will take effect.
+        # @!attribute [rw] entity
+        #   @return [::String]
+        #     The entity for customers that may run multiple different entities, domains,
+        #     sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
+        #     `google.com`, `youtube.com`, etc.
+        #     If this is set, it should be exactly matched with
+        #     {::Google::Cloud::Retail::V2::UserEvent#entity UserEvent.entity} to get search
+        #     results boosted by entity.
         class SearchRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -402,7 +410,16 @@ module Google
             #   @return [::Array<::Google::Cloud::Retail::V2::Interval>]
             #     Set only if values should be bucketized into intervals. Must be set
             #     for facets with numerical values. Must not be set for facet with text
-            #     values. Maximum number of intervals is 30.
+            #     values. Maximum number of intervals is 40.
+            #
+            #     For all numerical facet keys that appear in the list of products from
+            #     the catalog, the percentiles 0, 10, 30, 50, 70, 90 and 100 are
+            #     computed from their distribution weekly. If the model assigns a high
+            #     score to a numerical facet key and its intervals are not specified in
+            #     the search request, these percentiles will become the bounds
+            #     for its intervals and will be returned in the response. If the
+            #     facet key intervals are specified in the request, then the specified
+            #     intervals will be returned instead.
             # @!attribute [rw] restricted_values
             #   @return [::Array<::String>]
             #     Only get facet for the given restricted values. For example, when using
@@ -772,6 +789,10 @@ module Google
         #     The invalid
         #     {::Google::Cloud::Retail::V2::SearchRequest::BoostSpec#condition_boost_specs SearchRequest.BoostSpec.condition_boost_specs}
         #     that are not applied during serving.
+        # @!attribute [rw] experiment_info
+        #   @return [::Array<::Google::Cloud::Retail::V2::ExperimentInfo>]
+        #     Metadata related to A/B testing [Experiment][] associated with this
+        #     response. Only exists when an experiment is triggered.
         class SearchResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -947,6 +968,39 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
         end
+
+        # Metadata for active A/B testing [Experiments][].
+        # @!attribute [rw] serving_config_experiment
+        #   @return [::Google::Cloud::Retail::V2::ExperimentInfo::ServingConfigExperiment]
+        #     A/B test between existing Cloud Retail Search
+        #     {::Google::Cloud::Retail::V2::ServingConfig ServingConfig}s.
+        # @!attribute [rw] experiment
+        #   @return [::String]
+        #     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`
+        class ExperimentInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Metadata for active serving config A/B tests.
+          # @!attribute [rw] original_serving_config
+          #   @return [::String]
+          #     The fully qualified resource name of the original
+          #     {::Google::Cloud::Retail::V2::SearchRequest#placement SearchRequest.placement}
+          #     in the search request prior to reassignment by experiment API. For
+          #     example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.
+          # @!attribute [rw] experiment_serving_config
+          #   @return [::String]
+          #     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/*`.
+          class ServingConfigExperiment
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
       end
     end
   end

data/proto_docs/google/cloud/retail/v2/serving_config.rb

@@ -55,7 +55,7 @@ module Google
         #      Allowed values are:
         #
         #     * `no-price-reranking`
-        #     * `low-price-raranking`
+        #     * `low-price-reranking`
         #     * `medium-price-reranking`
         #     * `high-price-reranking`
         #
@@ -194,8 +194,8 @@ module Google
         #     [SOLUTION_TYPE_RECOMMENDATION][google.cloud.retail.v2main.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
         # @!attribute [rw] diversity_type
         #   @return [::Google::Cloud::Retail::V2::ServingConfig::DiversityType]
-        #     What kind of diversity to use - data driven or rule based. If unset,
-        #     the server behavior defaults to
+        #     What kind of diversity to use - data driven or rule based. If unset, the
+        #     server behavior defaults to
         #     {::Google::Cloud::Retail::V2::ServingConfig::DiversityType::RULE_BASED_DIVERSITY RULE_BASED_DIVERSITY}.
         # @!attribute [rw] enable_category_filter_level
         #   @return [::String]

data/proto_docs/google/cloud/retail/v2/user_event.rb

@@ -257,6 +257,13 @@ module Google
         #
         #     When using the client side event reporting with JavaScript pixel and Google
         #     Tag Manager, this value is filled in automatically.
+        # @!attribute [rw] entity
+        #   @return [::String]
+        #     The entity for customers that may run multiple different entities, domains,
+        #     sites or regions, for example, `Google US`, `Google Ads`, `Waymo`,
+        #     `google.com`, `youtube.com`, etc.
+        #     It is recommended to set this field to get better per-entity search,
+        #     completion and prediction results.
         class UserEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/cloud/retail/v2/user_event_service.rb

@@ -44,7 +44,7 @@ module Google
         # @!attribute [rw] prebuilt_rule
         #   @return [::String]
         #     The prebuilt rule name that can convert a specific type of raw_json.
-        #     For example: "default_schema/v1.0"
+        #     For example: "ga4_bq" rule for the GA4 user event schema.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent catalog name, such as

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail-v2
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-08 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -225,6 +225,18 @@ files:
 - lib/google/cloud/retail/v2/control_service_pb.rb
 - lib/google/cloud/retail/v2/control_service_services_pb.rb
 - lib/google/cloud/retail/v2/import_config_pb.rb
+- lib/google/cloud/retail/v2/model_pb.rb
+- lib/google/cloud/retail/v2/model_service.rb
+- lib/google/cloud/retail/v2/model_service/client.rb
+- lib/google/cloud/retail/v2/model_service/credentials.rb
+- lib/google/cloud/retail/v2/model_service/operations.rb
+- lib/google/cloud/retail/v2/model_service/paths.rb
+- lib/google/cloud/retail/v2/model_service/rest.rb
+- lib/google/cloud/retail/v2/model_service/rest/client.rb
+- lib/google/cloud/retail/v2/model_service/rest/operations.rb
+- lib/google/cloud/retail/v2/model_service/rest/service_stub.rb
+- lib/google/cloud/retail/v2/model_service_pb.rb
+- lib/google/cloud/retail/v2/model_service_services_pb.rb
 - lib/google/cloud/retail/v2/prediction_service.rb
 - lib/google/cloud/retail/v2/prediction_service/client.rb
 - lib/google/cloud/retail/v2/prediction_service/credentials.rb
@@ -294,6 +306,8 @@ files:
 - proto_docs/google/cloud/retail/v2/control.rb
 - proto_docs/google/cloud/retail/v2/control_service.rb
 - proto_docs/google/cloud/retail/v2/import_config.rb
+- proto_docs/google/cloud/retail/v2/model.rb
+- proto_docs/google/cloud/retail/v2/model_service.rb
 - proto_docs/google/cloud/retail/v2/prediction_service.rb
 - proto_docs/google/cloud/retail/v2/product.rb
 - proto_docs/google/cloud/retail/v2/product_service.rb