google-cloud-retail-v2 0.10.0 → 0.12.0

data/lib/google/cloud/retail/v2/catalog_service/paths.rb

@@ -24,6 +24,25 @@ module Google
         module CatalogService
           # Path helper methods for the CatalogService API.
           module Paths
+            ##
+            # Create a fully-qualified AttributesConfig resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}/attributesConfig`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            #
+            # @return [::String]
+            def attributes_config_path project:, location:, catalog:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/catalogs/#{catalog}/attributesConfig"
+            end
+
             ##
             # Create a fully-qualified Branch resource string.
             #
@@ -64,6 +83,25 @@ module Google
               "projects/#{project}/locations/#{location}/catalogs/#{catalog}"
             end
 
+            ##
+            # Create a fully-qualified CompletionConfig resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}/completionConfig`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            #
+            # @return [::String]
+            def completion_config_path project:, location:, catalog:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+              raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}/catalogs/#{catalog}/completionConfig"
+            end
+
             ##
             # Create a fully-qualified Location resource string.
             #

data/lib/google/cloud/retail/v2/catalog_service.rb

@@ -33,7 +33,7 @@ module Google
         ##
         # Service for managing catalog configuration.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/catalog_service"
         #     client = ::Google::Cloud::Retail::V2::CatalogService::Client.new

data/lib/google/cloud/retail/v2/catalog_service_pb.rb

@@ -41,6 +41,33 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :set_time, :message, 2, "google.protobuf.Timestamp"
       optional :note, :string, 3
     end
+    add_message "google.cloud.retail.v2.GetCompletionConfigRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.retail.v2.UpdateCompletionConfigRequest" do
+      optional :completion_config, :message, 1, "google.cloud.retail.v2.CompletionConfig"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.retail.v2.GetAttributesConfigRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.cloud.retail.v2.UpdateAttributesConfigRequest" do
+      optional :attributes_config, :message, 1, "google.cloud.retail.v2.AttributesConfig"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.cloud.retail.v2.AddCatalogAttributeRequest" do
+      optional :attributes_config, :string, 1
+      optional :catalog_attribute, :message, 2, "google.cloud.retail.v2.CatalogAttribute"
+    end
+    add_message "google.cloud.retail.v2.RemoveCatalogAttributeRequest" do
+      optional :attributes_config, :string, 1
+      optional :key, :string, 2
+    end
+    add_message "google.cloud.retail.v2.ReplaceCatalogAttributeRequest" do
+      optional :attributes_config, :string, 1
+      optional :catalog_attribute, :message, 2, "google.cloud.retail.v2.CatalogAttribute"
+      optional :update_mask, :message, 3, "google.protobuf.FieldMask"
+    end
   end
 end
 
@@ -54,6 +81,13 @@ module Google
         SetDefaultBranchRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SetDefaultBranchRequest").msgclass
         GetDefaultBranchRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GetDefaultBranchRequest").msgclass
         GetDefaultBranchResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GetDefaultBranchResponse").msgclass
+        GetCompletionConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GetCompletionConfigRequest").msgclass
+        UpdateCompletionConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UpdateCompletionConfigRequest").msgclass
+        GetAttributesConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GetAttributesConfigRequest").msgclass
+        UpdateAttributesConfigRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UpdateAttributesConfigRequest").msgclass
+        AddCatalogAttributeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.AddCatalogAttributeRequest").msgclass
+        RemoveCatalogAttributeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.RemoveCatalogAttributeRequest").msgclass
+        ReplaceCatalogAttributeRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ReplaceCatalogAttributeRequest").msgclass
       end
     end
   end

data/lib/google/cloud/retail/v2/catalog_service_services_pb.rb

@@ -76,6 +76,44 @@ module Google
             # [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch]
             # method under a specified parent catalog.
             rpc :GetDefaultBranch, ::Google::Cloud::Retail::V2::GetDefaultBranchRequest, ::Google::Cloud::Retail::V2::GetDefaultBranchResponse
