google-cloud-retail-v2 0.11.0 → 0.13.0

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

@@ -34,9 +34,9 @@ module Google
         # Service for search.
         #
         # 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/search_service"
         #     client = ::Google::Cloud::Retail::V2::SearchService::Client.new

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

@@ -27,7 +27,7 @@ module Google
           # Service for search.
           #
           # 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
             # Performs a search.
             #
             # 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 :Search, ::Google::Cloud::Retail::V2::SearchRequest, ::Google::Cloud::Retail::V2::SearchResponse
           end
 

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

@@ -26,10 +26,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       repeated :replacement_control_ids, :string, 14
       repeated :ignore_control_ids, :string, 15
       optional :diversity_level, :string, 8
+      optional :diversity_type, :enum, 20, "google.cloud.retail.v2.ServingConfig.DiversityType"
       optional :enable_category_filter_level, :string, 16
       optional :personalization_spec, :message, 21, "google.cloud.retail.v2.SearchRequest.PersonalizationSpec"
       repeated :solution_types, :enum, 19, "google.cloud.retail.v2.SolutionType"
     end
+    add_enum "google.cloud.retail.v2.ServingConfig.DiversityType" do
+      value :DIVERSITY_TYPE_UNSPECIFIED, 0
+      value :RULE_BASED_DIVERSITY, 2
+      value :DATA_DRIVEN_DIVERSITY, 3
+    end
   end
 end
 
@@ -38,6 +44,7 @@ module Google
     module Retail
       module V2
         ServingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ServingConfig").msgclass
+        ServingConfig::DiversityType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ServingConfig.DiversityType").enummodule
       end
     end
   end

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

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/retail/v2/serving_config_service_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -133,6 +134,12 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @serving_config_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Retail::V2::ServingConfigService::Stub,
                 credentials:  credentials,
@@ -142,6 +149,13 @@ module Google
               )
             end
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -264,7 +278,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the ServingConfig to delete. Format:
-            #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
+            #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Protobuf::Empty]
@@ -445,7 +459,7 @@ module Google
             #
             #   @param name [::String]
             #     Required. The resource name of the ServingConfig to get. Format:
-            #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
+            #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Retail::V2::ServingConfig]
@@ -531,7 +545,7 @@ module Google
             #
             #   @param parent [::String]
             #     Required. The catalog resource name. Format:
-            #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}
+            #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}`
             #   @param page_size [::Integer]
             #     Optional. Maximum number of results to return. If unspecified, defaults
             #     to 100. If a value greater than 100 is provided, at most 100 results are
@@ -560,13 +574,11 @@ module Google
             #   # Call the list_serving_configs method.
             #   result = client.list_serving_configs request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Cloud::Retail::V2::ServingConfig.
-            #     p response
+            #     p item
             #   end
             #
             def list_serving_configs request, options = nil
@@ -637,7 +649,7 @@ module Google
             #
             #   @param serving_config [::String]
             #     Required. The source ServingConfig resource name . Format:
-            #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
+            #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
             #   @param control_id [::String]
             #     Required. The id of the control to apply. Assumed to be in the same catalog
             #     as the serving config - if id is not found a NOT_FOUND error is returned.
@@ -729,7 +741,7 @@ module Google
             #
             #   @param serving_config [::String]
             #     Required. The source ServingConfig resource name . Format:
-            #     projects/\\{project_number}/locations/\\{location_id}/catalogs/\\{catalog_id}/servingConfigs/\\{serving_config_id}
+            #     `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id}`
             #   @param control_id [::String]
             #     Required. The id of the control to apply. Assumed to be in the same catalog
             #     as the serving config.

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

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

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

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/retail/v2/user_event_service_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -154,6 +155,12 @@ module Google
                 config.endpoint = @config.endpoint
               end
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @user_event_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::Retail::V2::UserEventService::Stub,
                 credentials:  credentials,
@@ -170,6 +177,13 @@ module Google
             #
             attr_reader :operations_client
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -185,7 +199,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload write_user_event(parent: nil, user_event: nil)
+            # @overload write_user_event(parent: nil, user_event: nil, write_async: nil)
             #   Pass arguments to `write_user_event` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -195,6 +209,11 @@ module Google
             #     `projects/1234/locations/global/catalogs/default_catalog`.
             #   @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
             #     Required. User event to write.
