Class: Google::Cloud::DiscoveryEngine::V1::RecommendationService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb

Overview

REST client for the RecommendationService service.

Service for making recommendations.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#data_store_path, #document_path, #engine_path, #serving_config_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new RecommendationService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Rest::Client.new

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

Yields:

  • (config) —

    Configure the RecommendationService client.

Yield Parameters:



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb', line 132

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.nil? ||
                           (@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

  @recommendation_service_stub = ::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @recommendation_service_stub.endpoint
    config.universe_domain = @recommendation_service_stub.universe_domain
  end
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

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

Returns:

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


175
176
177
 
# File 'lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb', line 175

def location_client
  @location_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the RecommendationService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all RecommendationService clients
::Google::Cloud::DiscoveryEngine::V1::RecommendationService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DiscoveryEngine", "V1"]
    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]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



102
103
104
105
 
# File 'lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#recommend(request, options = nil) ⇒ ::Google::Cloud::DiscoveryEngine::V1::RecommendResponse #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.

Examples:

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::Rest::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

Overloads:

  • #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) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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) (defaults to: nil) —

      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}) (defaults to: nil) —

      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}) (defaults to: nil) —

      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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb', line 336

def recommend request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::RecommendRequest

  # 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.recommend.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::DiscoveryEngine::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.recommend.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.recommend.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb', line 112

def universe_domain
  @recommendation_service_stub.universe_domain
end