Retail V2 API - Class Google::Cloud::Retail::V2::SearchService::Rest::Client (v0.17.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::SearchService::Rest::Client.

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.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the SearchService 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 SearchService clients
::Google::Cloud::Retail::V2::SearchService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def 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 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 SearchService REST client object.

Yields
  • (config) — Configure the SearchService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# 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

#location_client

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

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

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

#search

def search(request, options = nil) -> ::Google::Cloud::Retail::V2::SearchResponse
def 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) -> ::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.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional. 
def 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) -> ::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) — 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 will be used to make the search.
  • branch (::String) — 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) — 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) — 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) — User information.
  • page_size (::Integer) — 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) — 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) — 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) — 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. See more details at this user guide.

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

  • canonical_filter (::String) — 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. For example, if a query does not have enough results, an expanded query with SearchRequest.canonical_filter will be returned as a supplement of the original query. This field is strongly recommended to achieve high search quality.

    See SearchRequest.filter for more details about filter syntax.

  • order_by (::String) — 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. See more details at this user guide.

    If this field is unrecognizable, an INVALID_ARGUMENT is returned.

  • facet_specs (::Array<::Google::Cloud::Retail::V2::SearchRequest::FacetSpec, ::Hash>) — 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) — 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) — Boost specification to boost certain products. See more details at this user guide.

    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) — The query expansion specification that specifies the conditions under which query expansion will occur. See more details at this user guide.
  • variant_rollup_keys (::Array<::String>) — 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>) — The categories associated with a category page. Required 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) — 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) — 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}) — 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.

    See Google Cloud Document for more details.

  • spell_correction_spec (::Google::Cloud::Retail::V2::SearchRequest::SpellCorrectionSpec, ::Hash) — The spell correction specification that specifies the mode under which spell correction will take effect.
  • entity (::String) — 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.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the REST call is aborted.
Example

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