+            # Gets a [CompletionConfig][google.cloud.retail.v2.CompletionConfig].
+            rpc :GetCompletionConfig, ::Google::Cloud::Retail::V2::GetCompletionConfigRequest, ::Google::Cloud::Retail::V2::CompletionConfig
+            # Updates the [CompletionConfig][google.cloud.retail.v2.CompletionConfig]s.
+            rpc :UpdateCompletionConfig, ::Google::Cloud::Retail::V2::UpdateCompletionConfigRequest, ::Google::Cloud::Retail::V2::CompletionConfig
+            # Gets an [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
+            rpc :GetAttributesConfig, ::Google::Cloud::Retail::V2::GetAttributesConfigRequest, ::Google::Cloud::Retail::V2::AttributesConfig
+            # Updates the [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
+            #
+            # The catalog attributes in the request will be updated in the catalog, or
+            # inserted if they do not exist. Existing catalog attributes not included in
+            # the request will remain unchanged. Attributes that are assigned to
+            # products, but do not exist at the catalog level, are always included in the
+            # response. The product attribute is assigned default values for missing
+            # catalog attribute fields, e.g., searchable and dynamic facetable options.
+            rpc :UpdateAttributesConfig, ::Google::Cloud::Retail::V2::UpdateAttributesConfigRequest, ::Google::Cloud::Retail::V2::AttributesConfig
+            # Adds the specified
+            # [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to the
+            # [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
+            #
+            # If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to add
+            # already exists, an ALREADY_EXISTS error is returned.
+            rpc :AddCatalogAttribute, ::Google::Cloud::Retail::V2::AddCatalogAttributeRequest, ::Google::Cloud::Retail::V2::AttributesConfig
+            # Removes the specified
+            # [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] from the
+            # [AttributesConfig][google.cloud.retail.v2.AttributesConfig].
+            #
+            # If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to
+            # remove does not exist, a NOT_FOUND error is returned.
+            rpc :RemoveCatalogAttribute, ::Google::Cloud::Retail::V2::RemoveCatalogAttributeRequest, ::Google::Cloud::Retail::V2::AttributesConfig
+            # Replaces the specified
+            # [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] in the
+            # [AttributesConfig][google.cloud.retail.v2.AttributesConfig] by updating the
+            # catalog attribute with the same
+            # [CatalogAttribute.key][google.cloud.retail.v2.CatalogAttribute.key].
+            #
+            # If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to
+            # replace does not exist, a NOT_FOUND error is returned.
+            rpc :ReplaceCatalogAttribute, ::Google::Cloud::Retail::V2::ReplaceCatalogAttributeRequest, ::Google::Cloud::Retail::V2::AttributesConfig
           end
 
           Stub = Service.rpc_stub_class

data/lib/google/cloud/retail/v2/common_pb.rb

@@ -8,6 +8,62 @@ require 'google/protobuf/timestamp_pb'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/common.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.Condition" do
+      repeated :query_terms, :message, 1, "google.cloud.retail.v2.Condition.QueryTerm"
+      repeated :active_time_range, :message, 3, "google.cloud.retail.v2.Condition.TimeRange"
+    end
+    add_message "google.cloud.retail.v2.Condition.QueryTerm" do
+      optional :value, :string, 1
+      optional :full_match, :bool, 2
+    end
+    add_message "google.cloud.retail.v2.Condition.TimeRange" do
+      optional :start_time, :message, 1, "google.protobuf.Timestamp"
+      optional :end_time, :message, 2, "google.protobuf.Timestamp"
+    end
+    add_message "google.cloud.retail.v2.Rule" do
+      optional :condition, :message, 1, "google.cloud.retail.v2.Condition"
+      oneof :action do
+        optional :boost_action, :message, 2, "google.cloud.retail.v2.Rule.BoostAction"
+        optional :redirect_action, :message, 3, "google.cloud.retail.v2.Rule.RedirectAction"
+        optional :oneway_synonyms_action, :message, 6, "google.cloud.retail.v2.Rule.OnewaySynonymsAction"
+        optional :do_not_associate_action, :message, 7, "google.cloud.retail.v2.Rule.DoNotAssociateAction"
+        optional :replacement_action, :message, 8, "google.cloud.retail.v2.Rule.ReplacementAction"
+        optional :ignore_action, :message, 9, "google.cloud.retail.v2.Rule.IgnoreAction"
+        optional :filter_action, :message, 10, "google.cloud.retail.v2.Rule.FilterAction"
+        optional :twoway_synonyms_action, :message, 11, "google.cloud.retail.v2.Rule.TwowaySynonymsAction"
+      end
+    end
+    add_message "google.cloud.retail.v2.Rule.BoostAction" do
+      optional :boost, :float, 1
+      optional :products_filter, :string, 2
+    end
+    add_message "google.cloud.retail.v2.Rule.FilterAction" do
+      optional :filter, :string, 1
+    end
+    add_message "google.cloud.retail.v2.Rule.RedirectAction" do
+      optional :redirect_uri, :string, 1
+    end
+    add_message "google.cloud.retail.v2.Rule.TwowaySynonymsAction" do
+      repeated :synonyms, :string, 1
+    end
+    add_message "google.cloud.retail.v2.Rule.OnewaySynonymsAction" do
+      repeated :query_terms, :string, 3
+      repeated :synonyms, :string, 4
+      repeated :oneway_terms, :string, 2
+    end
+    add_message "google.cloud.retail.v2.Rule.DoNotAssociateAction" do
+      repeated :query_terms, :string, 2
+      repeated :do_not_associate_terms, :string, 3
+      repeated :terms, :string, 1
+    end
+    add_message "google.cloud.retail.v2.Rule.ReplacementAction" do
+      repeated :query_terms, :string, 2
+      optional :replacement_term, :string, 3
+      optional :term, :string, 1
+    end
+    add_message "google.cloud.retail.v2.Rule.IgnoreAction" do
+      repeated :ignore_terms, :string, 1
+    end
     add_message "google.cloud.retail.v2.Audience" do
       repeated :genders, :string, 1
       repeated :age_groups, :string, 2
