Class: Google::Cloud::Retail::V2::SearchService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/retail/v2/search_service/rest/client.rb

Overview

REST client for the SearchService service.

Service for search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#branch_path

Constructor Details

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

Create a new SearchService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the SearchService client.

Yield Parameters:



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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/google/cloud/retail/v2/search_service/rest/client.rb', line 135

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

  @search_service_stub = ::Google::Cloud::Retail::V2::SearchService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @search_service_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @search_service_stub.endpoint
    config.universe_domain = @search_service_stub.universe_domain
    config.logger = @search_service_stub.logger if config.respond_to? :logger=
  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) 


190
191
192
 
# File 'lib/google/cloud/retail/v2/search_service/rest/client.rb', line 190

def location_client
  @location_client
end

Class Method Details

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

Configure the SearchService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all SearchService clients
::Google::Cloud::Retail::V2::SearchService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/google/cloud/retail/v2/search_service/rest/client.rb', line 68

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

Instance Method Details

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

Configure the SearchService 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:



105
106
107
108
 
# File 'lib/google/cloud/retail/v2/search_service/rest/client.rb', line 105

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


197
198
199
 
# File 'lib/google/cloud/retail/v2/search_service/rest/client.rb', line 197

def logger
  @search_service_stub.logger
end

#search(request, options = nil) ⇒ ::Google::Cloud::Retail::V2::SearchResponse #search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil, personalization_spec: nil, labels: nil, spell_correction_spec: nil, entity: nil, conversational_search_spec: nil, tile_navigation_spec: nil) ⇒ ::Google::Cloud::Retail::V2::SearchResponse

Performs a search.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Examples:

Basic example

require "google/cloud/retail/v2"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Retail::V2::SearchService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Retail::V2::SearchRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Retail::V2::SearchResponse::SearchResult.
  p item
end

