class Google::Cloud::Retail::V2::PredictionService::Client

Client for the PredictionService service.

Service for making recommendation prediction.

Attributes

prediction_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the PredictionService Client class.

See {::Google::Cloud::Retail::V2::PredictionService::Client::Configuration} for a description of the configuration fields.

@example

# 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]

# File lib/google/cloud/retail/v2/prediction_service/client.rb, line 56
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
new() { |config| ... } click to toggle source

Create a new PredictionService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Retail::V2::PredictionService::Client.new

# 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]

# File lib/google/cloud/retail/v2/prediction_service/client.rb, line 114
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
  # 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 == Client.configure.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

  @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

Public Instance Methods

configure() { |config| ... } click to toggle source

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]

# File lib/google/cloud/retail/v2/prediction_service/client.rb, line 93
def configure
  yield @config if block_given?
  @config
end
predict(request, options = nil) { |response, operation| ... } click to toggle source

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 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
@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.

     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, 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.
  * `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 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] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Retail::V2::PredictResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/retail/v2/prediction_service/client.rb, line 277
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 timeout:      @config.timeout,
                         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