class Google::Cloud::RecommendationEngine::V1beta1::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::RecommendationEngine::V1beta1::PredictionService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all PredictionService clients
::Google::Cloud::RecommendationEngine::V1beta1::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/recommendation_engine/v1beta1/prediction_service/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "RecommendationEngine", "V1beta1"]
    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.rpcs.predict.timeout = 600.0
    default_config.rpcs.predict.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
new() { |config| ... } click to toggle source

Create a new PredictionService client object.

@example

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

# Create a client using a custom configuration
client = ::Google::Cloud::RecommendationEngine::V1beta1::PredictionService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the PredictionService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/recommendation_engine/v1beta1/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/recommendationengine/v1beta1/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::RecommendationEngine::V1beta1::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::RecommendationEngine::V1beta1::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/recommendation_engine/v1beta1/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. If using API Key based authentication, the API Key must be registered using the {::Google::Cloud::RecommendationEngine::V1beta1::PredictionApiKeyRegistry::Client PredictionApiKeyRegistry} service. [Learn more](/recommendations-ai/docs/setting-up#register-key).

@overload predict(request, options = nil)

Pass arguments to `predict` via a request object, either of type
{::Google::Cloud::RecommendationEngine::V1beta1::PredictRequest} or an equivalent Hash.

@param request [::Google::Cloud::RecommendationEngine::V1beta1::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(name: nil, user_event: nil, page_size: nil, page_token: nil, filter: nil, dry_run: 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 name [::String]
  Required. Full resource name of the format:
  `{name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/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 items frequently bought together with one or
    more catalog items 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 items like this.

  * `recently_viewed_default`: Returns up to 75 items recently viewed by the
    specified `userId` or `visitorId`, most recent ones first. Returns
    nothing if neither of them has viewed any items yet. For example -
    Recently viewed.

  The full list of available placements can be seen at
  https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard
@param user_event [::Google::Cloud::RecommendationEngine::V1beta1::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]
  Optional. Maximum number of results to return per page. Set this property
  to the number of prediction results required. If zero, the service will
  choose a reasonable default.
@param page_token [::String]
  Optional. The previous PredictResponse.next_page_token.
@param filter [::String]
  Optional. Filter for restricting prediction results. Accepts values for
  tags and the `filterOutOfStockItems` flag.

   * Tag expressions. Restricts predictions to items 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 KiB.

   * filterOutOfStockItems. Restricts predictions to items 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
@param dry_run [::Boolean]
  Optional. Use dryRun mode for this prediction query. If set to true, a
  dummy model will be used that returns arbitrary catalog items.
  Note that the dryRun mode should only be used for testing the API, or if
  the model is not ready.
@param params [::Hash{::String => ::Google::Protobuf::Value, ::Hash}]
  Optional. Additional domain specific parameters for the predictions.

  Allowed values:

  * `returnCatalogItem`: Boolean. If set to true, the associated catalogItem
     object will be returned in the
    `PredictResponse.PredictionResult.itemMetadata` object in the method
     response.
  * `returnItemScore`: Boolean. If set to true, the prediction 'score'
     corresponding to each returned item will be set in the `metadata`
     field in the prediction response. The given 'score' indicates the
     probability of an item being clicked/purchased given the user's context
     and history.
@param labels [::Hash{::String => ::String}]
  Optional. 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 [::Gapic::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::PredictResponse::PredictionResult>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::RecommendationEngine::V1beta1::PredictResponse::PredictionResult>]

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

# File lib/google/cloud/recommendation_engine/v1beta1/prediction_service/client.rb, line 271
def predict request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::RecommendationEngine::V1beta1::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::RecommendationEngine::V1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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|
    response = ::Gapic::PagedEnumerable.new @prediction_service_stub, :predict, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end