Overloads:

  • #search(request, options = nil) ⇒ ::Google::Cloud::Retail::V2::SearchResponse

    Pass arguments to search via a request object, either of type Google::Cloud::Retail::V2::SearchRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Retail::V2::SearchRequest, ::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.

  • #search(placement: nil, branch: nil, query: nil, visitor_id: nil, user_info: nil, page_size: nil, page_token: nil, offset: nil, filter: nil, canonical_filter: nil, order_by: nil, facet_specs: nil, dynamic_facet_spec: nil, boost_spec: nil, query_expansion_spec: nil, variant_rollup_keys: nil, page_categories: nil, search_mode: nil, personalization_spec: nil, labels: nil, spell_correction_spec: nil, entity: nil, conversational_search_spec: nil, tile_navigation_spec: nil) ⇒ ::Google::Cloud::Retail::V2::SearchResponse

    Pass arguments to search 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:

    • placement (::String) (defaults to: nil) —

      Required. The resource name of the Retail Search serving config, such as projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config or the name of the legacy placement resource, such as projects/*/locations/global/catalogs/default_catalog/placements/default_search. This field is used to identify the serving config name and the set of models that are used to make the search.

    • branch (::String) (defaults to: nil) —

      The branch resource name, such as projects/*/locations/global/catalogs/default_catalog/branches/0.

      Use "default_branch" as the branch ID or leave this field empty, to search products under the default branch.

    • query (::String) (defaults to: nil) —

      Raw search query.

      If this field is empty, the request is considered a category browsing request and returned results are based on filter and page_categories.

    • visitor_id (::String) (defaults to: nil) —

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

      This should be the same identifier as UserEvent.visitor_id.

      The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

    • user_info (::Google::Cloud::Retail::V2::UserInfo, ::Hash) (defaults to: nil) —

      User information.

    • page_size (::Integer) (defaults to: nil) —

      Maximum number of Products to return. If unspecified, defaults to a reasonable value. The maximum allowed value is

      1. Values above 120 will be coerced to 120.

      If this field is negative, an INVALID_ARGUMENT is returned.

    • page_token (::String) (defaults to: nil) —

      A page token SearchResponse.next_page_token, received from a previous SearchService.Search call. Provide this to retrieve the subsequent page.

      When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

    • offset (::Integer) (defaults to: nil) —

      A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Products deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

      If this field is negative, an INVALID_ARGUMENT is returned.

    • filter (::String) (defaults to: nil) —

      The filter syntax consists of an expression language for constructing a predicate from one or more fields of the products being filtered. Filter expression is case-sensitive. For more information, see Filter.

      If this field is unrecognizable, an INVALID_ARGUMENT is returned.

    • canonical_filter (::String) (defaults to: nil) —

      The default filter that is applied when a user performs a search without checking any filters on the search page.

      The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality.

      For more information about filter syntax, see SearchRequest.filter.

    • order_by (::String) (defaults to: nil) —

      The order in which products are returned. Products can be ordered by a field in an Product object. Leave it unset if ordered by relevance. OrderBy expression is case-sensitive. For more information, see Order.

      If this field is unrecognizable, an INVALID_ARGUMENT is returned.

    • facet_specs (::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>) (defaults to: nil) —

      Facet specifications for faceted search. If empty, no facets are returned.

      A maximum of 200 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned.

    • dynamic_facet_spec (::Google::Cloud::Retail::V2::SearchRequest::DynamicFacetSpec, ::Hash) (defaults to: nil) —

      Deprecated. Refer to https://cloud.google.com/retail/docs/configs#dynamic to enable dynamic facets. Do not set this field.

      The specification for dynamically generated facets. Notice that only textual facets can be dynamically generated.

    • boost_spec (::Google::Cloud::Retail::V2::SearchRequest::BoostSpec, ::Hash) (defaults to: nil) —

      Boost specification to boost certain products. For more information, see Boost results.

      Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions.

    • query_expansion_spec (::Google::Cloud::Retail::V2::SearchRequest::QueryExpansionSpec, ::Hash) (defaults to: nil) —

      The query expansion specification that specifies the conditions under which query expansion occurs. For more information, see Query expansion.

    • variant_rollup_keys (::Array<::String>) (defaults to: nil) —

      The keys to fetch and rollup the matching variant Products attributes, FulfillmentInfo or LocalInventorys attributes. The attributes from all the matching variant Products or LocalInventorys are merged and de-duplicated. Notice that rollup attributes will lead to extra query latency. Maximum number of keys is 30.

      For FulfillmentInfo, a fulfillment type and a fulfillment ID must be provided in the format of "fulfillmentType.fulfillmentId". E.g., in "pickupInStore.store123", "pickupInStore" is fulfillment type and "store123" is the store ID.

      Supported keys are:

      If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned.

    • page_categories (::Array<::String>) (defaults to: nil) —

      The categories associated with a category page. Must be set for category navigation queries to achieve good search quality. The format should be the same as UserEvent.page_categories;

      To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s).

      Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: "pageCategories" : ["Sales > 2017 Black Friday Deals"].

    • search_mode (::Google::Cloud::Retail::V2::SearchRequest::SearchMode) (defaults to: nil) —

      The search mode of the search request. If not specified, a single search request triggers both product search and faceted search.

    • personalization_spec (::Google::Cloud::Retail::V2::SearchRequest::PersonalizationSpec, ::Hash) (defaults to: nil) —

      The specification for personalization.

      Notice that if both ServingConfig.personalization_spec and SearchRequest.personalization_spec are set. SearchRequest.personalization_spec will override ServingConfig.personalization_spec.

    • labels (::Hash{::String => ::String}) (defaults to: nil) —

      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.

      For more information, see Requirements for labels in the Resource Manager documentation.

    • spell_correction_spec (::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec, ::Hash) (defaults to: nil) —

      The spell correction specification that specifies the mode under which spell correction will take effect.

    • entity (::String) (defaults to: nil) —

      The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it should be exactly matched with UserEvent.entity to get search results boosted by entity.

    • conversational_search_spec (::Google::Cloud::Retail::V2::SearchRequest::ConversationalSearchSpec, ::Hash) (defaults to: nil) —

      Optional. This field specifies all conversational related parameters addition to traditional retail search.

    • tile_navigation_spec (::Google::Cloud::Retail::V2::SearchRequest::TileNavigationSpec, ::Hash) (defaults to: nil) —

      Optional. This field specifies tile navigation related parameters.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
 
# File 'lib/google/cloud/retail/v2/search_service/rest/client.rb', line 494

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

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

  # 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.search.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::Retail::V2::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.search.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.search.retry_policy

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

  @search_service_stub.search request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


115
116
117
 
# File 'lib/google/cloud/retail/v2/search_service/rest/client.rb', line 115

def universe_domain
  @search_service_stub.universe_domain
end