class Google::Cloud::Retail::V2::CompletionService::Client

Client for the CompletionService service.

Auto-completion service for retail.

This feature is only available for users who have Retail Search enabled. Please submit a form [here](cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.

Attributes

completion_service_stub[R]

@private

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::Retail::V2::CompletionService::Operations]

Public Class Methods

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

Configure the CompletionService Client class.

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

@example

# Modify the configuration for all CompletionService clients
::Google::Cloud::Retail::V2::CompletionService::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/completion_service/client.rb, line 60
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 CompletionService client object.

@example

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

# Create a client using a custom configuration
client = ::Google::Cloud::Retail::V2::CompletionService::Client.new do |config|
  config.timeout = 10.0
end

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

# File lib/google/cloud/retail/v2/completion_service/client.rb, line 118
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/completion_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

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.endpoint = @config.endpoint
  end

  @completion_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Retail::V2::CompletionService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

complete_query(request, options = nil) { |response, operation| ... } click to toggle source

Completes the specified prefix with keyword suggestions.

This feature is only available for users who have Retail Search enabled. Please submit a form [here](cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.

@overload complete_query(request, options = nil)

Pass arguments to `complete_query` via a request object, either of type
{::Google::Cloud::Retail::V2::CompleteQueryRequest} or an equivalent Hash.

@param request [::Google::Cloud::Retail::V2::CompleteQueryRequest, ::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 complete_query(catalog: nil, query: nil, visitor_id: nil, language_codes: nil, device_type: nil, dataset: nil, max_suggestions: nil)

Pass arguments to `complete_query` 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 catalog [::String]
  Required. Catalog for which the completion is performed.

  Full resource name of catalog, such as
  `projects/*/locations/global/catalogs/default_catalog`.
@param query [::String]
  Required. The query used to generate suggestions.

  The maximum number of allowed characters is 255.
@param visitor_id [::String]
  A unique identifier for tracking visitors. For example, this could be
  implemented with an HTTP cookie, which should be able to uniquely identify
  a visitor on a single device. This unique identifier should not change if
  the visitor logs in or out of the website.

  The field must be a UTF-8 encoded string with a length limit of 128
  characters. Otherwise, an INVALID_ARGUMENT error is returned.
@param language_codes [::Array<::String>]
  The list of languages of the query. This is
  the BCP-47 language code, such as "en-US" or "sr-Latn".
  For more information, see
  [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47).

  The maximum number of allowed characters is 255.
  Only "en-US" is currently supported.
@param device_type [::String]
  The device type context for completion suggestions.
  It is useful to apply different suggestions on different device types, e.g.
  DESKTOP, MOBILE. If it is empty, the suggestions are across all device
  types.

  Supported formats:

  * UNKNOWN_DEVICE_TYPE

  * DESKTOP

  * MOBILE

  * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
@param dataset [::String]
  Determines which dataset to use for fetching completion. "user-data" will
  use the imported dataset through
  {::Google::Cloud::Retail::V2::CompletionService::Client#import_completion_data CompletionService.ImportCompletionData}.
  "cloud-retail" will use the dataset generated by cloud retail based on user
  events. If leave empty, it will use the "user-data".

  Current supported values:

  * user-data

  * cloud-retail
    This option requires additional allowlisting. Before using cloud-retail,
    contact Cloud Retail support team first.
@param max_suggestions [::Integer]
  Completion max suggestions. If left unset or set to 0, then will fallback
  to the configured value [CompletionConfig.max_suggestions][].

  The maximum allowed max suggestions is 20. If it is set higher, it will be
  capped by 20.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Retail::V2::CompleteQueryResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

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

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

# File lib/google/cloud/retail/v2/completion_service/client.rb, line 259
def complete_query request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::CompleteQueryRequest

  # 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.complete_query.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 = {
    "catalog" => request.catalog
  }
  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.complete_query.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.complete_query.retry_policy

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

  @completion_service_stub.call_rpc :complete_query, 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
configure() { |config| ... } click to toggle source

Configure the CompletionService 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::CompletionService::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/completion_service/client.rb, line 97
def configure
  yield @config if block_given?
  @config
end
import_completion_data(request, options = nil) { |response, operation| ... } click to toggle source

Bulk import of processed completion dataset.

Request processing may be synchronous. Partial updating is not supported.

This feature is only available for users who have Retail Search enabled. Please submit a form [here](cloud.google.com/contact) to contact cloud sales if you are interested in using Retail Search.

@overload import_completion_data(request, options = nil)

Pass arguments to `import_completion_data` via a request object, either of type
{::Google::Cloud::Retail::V2::ImportCompletionDataRequest} or an equivalent Hash.

@param request [::Google::Cloud::Retail::V2::ImportCompletionDataRequest, ::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 import_completion_data(parent: nil, input_config: nil, notification_pubsub_topic: nil)

Pass arguments to `import_completion_data` 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 parent [::String]
  Required. The catalog which the suggestions dataset belongs to.

  Format: `projects/1234/locations/global/catalogs/default_catalog`.
@param input_config [::Google::Cloud::Retail::V2::CompletionDataInputConfig, ::Hash]
  Required. The desired input location of the data.
@param notification_pubsub_topic [::String]
  Pub/Sub topic for receiving notification. If this field is set,
  when the import is finished, a notification will be sent to
  specified Pub/Sub topic. The message data will be JSON string of a
  {::Google::Longrunning::Operation Operation}.
  Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

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

# File lib/google/cloud/retail/v2/completion_service/client.rb, line 343
def import_completion_data request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Retail::V2::ImportCompletionDataRequest

  # 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.import_completion_data.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 = {
    "parent" => request.parent
  }
  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.import_completion_data.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.import_completion_data.retry_policy

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

  @completion_service_stub.call_rpc :import_completion_data, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end