@@ -71,6 +127,21 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       map :attributes, :string, :message, 3, "google.cloud.retail.v2.CustomAttribute"
       repeated :fulfillment_types, :string, 4
     end
+    add_enum "google.cloud.retail.v2.AttributeConfigLevel" do
+      value :ATTRIBUTE_CONFIG_LEVEL_UNSPECIFIED, 0
+      value :PRODUCT_LEVEL_ATTRIBUTE_CONFIG, 1
+      value :CATALOG_LEVEL_ATTRIBUTE_CONFIG, 2
+    end
+    add_enum "google.cloud.retail.v2.SolutionType" do
+      value :SOLUTION_TYPE_UNSPECIFIED, 0
+      value :SOLUTION_TYPE_RECOMMENDATION, 1
+      value :SOLUTION_TYPE_SEARCH, 2
+    end
+    add_enum "google.cloud.retail.v2.SearchSolutionUseCase" do
+      value :SEARCH_SOLUTION_USE_CASE_UNSPECIFIED, 0
+      value :SEARCH_SOLUTION_USE_CASE_SEARCH, 1
+      value :SEARCH_SOLUTION_USE_CASE_BROWSE, 2
+    end
   end
 end
 
@@ -78,6 +149,18 @@ module Google
   module Cloud
     module Retail
       module V2
+        Condition = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Condition").msgclass
+        Condition::QueryTerm = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Condition.QueryTerm").msgclass
+        Condition::TimeRange = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Condition.TimeRange").msgclass
+        Rule = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule").msgclass
+        Rule::BoostAction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule.BoostAction").msgclass
+        Rule::FilterAction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule.FilterAction").msgclass
+        Rule::RedirectAction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule.RedirectAction").msgclass
+        Rule::TwowaySynonymsAction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule.TwowaySynonymsAction").msgclass
+        Rule::OnewaySynonymsAction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule.OnewaySynonymsAction").msgclass
+        Rule::DoNotAssociateAction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule.DoNotAssociateAction").msgclass
+        Rule::ReplacementAction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule.ReplacementAction").msgclass
+        Rule::IgnoreAction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rule.IgnoreAction").msgclass
         Audience = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Audience").msgclass
         ColorInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ColorInfo").msgclass
         CustomAttribute = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CustomAttribute").msgclass
@@ -89,6 +172,9 @@ module Google
         Rating = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Rating").msgclass
         UserInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserInfo").msgclass
         LocalInventory = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.LocalInventory").msgclass
+        AttributeConfigLevel = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.AttributeConfigLevel").enummodule
+        SolutionType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SolutionType").enummodule
+        SearchSolutionUseCase = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.SearchSolutionUseCase").enummodule
       end
     end
   end

data/lib/google/cloud/retail/v2/completion_service/client.rb

@@ -30,7 +30,7 @@ module Google
           # Auto-completion service for retail.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please enable Retail Search on Cloud Console before using this feature.