+            #   @param write_async [::Boolean]
+            #     If set to true, the user event will be written asynchronously after
+            #     validation, and the API will respond without waiting for the write.
+            #     Therefore, silent failures can occur even if the API returns success. In
+            #     case of silent failures, error messages can be found in Stackdriver logs.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Retail::V2::UserEvent]
@@ -277,11 +296,14 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload collect_user_event(parent: nil, user_event: nil, uri: nil, ets: nil)
+            # @overload collect_user_event(prebuilt_rule: nil, parent: nil, user_event: nil, uri: nil, ets: nil, raw_json: nil)
             #   Pass arguments to `collect_user_event` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
+            #   @param prebuilt_rule [::String]
+            #     The prebuilt rule name that can convert a specific type of raw_json.
+            #     For example: "default_schema/v1.0"
             #   @param parent [::String]
             #     Required. The parent catalog name, such as
             #     `projects/1234/locations/global/catalogs/default_catalog`.
@@ -297,6 +319,11 @@ module Google
             #     The event timestamp in milliseconds. This prevents browser caching of
             #     otherwise identical get requests. The name is abbreviated to reduce the
             #     payload bytes.
+            #   @param raw_json [::String]
+            #     An arbitrary serialized JSON string that contains necessary information
+            #     that can comprise a user event. When this field is specified, the
+            #     user_event field will be ignored. Note: line-delimited JSON is not
+            #     supported, a single JSON only.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Api::HttpBody]
@@ -436,14 +463,14 @@ module Google
             #   # Call the purge_user_events method.
             #   result = client.purge_user_events request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def purge_user_events request, options = nil
@@ -540,14 +567,14 @@ module Google
             #   # Call the import_user_events method.
             #   result = client.import_user_events request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def import_user_events request, options = nil
@@ -593,14 +620,14 @@ module Google
             end
 
             ##
-            # Starts a user event rejoin operation with latest product catalog. Events
-            # will not be annotated with detailed product information if product is
-            # missing from the catalog at the time the user event is ingested, and these
-            # events are stored as unjoined events with a limited usage on training and
-            # serving. This method can be used to start a join operation on specified
-            # events with latest version of product catalog. It can also be used to
-            # correct events joined with the wrong product catalog. A rejoin operation
-            # can take hours or days to complete.
+            # Starts a user-event rejoin operation with latest product catalog. Events
+            # are not annotated with detailed product information for products that are
+            # missing from the catalog when the user event is ingested. These
+            # events are stored as unjoined events with limited usage on training and
+            # serving. You can use this method to start a join operation on specified
+            # events with the latest version of product catalog. You can also use this
+            # method to correct events joined with the wrong product catalog. A rejoin
+            # operation can take hours or days to complete.
             #
             # @overload rejoin_user_events(request, options = nil)
             #   Pass arguments to `rejoin_user_events` via a request object, either of type
@@ -623,8 +650,8 @@ module Google
             #   @param user_event_rejoin_scope [::Google::Cloud::Retail::V2::RejoinUserEventsRequest::UserEventRejoinScope]
             #     The type of the user event rejoin to define the scope and range of the user
             #     events to be rejoined with the latest product catalog. Defaults to
-            #     USER_EVENT_REJOIN_SCOPE_UNSPECIFIED if this field is not set, or set to an
-            #     invalid integer value.
+            #     `USER_EVENT_REJOIN_SCOPE_UNSPECIFIED` if this field is not set, or set to
+            #     an invalid integer value.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -646,14 +673,14 @@ module Google
             #   # Call the rejoin_user_events method.
             #   result = client.rejoin_user_events request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def rejoin_user_events request, options = nil

data/lib/google/cloud/retail/v2/user_event_service/operations.rb

@@ -158,13 +158,11 @@ module Google
             #   # Call the list_operations method.
             #   result = client.list_operations request
             #
-            #   # The returned object is of type Gapic::PagedEnumerable. You can
-            #   # iterate over all elements by calling #each, and the enumerable
-            #   # will lazily make API calls to fetch subsequent pages. Other
-            #   # methods are also available for managing paging directly.
-            #   result.each do |response|
+            #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+            #   # over elements, and API calls will be issued to fetch pages as needed.
+            #   result.each do |item|
             #     # Each element is of type ::Google::Longrunning::Operation.
