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. Full resource name of the format: name= projects/*/locations/global/catalogs/default_catalog/eventStores/ default_event_store/placements/* The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default: // * shopping_cart: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after add-to-cart event, on product detail pages, or on the shopping cart page. * home_page: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified userId or visitorId. For example - Recommendations for you. * product_detail: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified userId or visitorId and its relevance to a specified CatalogItem. Typically used on product detail pages. For example

  • More items like this. * recently_viewed_default: Returns up to 75 items recently viewed by the specified userId or visitorId, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/catalogs/default_catalog/ placements

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommendationengineV1beta1PredictRequest

Returns a new instance of GoogleCloudRecommendationengineV1beta1PredictRequest.



1065
1066
1067
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1065

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) 


996
997
998
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 996

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) 


1014
1015
1016
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1014

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


1024
1025
1026
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1024

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) 


1031
1032
1033
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1031

def page_size
  @page_size
end

#page_token ⇒ String

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

Returns:

  • (String) 


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

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


1057
1058
1059
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1057

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:



1063
1064
1065
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1063

def user_event
  @user_event
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1070

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