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.



757
758
759
 
# File 'lib/google/apis/retail_v2/classes.rb', line 757

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. * 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, nothing will be returned. If you want generic (unfiltered) popular products to be returned instead, set strictFiltering to false in PredictRequest.params. Corresponds to the JSON property filter

Returns:

  • (String) 


703
704
705
 
# File 'lib/google/apis/retail_v2/classes.rb', line 703

def filter
  @filter
end

#labels ⇒ Hash<String,String>

The labels for the predict request. * Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit. * No more than 64 labels can be associated with a given request. See https://goo.gl/ xmQnxf for more information on and examples of labels. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


713
714
715
 
# File 'lib/google/apis/retail_v2/classes.rb', line 713

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) 


721
722
723
 
# File 'lib/google/apis/retail_v2/classes.rb', line 721

def page_size
  @page_size
end

#page_token ⇒ String

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

Returns:

  • (String) 


726
727
728
 
# File 'lib/google/apis/retail_v2/classes.rb', line 726

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

Returns:

  • (Hash<String,Object>) 


740
741
742
 
# File 'lib/google/apis/retail_v2/classes.rb', line 740

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:



746
747
748
 
# File 'lib/google/apis/retail_v2/classes.rb', line 746

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) 


754
755
756
 
# File 'lib/google/apis/retail_v2/classes.rb', line 754

def validate_only
  @validate_only
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



762
763
764
765
766
767
768
769
770
 
# File 'lib/google/apis/retail_v2/classes.rb', line 762

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