google-cloud-retail-v2 0.1.0

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

@@ -0,0 +1,51 @@
+# 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 "googleauth"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module CatalogService
+          # Credentials for the CatalogService API.
+          class Credentials < ::Google::Auth::Credentials
+            self.scope = [
+              "https://www.googleapis.com/auth/cloud-platform"
+            ]
+            self.env_vars = [
+              "RETAIL_CREDENTIALS",
+              "RETAIL_KEYFILE",
+              "GOOGLE_CLOUD_CREDENTIALS",
+              "GOOGLE_CLOUD_KEYFILE",
+              "GCLOUD_KEYFILE",
+              "RETAIL_CREDENTIALS_JSON",
+              "RETAIL_KEYFILE_JSON",
+              "GOOGLE_CLOUD_CREDENTIALS_JSON",
+              "GOOGLE_CLOUD_KEYFILE_JSON",
+              "GCLOUD_KEYFILE_JSON"
+            ]
+            self.paths = [
+              "~/.config/google_cloud/application_default_credentials.json"
+            ]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# 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 CatalogService
+          # Path helper methods for the CatalogService 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
+
+            ##
+            # Create a fully-qualified Location resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [::String]
+            def location_path project:, location:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
+            end
+
+            extend self
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/catalog_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/catalog_pb'
+require 'google/protobuf/empty_pb'
+require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/cloud/retail/v2/catalog_service.proto", :syntax => :proto3) do
+    add_message "google.cloud.retail.v2.ListCatalogsRequest" do
+      optional :parent, :string, 1
+      optional :page_size, :int32, 2
+      optional :page_token, :string, 3
+    end
+    add_message "google.cloud.retail.v2.ListCatalogsResponse" do
+      repeated :catalogs, :message, 1, "google.cloud.retail.v2.Catalog"
+      optional :next_page_token, :string, 2
+    end
+    add_message "google.cloud.retail.v2.UpdateCatalogRequest" do
+      optional :catalog, :message, 1, "google.cloud.retail.v2.Catalog"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        ListCatalogsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ListCatalogsRequest").msgclass
+        ListCatalogsResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ListCatalogsResponse").msgclass
+        UpdateCatalogRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UpdateCatalogRequest").msgclass
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/cloud/retail/v2/catalog_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/catalog_service_pb'
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module CatalogService
+          # Service for managing catalog configuration.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.cloud.retail.v2.CatalogService'
+
+            # Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with
+            # the project.
+            rpc :ListCatalogs, ::Google::Cloud::Retail::V2::ListCatalogsRequest, ::Google::Cloud::Retail::V2::ListCatalogsResponse
+            # Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
+            rpc :UpdateCatalog, ::Google::Cloud::Retail::V2::UpdateCatalogRequest, ::Google::Cloud::Retail::V2::Catalog
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/common.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/field_behavior_pb'
+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.CustomAttribute" do
+      repeated :text, :string, 1
+      repeated :numbers, :double, 2
+    end
+    add_message "google.cloud.retail.v2.Image" do
+      optional :uri, :string, 1
+      optional :height, :int32, 2
+      optional :width, :int32, 3
+    end
+    add_message "google.cloud.retail.v2.PriceInfo" do
+      optional :currency_code, :string, 1
+      optional :price, :float, 2
+      optional :original_price, :float, 3
+      optional :cost, :float, 4
+    end
+    add_message "google.cloud.retail.v2.UserInfo" do
+      optional :user_id, :string, 1
+      optional :ip_address, :string, 2
+      optional :user_agent, :string, 3
+      optional :direct_user_request, :bool, 4
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        CustomAttribute = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.CustomAttribute").msgclass
+        Image = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.Image").msgclass
+        PriceInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.PriceInfo").msgclass
+        UserInfo = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.UserInfo").msgclass
+      end
+    end
+  end
+end

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

