# frozen_string_literal: true # Copyright 2023 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Auto-generated by gapic-generator-ruby. DO NOT EDIT! require "google/cloud/errors" require "google/cloud/retail/v2/prediction_service_pb" require "google/cloud/retail/v2/prediction_service/rest/service_stub" require "google/cloud/location/rest" module Google module Cloud module Retail module V2 module PredictionService module Rest ## # REST 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::Rest::Client::Configuration} # for a description of the configuration fields. # # @example # # # Modify the configuration for all PredictionService clients # ::Google::Cloud::Retail::V2::PredictionService::Rest::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 = 5.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 5.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::Rest::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 REST client object. # # @example # # # Create a client using the default configuration # client = ::Google::Cloud::Retail::V2::PredictionService::Rest::Client.new # # # Create a client using a custom configuration # client = ::Google::Cloud::Retail::V2::PredictionService::Rest::Client.new do |config| # config.timeout = 10.0 # end # # @yield [config] Configure the PredictionService client. # @yieldparam config [Client::Configuration] # def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # 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.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt 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 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @prediction_service_stub = ::Google::Cloud::Retail::V2::PredictionService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end ## # Get the associated client for mix-in of the Locations. # # @return [Google::Cloud::Location::Locations::Rest::Client] # attr_reader :location_client # 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: # `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}` # or # `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`. # We recommend using the `servingConfigs` resource. `placements` is a legacy # resource. # The ID of the Recommendations AI serving config or placement. # Before you can request predictions from your model, you must create at # least one serving config or placement for it. For more information, see # [Manage serving configs] # (https://cloud.google.com/retail/docs/manage-configs). # # The full list of available serving configs can be seen at # https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs # @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. # # Don't set # {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} or # {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} to the same # fixed ID for different users. If you are trying to receive non-personalized # recommendations (not recommended; this can negatively impact model # performance), instead set # {::Google::Cloud::Retail::V2::UserEvent#visitor_id UserEvent.visitor_id} to a # random unique ID and leave # {::Google::Cloud::Retail::V2::UserInfo#user_id UserInfo.user_id} unset. # @param page_size [::Integer] # Maximum number of results to return. 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] # This field is not used; leave it unset. # @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. # # 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. # # Examples: # # * tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional") # * filterOutOfStockItems tag=(-"promotional") # * filterOutOfStockItems # # If your filter blocks all prediction results, the API will return *no* # results. If instead you want empty result sets to return generic # (unfiltered) popular products, set `strictFiltering` to False in # `PredictRequest.params`. Note that the API will never return items with # storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. # # If `filterSyntaxV2` is set to true under the `params` field, then # attribute-based expressions are expected instead of the above described # tag-based syntax. Examples: # # * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones")) # * (availability: ANY("IN_STOCK")) AND # (colors: ANY("Red") OR categories: ANY("Phones")) # # For more information, see # [Filter recommendations](https://cloud.google.com/retail/docs/filter-recs). # @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 a 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. # * `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. # * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter` # field is interpreteted according to the new, attribute-based syntax. # @param labels [::Hash{::String => ::String}] # 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 [result, operation] Access the result along with the TransportOperation object # @yieldparam result [::Google::Cloud::Retail::V2::PredictResponse] # @yieldparam operation [::Gapic::Rest::TransportOperation] # # @return [::Google::Cloud::Retail::V2::PredictResponse] # # @raise [::Google::Cloud::Error] if the REST call 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 call_metadata = @config.rpcs.predict.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers call_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, transports_version_send: [:rest] call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id options.apply_defaults timeout: @config.rpcs.predict.timeout, metadata: call_metadata, retry_policy: @config.rpcs.predict.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @prediction_service_stub.predict request, options do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the PredictionService REST API. # # This class represents the configuration for PredictionService REST, # 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::Rest::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. # # @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::Rest::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::Rest::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://rubydoc.info/gems/googleauth/Google/Auth/Credentials)) # * (`Signet::OAuth2::Client`) A signet oauth2 client object # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client)) # * (`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] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata # Additional 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`) - 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 DEFAULT_ENDPOINT = "retail.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] 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 :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 seconds # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional 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`) - 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 end