Class: Google::Apis::RetailV2::GoogleCloudRetailV2PredictRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

Request message for Predict method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2PredictRequest

Returns a new instance of GoogleCloudRetailV2PredictRequest.



1488
1489
1490
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1488

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#filter ⇒ String

Filter for restricting prediction results with a length limit of 5,000 characters. Accepts values for tags and the filterOutOfStockItems flag. * Tag expressions. Restricts predictions to products that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. -"tagA" is also supported and is equivalent to NOT "tagA" . Tag values must be double quoted UTF-8 encoded strings with a size limit of 1,000 characters. Note: "Recently viewed" models don't support tag filtering at the moment. * filterOutOfStockItems. Restricts predictions to products that do not have a stockState value of OUT_OF_STOCK. Examples: * tag=("Red" OR " Blue") tag="New-Arrival" tag=(NOT "promotional") * filterOutOfStockItems tag=(- "promotional") * filterOutOfStockItems If your filter blocks all prediction results, the API will return generic (unfiltered) popular products. If you only want results strictly matching the filters, set strictFiltering to True in PredictRequest.params to receive empty results instead. Note that the API will never return items with storageStatus of "EXPIRED" or "DELETED" regardless of filter choices. If filterSyntaxV2 is set to true under the params field, then attribute based expressions are expected instead of the above described tag-based syntax. Examples: * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones")) * (availability: ANY("IN_STOCK")) AND (colors: ANY("Red") OR categories: ANY("Phones")) Corresponds to the JSON property filter

Returns:

  • (String) 


1420
1421
1422
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1420

def filter
  @filter
end

#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. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1435
1436
1437
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1435

def labels
  @labels
end

#page_size ⇒ Fixnum

Maximum number of results to return per page. Set this property to the number of prediction results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


1443
1444
1445
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1443

def page_size
  @page_size
end

#page_token ⇒ String

The previous PredictResponse.next_page_token. Corresponds to the JSON property pageToken

Returns:

  • (String) 


1448
1449
1450
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1448

def page_token
  @page_token
end

#params ⇒ Hash<String,Object>

Additional domain specific parameters for the predictions. Allowed values: * returnProduct: Boolean. If set to true, the associated product object will be returned in the results.metadata field in the prediction response. * returnScore: Boolean. If set to true, the prediction 'score' corresponding to each returned product will be set in the results.metadata field in the prediction response. The given 'score' indicates the probability of an product being clicked/purchased given the user's context and history. * strictFiltering: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular products instead of empty if your filter blocks all prediction results. * priceRerankLevel: String. Default empty. If set to be non-empty, then it needs to be one of 'no-price-reranking', 'low- price-reranking', 'medium-price-reranking', 'high-price-reranking'. This gives request-level control and adjusts prediction results based on product price. * 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 prediction results based on product category. * filterSyntaxV2: Boolean. False by default. If set to true, the filter field will be interpreteted according to the new, attribute-based syntax. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


1471
1472
1473
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1471

def params
  @params
end

#user_event ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2UserEvent

UserEvent captures all metadata information Retail API needs to know about how end users interact with customers' website. Corresponds to the JSON property userEvent

Returns:



1477
1478
1479
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1477

def user_event
  @user_event
end

#validate_only ⇒ Boolean Also known as: validate_only?

Use validate only mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary products. Note that the validate only mode should only be used for testing the API, or if the model is not ready. Corresponds to the JSON property validateOnly

Returns:

  • (Boolean) 


1485
1486
1487
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1485

def validate_only
  @validate_only
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1493
1494
1495
1496
1497
1498
1499
1500
1501
 
# File 'lib/google/apis/retail_v2/classes.rb', line 1493

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @labels = args[:labels] if args.key?(:labels)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @params = args[:params] if args.key?(:params)
  @user_event = args[:user_event] if args.key?(:user_event)
  @validate_only = args[:validate_only] if args.key?(:validate_only)
end