@@ -0,0 +1,104 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/cloud/retail/v2/import_config.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/api/field_behavior_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'
+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
+      repeated :input_uris, :string, 1
+      optional :data_schema, :string, 2
+    end
+    add_message "google.cloud.retail.v2.BigQuerySource" do
+      optional :project_id, :string, 5
+      optional :dataset_id, :string, 1
+      optional :table_id, :string, 2
+      optional :gcs_staging_dir, :string, 3
+      optional :data_schema, :string, 4
+    end
+    add_message "google.cloud.retail.v2.ProductInlineSource" do
+      repeated :products, :message, 1, "google.cloud.retail.v2.Product"
+    end
+    add_message "google.cloud.retail.v2.UserEventInlineSource" do
+      repeated :user_events, :message, 1, "google.cloud.retail.v2.UserEvent"
+    end
+    add_message "google.cloud.retail.v2.ImportErrorsConfig" do
+      oneof :destination do
+        optional :gcs_prefix, :string, 1
+      end
+    end
+    add_message "google.cloud.retail.v2.ImportProductsRequest" do
+      optional :parent, :string, 1
+      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"
+    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.ProductInputConfig" do
+      oneof :source do
+        optional :product_inline_source, :message, 1, "google.cloud.retail.v2.ProductInlineSource"
+        optional :gcs_source, :message, 2, "google.cloud.retail.v2.GcsSource"
+        optional :big_query_source, :message, 3, "google.cloud.retail.v2.BigQuerySource"
+      end
+    end
+    add_message "google.cloud.retail.v2.UserEventInputConfig" do
+      oneof :source do
+        optional :user_event_inline_source, :message, 1, "google.cloud.retail.v2.UserEventInlineSource"
+        optional :gcs_source, :message, 2, "google.cloud.retail.v2.GcsSource"
+        optional :big_query_source, :message, 3, "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
+    end
+    add_message "google.cloud.retail.v2.ImportProductsResponse" do
+      repeated :error_samples, :message, 1, "google.rpc.Status"
+      optional :errors_config, :message, 2, "google.cloud.retail.v2.ImportErrorsConfig"
+    end
+    add_message "google.cloud.retail.v2.ImportUserEventsResponse" do
+      repeated :error_samples, :message, 1, "google.rpc.Status"
+      optional :errors_config, :message, 2, "google.cloud.retail.v2.ImportErrorsConfig"
+      optional :import_summary, :message, 3, "google.cloud.retail.v2.UserEventImportSummary"
+    end
+    add_message "google.cloud.retail.v2.UserEventImportSummary" do
+      optional :joined_events_count, :int64, 1
+      optional :unjoined_events_count, :int64, 2
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        GcsSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.GcsSource").msgclass
+        BigQuerySource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.BigQuerySource").msgclass
+        ProductInlineSource = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ProductInlineSource").msgclass
+        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
+        ImportUserEventsRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.cloud.retail.v2.ImportUserEventsRequest").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
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# 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/prediction_service/credentials"
+require "google/cloud/retail/v2/prediction_service/paths"
+require "google/cloud/retail/v2/prediction_service/client"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        ##
+        # Service for making recommendation prediction.
+        #
+        # To load this service and instantiate a client:
+        #
+        #     require "google/cloud/retail/v2/prediction_service"
+        #     client = ::Google::Cloud::Retail::V2::PredictionService::Client.new
+        #
+        module PredictionService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "prediction_service", "helpers.rb"
+require "google/cloud/retail/v2/prediction_service/helpers" if ::File.file? helper_path

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

