google-cloud-retail-v2 0.3.2 → 0.5.0

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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
+        module CompletionService
+          # Path helper methods for the CompletionService API.
+          module Paths
+            ##
+            # Create a fully-qualified Catalog resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}/catalogs/{catalog}`
+            #
+            # @param project [String]
+            # @param location [String]
+            # @param catalog [String]
+            #
+            # @return [::String]
+            def catalog_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}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2021 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!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/retail/v2/version"
+
+require "google/cloud/retail/v2/completion_service/credentials"
+require "google/cloud/retail/v2/completion_service/paths"
+require "google/cloud/retail/v2/completion_service/operations"
+require "google/cloud/retail/v2/completion_service/client"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        ##
+        # Auto-completion service for retail.
+        #
+        # This feature is only available for users who have Retail Search enabled.
+        # Please submit a form [here](https://cloud.google.com/contact) to contact
+        # cloud sales if you are interested in using Retail Search.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/retail/v2/completion_service"
+        #     client = ::Google::Cloud::Retail::V2::CompletionService::Client.new
+        #
+        module CompletionService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "completion_service", "helpers.rb"
+require "google/cloud/retail/v2/completion_service/helpers" if ::File.file? helper_path

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

@@ -0,0 +1,50 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/completion_service.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/client_pb'
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/cloud/retail/v2/common_pb'
+require 'google/cloud/retail/v2/import_config_pb'
+require 'google/longrunning/operations_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/retail/v2/completion_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.CompleteQueryRequest" do
+      optional :catalog, :string, 1
+      optional :query, :string, 2
+      optional :visitor_id, :string, 7
+      repeated :language_codes, :string, 3
+      optional :device_type, :string, 4
+      optional :dataset, :string, 6
+      optional :max_suggestions, :int32, 5
+    end
+    add_message "google.cloud.retail.v2.CompleteQueryResponse" do
+      repeated :completion_results, :message, 1, "google.cloud.retail.v2.CompleteQueryResponse.CompletionResult"
+      optional :attribution_token, :string, 2
+      repeated :recent_search_results, :message, 3, "google.cloud.retail.v2.CompleteQueryResponse.RecentSearchResult"
+    end
+    add_message "google.cloud.retail.v2.CompleteQueryResponse.CompletionResult" do
+      optional :suggestion, :string, 1
+      map :attributes, :string, :message, 2, "google.cloud.retail.v2.CustomAttribute"
+    end
+    add_message "google.cloud.retail.v2.CompleteQueryResponse.RecentSearchResult" do
+      optional :recent_search, :string, 1
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        CompleteQueryRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CompleteQueryRequest").msgclass
+        CompleteQueryResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CompleteQueryResponse").msgclass
+        CompleteQueryResponse::CompletionResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CompleteQueryResponse.CompletionResult").msgclass
+        CompleteQueryResponse::RecentSearchResult = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CompleteQueryResponse.RecentSearchResult").msgclass
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/retail/v2/completion_service.proto for package 'Google.Cloud.Retail.V2'
+# Original file comments:
+# Copyright 2020 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
+#
+#     http://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.
+#
+
+require 'grpc'
+require 'google/cloud/retail/v2/completion_service_pb'
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module CompletionService
+          # Auto-completion service for retail.
+          #
+          # This feature is only available for users who have Retail Search enabled.
+          # Please submit a form [here](https://cloud.google.com/contact) to contact
+          # cloud sales if you are interested in using Retail Search.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.retail.v2.CompletionService'
+
+            # Completes the specified prefix with keyword suggestions.
+            #
+            # This feature is only available for users who have Retail Search enabled.
+            # Please submit a form [here](https://cloud.google.com/contact) to contact
+            # cloud sales if you are interested in using Retail Search.
+            rpc :CompleteQuery, ::Google::Cloud::Retail::V2::CompleteQueryRequest, ::Google::Cloud::Retail::V2::CompleteQueryResponse
+            # Bulk import of processed completion dataset.
+            #
+            # Request processing may be synchronous. Partial updating is not supported.
+            #
+            # This feature is only available for users who have Retail Search enabled.
+            # Please submit a form [here](https://cloud.google.com/contact) to contact
+            # cloud sales if you are interested in using Retail Search.
+            rpc :ImportCompletionData, ::Google::Cloud::Retail::V2::ImportCompletionDataRequest, ::Google::Longrunning::Operation
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

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

@@ -5,11 +5,13 @@ require 'google/protobuf'
 
 require 'google/api/annotations_pb'
 require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
 require 'google/cloud/retail/v2/product_pb'
 require 'google/cloud/retail/v2/user_event_pb'
 require 'google/protobuf/field_mask_pb'
 require 'google/protobuf/timestamp_pb'
 require 'google/rpc/status_pb'