-            #     p response
+            #     p item
             #   end
             #
             def list_operations request, options = nil
@@ -253,14 +251,14 @@ module Google
             #   # Call the get_operation method.
             #   result = client.get_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def get_operation request, options = nil
@@ -540,14 +538,14 @@ module Google
             #   # Call the wait_operation method.
             #   result = client.wait_operation request
             #
-            #   # The returned object is of type Gapic::Operation. You can use this
-            #   # object to check the status of an operation, cancel it, or wait
-            #   # for results. Here is how to block until completion:
+            #   # The returned object is of type Gapic::Operation. You can use it to
+            #   # check the status of an operation, cancel it, or wait for results.
+            #   # Here is how to wait for a response.
             #   result.wait_until_done! timeout: 60
             #   if result.response?
             #     p result.response
             #   else
-            #     puts "Error!"
+            #     puts "No response received."
             #   end
             #
             def wait_operation request, options = nil

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

@@ -34,7 +34,7 @@ module Google
         ##
         # Service for ingesting end user actions on the customer website.
         #
-        # To load this service and instantiate a client:
+        # @example Load this service and instantiate a gRPC client
         #
         #     require "google/cloud/retail/v2/user_event_service"
         #     client = ::Google::Cloud::Retail::V2::UserEventService::Client.new

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

@@ -7,6 +7,7 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/httpbody_pb'
+require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/import_config_pb'
 require 'google/cloud/retail/v2/purge_config_pb'
 require 'google/cloud/retail/v2/user_event_pb'
@@ -17,12 +18,17 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.cloud.retail.v2.WriteUserEventRequest" do
       optional :parent, :string, 1
       optional :user_event, :message, 2, "google.cloud.retail.v2.UserEvent"
+      optional :write_async, :bool, 3
     end
     add_message "google.cloud.retail.v2.CollectUserEventRequest" do
       optional :parent, :string, 1
       optional :user_event, :string, 2
       optional :uri, :string, 3
       optional :ets, :int64, 4
+      optional :raw_json, :string, 5
+      oneof :conversion_rule do
+        optional :prebuilt_rule, :string, 6
+      end
     end
     add_message "google.cloud.retail.v2.RejoinUserEventsRequest" do
       optional :parent, :string, 1

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

@@ -54,14 +54,14 @@ module Google
             # possible for a subset of the items to be successfully inserted.
             # `Operation.metadata` is of type `ImportMetadata`.
             rpc :ImportUserEvents, ::Google::Cloud::Retail::V2::ImportUserEventsRequest, ::Google::Longrunning::Operation
-            # Starts a user event rejoin operation with latest product catalog. Events
-            # will not be annotated with detailed product information if product is
-            # missing from the catalog at the time the user event is ingested, and these
-            # events are stored as unjoined events with a limited usage on training and
-            # serving. This method can be used to start a join operation on specified
-            # events with latest version of product catalog. It can also be used to
-            # correct events joined with the wrong product catalog. A rejoin operation
-            # can take hours or days to complete.
+            # Starts a user-event rejoin operation with latest product catalog. Events
+            # are not annotated with detailed product information for products that are
+            # missing from the catalog when the user event is ingested. These
+            # events are stored as unjoined events with limited usage on training and
+            # serving. You can use this method to start a join operation on specified
+            # events with the latest version of product catalog. You can also use this
+            # method to correct events joined with the wrong product catalog. A rejoin
+            # operation can take hours or days to complete.
             rpc :RejoinUserEvents, ::Google::Cloud::Retail::V2::RejoinUserEventsRequest, ::Google::Longrunning::Operation
           end
 

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Retail
       module V2
-        VERSION = "0.11.0"
+        VERSION = "0.13.0"
       end
     end
   end

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

@@ -30,9 +30,9 @@ module Google
   module Cloud
     module Retail
       ##
-      # To load this package, including all its services, and instantiate a client:
+      # API client module.
       #
-      # @example
+      # @example Load this package, including all its services, and instantiate a gRPC client
       #
       #     require "google/cloud/retail/v2"
       #     client = ::Google::Cloud::Retail::V2::CatalogService::Client.new