+          # Enable Retail Search on Cloud Console before using this feature.
           #
           class Client
             include Paths
@@ -169,7 +169,7 @@ module Google
             # Completes the specified prefix with keyword suggestions.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload complete_query(request, options = nil)
             #   Pass arguments to `complete_query` via a request object, either of type
@@ -214,8 +214,10 @@ module Google
             #     Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum
             #     number of language codes is 3.
             #   @param device_type [::String]
-            #     The device type context for completion suggestions.
-            #     It is useful to apply different suggestions on different device types, e.g.
+            #     The device type context for completion suggestions. We recommend that you
+            #     leave this field empty.
+            #
+            #     It can apply different suggestions on different device types, e.g.
             #     `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device
             #     types.
             #
@@ -244,7 +246,8 @@ module Google
             #       [guidelines](https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).
             #   @param max_suggestions [::Integer]
             #     Completion max suggestions. If left unset or set to 0, then will fallback
-            #     to the configured value [CompletionConfig.max_suggestions][].
+            #     to the configured value
+            #     {::Google::Cloud::Retail::V2::CompletionConfig#max_suggestions CompletionConfig.max_suggestions}.
             #
             #     The maximum allowed max suggestions is 20. If it is set higher, it will be
             #     capped by 20.
@@ -322,7 +325,7 @@ module Google
             # are indexed successfully and ready for serving. The process takes hours.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             #
             # @overload import_completion_data(request, options = nil)
             #   Pass arguments to `import_completion_data` via a request object, either of type
@@ -347,8 +350,8 @@ module Google
             #     Required. The desired input location of the data.
             #   @param notification_pubsub_topic [::String]
             #     Pub/Sub topic for receiving notification. If this field is set,
-            #     when the import is finished, a notification will be sent to
-            #     specified Pub/Sub topic. The message data will be JSON string of a
+            #     when the import is finished, a notification is sent to
+            #     specified Pub/Sub topic. The message data is JSON string of a
             #     {::Google::Longrunning::Operation Operation}.
             #     Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
             #

data/lib/google/cloud/retail/v2/completion_service.rb

@@ -35,9 +35,9 @@ module Google
         # Auto-completion service for retail.
         #
         # This feature is only available for users who have Retail Search enabled.
-        # Please enable Retail Search on Cloud Console before using this feature.
+        # Enable Retail Search on Cloud Console before using this feature.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/completion_service"
         #     client = ::Google::Cloud::Retail::V2::CompletionService::Client.new

data/lib/google/cloud/retail/v2/completion_service_services_pb.rb

@@ -27,7 +27,7 @@ module Google
           # Auto-completion service for retail.
           #
           # This feature is only available for users who have Retail Search enabled.
-          # Please enable Retail Search on Cloud Console before using this feature.
+          # Enable Retail Search on Cloud Console before using this feature.
           class Service
 
             include ::GRPC::GenericService
@@ -39,7 +39,7 @@ module Google
             # Completes the specified prefix with keyword suggestions.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :CompleteQuery, ::Google::Cloud::Retail::V2::CompleteQueryRequest, ::Google::Cloud::Retail::V2::CompleteQueryResponse
             # Bulk import of processed completion dataset.
             #
@@ -49,7 +49,7 @@ module Google
             # are indexed successfully and ready for serving. The process takes hours.
             #
             # This feature is only available for users who have Retail Search enabled.
-            # Please enable Retail Search on Cloud Console before using this feature.
+            # Enable Retail Search on Cloud Console before using this feature.
             rpc :ImportCompletionData, ::Google::Cloud::Retail::V2::ImportCompletionDataRequest, ::Google::Longrunning::Operation
           end
 

data/lib/google/cloud/retail/v2/control_pb.rb

@@ -0,0 +1,33 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/control.proto
+
+require 'google/protobuf'
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/retail/v2/common_pb'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/retail/v2/control.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.Control" do
+      optional :name, :string, 1
+      optional :display_name, :string, 2
+      repeated :associated_serving_config_ids, :string, 5
+      repeated :solution_types, :enum, 6, "google.cloud.retail.v2.SolutionType"
+      repeated :search_solution_use_case, :enum, 7, "google.cloud.retail.v2.SearchSolutionUseCase"
+      oneof :control do
+        optional :rule, :message, 4, "google.cloud.retail.v2.Rule"
+      end
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        Control = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Control").msgclass
+      end
+    end
+  end
+end