+require 'google/type/date_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/retail/v2/import_config.proto", :syntax => :proto3) do
     add_message "google.cloud.retail.v2.GcsSource" do
@@ -22,6 +24,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :table_id, :string, 2
       optional :gcs_staging_dir, :string, 3
       optional :data_schema, :string, 4
+      oneof :partition do
+        optional :partition_date, :message, 6, "google.type.Date"
+      end
     end
     add_message "google.cloud.retail.v2.ProductInlineSource" do
       repeated :products, :message, 1, "google.cloud.retail.v2.Product"
@@ -36,15 +41,28 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     end
     add_message "google.cloud.retail.v2.ImportProductsRequest" do
       optional :parent, :string, 1
+      optional :request_id, :string, 6
       optional :input_config, :message, 2, "google.cloud.retail.v2.ProductInputConfig"
       optional :errors_config, :message, 3, "google.cloud.retail.v2.ImportErrorsConfig"
       optional :update_mask, :message, 4, "google.protobuf.FieldMask"
+      optional :reconciliation_mode, :enum, 5, "google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode"
+      optional :notification_pubsub_topic, :string, 7
+    end
+    add_enum "google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode" do
+      value :RECONCILIATION_MODE_UNSPECIFIED, 0
+      value :INCREMENTAL, 1
+      value :FULL, 2
     end
     add_message "google.cloud.retail.v2.ImportUserEventsRequest" do
       optional :parent, :string, 1
       optional :input_config, :message, 2, "google.cloud.retail.v2.UserEventInputConfig"
       optional :errors_config, :message, 3, "google.cloud.retail.v2.ImportErrorsConfig"
     end
+    add_message "google.cloud.retail.v2.ImportCompletionDataRequest" do
+      optional :parent, :string, 1
+      optional :input_config, :message, 2, "google.cloud.retail.v2.CompletionDataInputConfig"
+      optional :notification_pubsub_topic, :string, 3
+    end
     add_message "google.cloud.retail.v2.ProductInputConfig" do
       oneof :source do
         optional :product_inline_source, :message, 1, "google.cloud.retail.v2.ProductInlineSource"
@@ -59,11 +77,18 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
         optional :big_query_source, :message, 3, "google.cloud.retail.v2.BigQuerySource"
       end
     end
+    add_message "google.cloud.retail.v2.CompletionDataInputConfig" do
+      oneof :source do
+        optional :big_query_source, :message, 1, "google.cloud.retail.v2.BigQuerySource"
+      end
+    end
     add_message "google.cloud.retail.v2.ImportMetadata" do
       optional :create_time, :message, 1, "google.protobuf.Timestamp"
       optional :update_time, :message, 2, "google.protobuf.Timestamp"
       optional :success_count, :int64, 3
       optional :failure_count, :int64, 4
+      optional :request_id, :string, 5
+      optional :notification_pubsub_topic, :string, 6
     end
     add_message "google.cloud.retail.v2.ImportProductsResponse" do
       repeated :error_samples, :message, 1, "google.rpc.Status"
@@ -78,6 +103,9 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       optional :joined_events_count, :int64, 1
       optional :unjoined_events_count, :int64, 2
     end
+    add_message "google.cloud.retail.v2.ImportCompletionDataResponse" do
+      repeated :error_samples, :message, 1, "google.rpc.Status"
+    end
   end
 end
 
@@ -91,13 +119,17 @@ module Google
         UserEventInlineSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserEventInlineSource").msgclass
         ImportErrorsConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportErrorsConfig").msgclass
         ImportProductsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportProductsRequest").msgclass
+        ImportProductsRequest::ReconciliationMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode").enummodule
         ImportUserEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportUserEventsRequest").msgclass
+        ImportCompletionDataRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportCompletionDataRequest").msgclass
         ProductInputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ProductInputConfig").msgclass
         UserEventInputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserEventInputConfig").msgclass
+        CompletionDataInputConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CompletionDataInputConfig").msgclass
         ImportMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportMetadata").msgclass
         ImportProductsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportProductsResponse").msgclass
         ImportUserEventsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportUserEventsResponse").msgclass
         UserEventImportSummary = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserEventImportSummary").msgclass
+        ImportCompletionDataResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportCompletionDataResponse").msgclass
       end
     end
   end

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

@@ -41,13 +41,12 @@ module Google
             # See {::Google::Cloud::Retail::V2::PredictionService::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all PredictionService clients:
-            #
-            #     ::Google::Cloud::Retail::V2::PredictionService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all PredictionService clients
+            #   ::Google::Cloud::Retail::V2::PredictionService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -99,19 +98,15 @@ module Google
             ##
             # Create a new PredictionService client object.
             #
-            # ## Examples
-            #
-            # To create a new PredictionService client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Retail::V2::PredictionService::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Retail::V2::PredictionService::Client.new
             #
