Class: Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictRequest

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

Overview

Request message for Predict method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommendationengineV1beta1PredictRequest

Returns a new instance of GoogleCloudRecommendationengineV1beta1PredictRequest.



1045
1046
1047
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1045

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

Instance Attribute Details

#dry_run ⇒ Boolean Also known as: dry_run?

Optional. Use dryRun mode for this prediction query. If set to true, a fake model will be used that returns arbitrary catalog items. Note that the dryRun mode should only be used for testing the API, or if the model is not ready. Corresponds to the JSON property dryRun

Returns:

  • (Boolean) 


976
977
978
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 976

def dry_run
  @dry_run
end

#filter ⇒ String

Optional. Filter for restricting prediction results. Accepts values for tags and the filterOutOfStockItems flag. * Tag expressions. Restricts predictions to items 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 KiB. * filterOutOfStockItems. Restricts predictions to items 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 items to be returned instead, set strictFiltering to false in PredictRequest.params. Corresponds to the JSON property filter

Returns:

  • (String) 


994
995
996
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 994

def filter
  @filter
end

#labels ⇒ Hash<String,String>

Optional. 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>) 


1004
1005
1006
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1004

def labels
  @labels
end

#page_size ⇒ Fixnum

Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


1011
1012
1013
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1011

def page_size
  @page_size
end

#page_token ⇒ String

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

Returns:

  • (String) 


1016
1017
1018
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1016

def page_token
  @page_token
end

#params ⇒ Hash<String,Object>

Optional. Additional domain specific parameters for the predictions. Allowed values: * returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult. itemMetadata object in the method response. * returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item 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 items 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 adjust 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 adjust prediction results based on product category. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


1037
1038
1039
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1037

def params
  @params
end

#user_event ⇒ Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1UserEvent

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

Returns:



1043
1044
1045
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1043

def user_event
  @user_event
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1050
1051
1052
1053
1054
1055
1056
1057
1058
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1050

def update!(**args)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @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)
end