Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client (v1.4.0)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client.

Client for the RecommendationService service.

Service for making recommendations.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the RecommendationService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all RecommendationService clients
::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the RecommendationService 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 Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#initialize

def initialize() { |config| ... } -> Client

Create a new RecommendationService client object.

Yields
  • (config) — Configure the RecommendationService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client.new do |config|
  config.timeout = 10.0
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#recommend

def recommend(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::RecommendResponse
def recommend(serving_config: nil, user_event: nil, page_size: nil, filter: nil, validate_only: nil, params: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1::RecommendResponse

Makes a recommendation, which requires a contextual user event.

Overloads 
def recommend(request, options = nil) -> ::Google::Cloud::DiscoveryEngine::V1::RecommendResponse
Pass arguments to recommend via a request object, either of type Google::Cloud::DiscoveryEngine::V1::RecommendRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::DiscoveryEngine::V1::RecommendRequest, ::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.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def recommend(serving_config: nil, user_event: nil, page_size: nil, filter: nil, validate_only: nil, params: nil, user_labels: nil) -> ::Google::Cloud::DiscoveryEngine::V1::RecommendResponse
Pass arguments to recommend 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).
Parameters
  • serving_config (::String) — Required. Full resource name of a [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]: projects/*/locations/global/collections/*/engines/*/servingConfigs/*, or projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*

    One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine projects/*/locations/global/collections/*/engines/my-engine, you can use projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine for your RecommendationService.Recommend requests.

  • user_event (::Google::Cloud::DiscoveryEngine::V1::UserEvent, ::Hash) — Required. Context about the user, what they are looking at and what action they took to trigger the Recommend 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 UserEvent.user_pseudo_id or UserEvent.user_info.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 UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset.

  • page_size (::Integer) — Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100.
  • filter (::String) — Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the filter_tags attribute is supported.

    Examples:

    • (filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))
    • (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))

    If attributeFilteringSyntax is set to true under the params field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples:

    • (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
    • (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

    If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set strictFiltering to true in RecommendRequest.params to receive empty results instead.

    Note that the API never returns Documents with storageStatus as EXPIRED or DELETED regardless of filter choices.

  • validate_only (::Boolean) — Use validate only mode for this recommendation query. If set to true, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
  • params (::Hash{::String => ::Google::Protobuf::Value, ::Hash}) —

    Additional domain specific parameters for the recommendations.

    Allowed values:

    • returnDocument: Boolean. If set to true, the associated Document object is returned in RecommendResponse.RecommendationResult.document.
    • returnScore: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history.
    • strictFiltering: Boolean. True by default. If set to false, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results.
    • 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 recommendation results based on Document category.
    • attributeFilteringSyntax: Boolean. False by default. If set to true, the filter field is interpreted according to the new, attribute-based syntax.
  • user_labels (::Hash{::String => ::String}) — The user 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 Requirements for labels for more details.

Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/discovery_engine/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DiscoveryEngine::V1::RecommendationService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DiscoveryEngine::V1::RecommendRequest.new

# Call the recommend method.
result = client.recommend request

# The returned object is of type Google::Cloud::DiscoveryEngine::V1::RecommendResponse.
p result

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)