-            # To create a new PredictionService client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Retail::V2::PredictionService::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Retail::V2::PredictionService::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the PredictionService client.
             # @yieldparam config [Client::Configuration]
@@ -131,10 +126,9 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
@@ -176,30 +170,10 @@ module Google
             #   @param placement [::String]
             #     Required. Full resource name of the format:
             #     \\{name=projects/*/locations/global/catalogs/default_catalog/placements/*}
-            #     The id of the recommendation engine placement. This id is used to identify
-            #     the set of models that will be used to make the prediction.
-            #
-            #     We currently support three placements with the following IDs by default:
-            #
-            #     * `shopping_cart`: Predicts products frequently bought together with one or
-            #       more  products in the same shopping session. Commonly displayed after
-            #       `add-to-cart` events, on product detail pages, or on the shopping cart
-            #       page.
-            #
-            #     * `home_page`: Predicts the next product that a user will most likely
-            #       engage with or purchase based on the shopping or viewing history of the
-            #       specified `userId` or `visitorId`. For example - Recommendations for you.
-            #
-            #     * `product_detail`: Predicts the next product that a user will most likely
-            #       engage with or purchase. The prediction is based on the shopping or
-            #       viewing history of the specified `userId` or `visitorId` and its
-            #       relevance to a specified `CatalogItem`. Typically used on product detail
-            #       pages. For example - More products like this.
-            #
-            #     * `recently_viewed_default`: Returns up to 75 products recently viewed by
-            #       the specified `userId` or `visitorId`, most recent ones first. Returns
-            #       nothing if neither of them has viewed any products yet. For example -
-            #       Recently viewed.
+            #     The ID of the Recommendations AI placement. Before you can request
+            #     predictions from your model, you must create at least one placement for it.
+            #     For more information, see [Managing
+            #     placements](https://cloud.google.com/retail/recommendations-ai/docs/manage-placements).
             #
             #     The full list of available placements can be seen at
             #     https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
@@ -226,6 +200,9 @@ module Google
             #        `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
             #        with a size limit of 1,000 characters.
             #
+            #        Note: "Recently viewed" models don't support tag filtering at the
+            #        moment.
+            #
             #      * filterOutOfStockItems. Restricts predictions to products that do not
             #      have a
             #        stockState value of OUT_OF_STOCK.
@@ -260,16 +237,34 @@ module Google
             #     * `strictFiltering`: Boolean. True by default. If set to false, the service
             #        will return generic (unfiltered) popular products instead of empty if
             #        your filter blocks all prediction results.
+            #     * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
+            #        it needs to be one of {'no-price-reranking', 'low-price-reranking',
+            #        'medium-price-reranking', 'high-price-reranking'}. This gives
+            #        request-level control and adjusts prediction results based on product
+            #        price.
+            #     * `diversityLevel`: String. Default empty. If set to be non-empty, then
+            #        it needs to be one of {'no-diversity', 'low-diversity',
+            #        'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
+            #        request-level control and adjusts prediction results based on product
+            #        category.
             #   @param labels [::Hash{::String => ::String}]
-            #     The labels for the predict request.
-            #
-            #      * Label keys can contain lowercase letters, digits and hyphens, must start
-            #        with a letter, and must end with a letter or digit.
-            #      * Non-zero label values can contain lowercase letters, digits and hyphens,
-            #        must start with a letter, and must end with a letter or digit.
-            #      * No more than 64 labels can be associated with a given request.
-            #
-            #     See https://goo.gl/xmQnxf for more information on and examples of labels.
+            #     The labels applied to a resource must meet the following requirements:
+            #
+            #     * Each resource can have multiple labels, up to a maximum of 64.
+            #     * Each label must be a key-value pair.
+            #     * Keys have a minimum length of 1 character and a maximum length of 63
+            #       characters, and cannot be empty. Values can be empty, and have a maximum
+            #       length of 63 characters.
+            #     * Keys and values can contain only lowercase letters, numeric characters,
+            #       underscores, and dashes. All characters must use UTF-8 encoding, and
+            #       international characters are allowed.
+            #     * The key portion of a label must be unique. However, you can use the same
+            #       key with multiple resources.
+            #     * Keys must start with a lowercase letter or international character.
+            #
+            #     See [Google Cloud
+            #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+            #     for more details.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Retail::V2::PredictResponse]
@@ -305,7 +300,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.predict.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.predict.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @prediction_service_stub.call_rpc :predict, request, options: options do |response, operation|
@@ -329,22 +326,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for predict
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Retail::V2::PredictionService::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.predict.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Retail::V2::PredictionService::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.predict.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # predict to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Retail::V2::PredictionService::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.predict.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Retail::V2::PredictionService::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.predict.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.