@@ -0,0 +1,472 @@
+# 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 "google/cloud/errors"
+require "google/cloud/retail/v2/prediction_service_pb"
+
+module Google
+  module Cloud
+    module Retail
+      module V2
+        module PredictionService
+          ##
+          # Client for the PredictionService service.
+          #
+          # Service for making recommendation prediction.
+          #
+          class Client
+            include Paths
+
+            # @private
+            attr_reader :prediction_service_stub
+
+            ##
+            # Configure the PredictionService Client class.
+            #
+            # See {::Google::Cloud::Retail::V2::PredictionService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # ## Example
+            #
+            # To 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]
+            #
+            # @return [Client::Configuration]
+            #
+            def self.configure
+              @configure ||= begin
+                namespace = ["Google", "Cloud", "Retail", "V2"]
+                parent_config = while namespace.any?
+                                  parent_name = namespace.join "::"
+                                  parent_const = const_get parent_name
+                                  break parent_const.configure if parent_const&.respond_to? :configure
+                                  namespace.pop
+                                end
+                default_config = Client::Configuration.new parent_config
+
+                default_config.timeout = 60.0
+                default_config.retry_policy = {
+                  initial_delay: 0.1,
+                  max_delay:     60.0,
+                  multiplier:    1.3,
+                  retry_codes:   [14, 4]
+                }
+
+                default_config
+              end
+              yield @configure if block_given?
+              @configure
+            end
+
+            ##
+            # Configure the PredictionService Client instance.
+            #
+            # The configuration is set to the derived mode, meaning that values can be changed,
+            # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+            # should be made on {Client.configure}.
+            #
+            # See {::Google::Cloud::Retail::V2::PredictionService::Client::Configuration}
+            # for a description of the configuration fields.
+            #
+            # @yield [config] Configure the Client client.
+            # @yieldparam config [Client::Configuration]
+            #
+            # @return [Client::Configuration]
+            #
+            def configure
+              yield @config if block_given?
+              @config
+            end
+
+            ##
+            # Create a new PredictionService client object.
+            #
+            # ## Examples
+            #
+            # To create a new PredictionService client with 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
+            #
+            # @yield [config] Configure the PredictionService client.
+            # @yieldparam config [Client::Configuration]
+            #
+            def initialize
+              # These require statements are intentionally placed here to initialize
+              # the gRPC module only when it's required.
+              # See https://github.com/googleapis/toolkit/issues/446
+              require "gapic/grpc"
+              require "google/cloud/retail/v2/prediction_service_services_pb"
+
+              # Create the configuration object
+              @config = Configuration.new Client.configure
+
+              # Yield the configuration if needed
+              yield @config if block_given?
+
+              # Create credentials
+              credentials = @config.credentials
+              credentials ||= Credentials.default scope: @config.scope
+              if credentials.is_a?(String) || credentials.is_a?(Hash)
+                credentials = Credentials.new credentials, scope: @config.scope
+              end
+              @quota_project_id = @config.quota_project
+              @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+              @prediction_service_stub = ::Gapic::ServiceStub.new(
+                ::Google::Cloud::Retail::V2::PredictionService::Stub,
+                credentials:  credentials,
+                endpoint:     @config.endpoint,
+                channel_args: @config.channel_args,
+                interceptors: @config.interceptors
+              )
+            end
+
+            # Service calls
+
+            ##
+            # Makes a recommendation prediction.
+            #
+            # @overload predict(request, options = nil)
+            #   Pass arguments to `predict` via a request object, either of type
+            #   {::Google::Cloud::Retail::V2::PredictRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Retail::V2::PredictRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload predict(placement: nil, user_event: nil, page_size: nil, page_token: nil, filter: nil, validate_only: nil, params: nil, labels: nil)
+            #   Pass arguments to `predict` 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 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 full list of available placements can be seen at
+            #     https://console.cloud.google.com/recommendation/catalogs/default_catalog/placements
+            #   @param user_event [::Google::Cloud::Retail::V2::UserEvent, ::Hash]
+            #     Required. Context about the user, what they are looking at and what action
+            #     they took to trigger the predict request. Note that this user event detail
+            #     won't be ingested to userEvent logs. Thus, a separate userEvent write
+            #     request is required for event logging.
+            #   @param page_size [::Integer]
+            #     Maximum number of results to return per page. Set this property
+            #     to the number of prediction results needed. If zero, the service will
+            #     choose a reasonable default. The maximum allowed value is 100. Values
+            #     above 100 will be coerced to 100.
+            #   @param page_token [::String]
+            #     The previous PredictResponse.next_page_token.
+            #   @param filter [::String]
+            #     Filter for restricting prediction results with a length limit of 5,000
+            #     characters. Accepts values for tags and the `filterOutOfStockItems` flag.
+            #
+            #      * Tag expressions. Restricts predictions to products that match all of the
+            #        specified tags. Boolean operators `OR` and `NOT` are supported if the
+            #        expression is enclosed in parentheses, and must be separated from the
+            #        tag values by a space. `-"tagA"` is also supported and is equivalent to
+            #        `NOT "tagA"`. Tag values must be double quoted UTF-8 encoded strings
+            #        with a size limit of 1,000 characters.
+            #
+            #      * filterOutOfStockItems. Restricts predictions to products that do not
+            #      have a
+            #        stockState value of OUT_OF_STOCK.
+            #
+            #     Examples:
+            #
+            #      * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
+            #      * filterOutOfStockItems  tag=(-"promotional")
+            #      * filterOutOfStockItems
+            #
+            #     If your filter blocks all prediction results, nothing will be returned. If
+            #     you want generic (unfiltered) popular products to be returned instead, set
+            #     `strictFiltering` to false in `PredictRequest.params`.
+            #   @param validate_only [::Boolean]
+            #     Use validate only mode for this prediction query. If set to true, a
+            #     dummy model will be used that returns arbitrary products.
+            #     Note that the validate only mode should only be used for testing the API,
+            #     or if the model is not ready.
+            #   @param params [::Hash{::String => ::Google::Protobuf::Value, ::Hash}]
+            #     Additional domain specific parameters for the predictions.
+            #
+            #     Allowed values:
+            #
+            #     * `returnProduct`: Boolean. If set to true, the associated product
+            #        object will be returned in the `results.metadata` field in the
+            #        prediction response.
+            #     * `returnScore`: Boolean. If set to true, the prediction 'score'
+            #        corresponding to each returned product will be set in the
+            #        `results.metadata` field in the prediction response. The given
+            #        'score' indicates the probability of an product being clicked/purchased
+            #        given the user's context and history.
+            #     * `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.
+            #   @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.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::Retail::V2::PredictResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::Retail::V2::PredictResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            def predict request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::PredictRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.predict.metadata.to_h
+
+              # Set x-goog-api-client and x-goog-user-project headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Retail::V2::VERSION
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {
+                "placement" => request.placement
+              }
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.predict.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.predict.retry_policy
+              options.apply_defaults metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @prediction_service_stub.call_rpc :predict, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # Configuration class for the PredictionService API.
+            #
+            # This class represents the configuration for PredictionService,
+            # providing control over timeouts, retry behavior, logging, transport
+            # parameters, and other low-level controls. Certain parameters can also be
+            # applied individually to specific RPCs. See
+            # {::Google::Cloud::Retail::V2::PredictionService::Client::Configuration::Rpcs}
+            # for a list of RPCs that can be configured independently.
+            #
+            # 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
+            #
+            # @!attribute [rw] endpoint
+            #   The hostname or hostname:port of the service endpoint.
+            #   Defaults to `"retail.googleapis.com"`.
+            #   @return [::String]
+            # @!attribute [rw] credentials
+            #   Credentials to send with calls. You may provide any of the following types:
+            #    *  (`String`) The path to a service account key file in JSON format
+            #    *  (`Hash`) A service account key as a Hash
+            #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+            #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+            #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+            #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+            #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
+            #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
+            #    *  (`nil`) indicating no credentials
+            #   @return [::Object]
+            # @!attribute [rw] scope
+            #   The OAuth scopes
+            #   @return [::Array<::String>]
+            # @!attribute [rw] lib_name
+            #   The library name as recorded in instrumentation and logging
+            #   @return [::String]
+            # @!attribute [rw] lib_version
+            #   The library version as recorded in instrumentation and logging
+            #   @return [::String]
+            # @!attribute [rw] channel_args
+            #   Extra parameters passed to the gRPC channel. Note: this is ignored if a
+            #   `GRPC::Core::Channel` object is provided as the credential.
+            #   @return [::Hash]
+            # @!attribute [rw] interceptors
+            #   An array of interceptors that are run before calls are executed.
+            #   @return [::Array<::GRPC::ClientInterceptor>]
+            # @!attribute [rw] timeout
+            #   The call timeout in seconds.
+            #   @return [::Numeric]
+            # @!attribute [rw] metadata
+            #   Additional gRPC headers to be sent with the call.
+            #   @return [::Hash{::Symbol=>::String}]
+            # @!attribute [rw] retry_policy
+            #   The retry policy. The value is a hash with the following keys:
+            #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+            #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+            #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+            #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+            #       trigger a retry.
+            #   @return [::Hash]
+            # @!attribute [rw] quota_project
+            #   A separate project against which to charge quota.
+            #   @return [::String]
+            #
+            class Configuration
+              extend ::Gapic::Config
+
+              config_attr :endpoint,      "retail.googleapis.com", ::String
+              config_attr :credentials,   nil do |value|
+                allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
+                allowed.any? { |klass| klass === value }
+              end
+              config_attr :scope,         nil, ::String, ::Array, nil
+              config_attr :lib_name,      nil, ::String, nil
+              config_attr :lib_version,   nil, ::String, nil
+              config_attr(:channel_args,  { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
+              config_attr :interceptors,  nil, ::Array, nil
+              config_attr :timeout,       nil, ::Numeric, nil
+              config_attr :metadata,      nil, ::Hash, nil
+              config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+              config_attr :quota_project, nil, ::String, nil
+
+              # @private
+              def initialize parent_config = nil
+                @parent_config = parent_config unless parent_config.nil?
+
+                yield self if block_given?
+              end
+
+              ##
+              # Configurations for individual RPCs
+              # @return [Rpcs]
+              #
+              def rpcs
+                @rpcs ||= begin
+                  parent_rpcs = nil
+                  parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config&.respond_to?(:rpcs)
+                  Rpcs.new parent_rpcs
+                end
+              end
+
+              ##
+              # Configuration RPC class for the PredictionService API.
+              #
+              # Includes fields providing the configuration for each RPC in this service.
+              # Each configuration object is of type `Gapic::Config::Method` and includes
+              # the following configuration fields:
+              #
+              #  *  `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
+              #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
+              #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+              #     include the following keys:
+              #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #         trigger a retry.
+              #
+              class Rpcs
+                ##
+                # RPC-specific configuration for `predict`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :predict
+
+                # @private
+                def initialize parent_rpcs = nil
+                  predict_config = parent_rpcs&.predict if parent_rpcs&.respond_to? :predict
+                  @predict = ::Gapic::Config::Method.new predict_config
+
+                  yield self if block_given?
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end