Class: Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponse

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

Overview

Response message for predict method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2alphaPredictResponse

Returns a new instance of GoogleCloudRetailV2alphaPredictResponse.



2023
2024
2025
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2023

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

Instance Attribute Details

#attribution_token ⇒ String

A unique attribution token. This should be included in the UserEvent logs resulting from this recommendation, which enables accurate attribution of recommendation model performance. Corresponds to the JSON property attributionToken

Returns:

  • (String) 


2004
2005
2006
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2004

def attribution_token
  @attribution_token
end

#missing_ids ⇒ Array<String>

IDs of products in the request that were missing from the inventory. Corresponds to the JSON property missingIds

Returns:

  • (Array<String>) 


2009
2010
2011
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2009

def missing_ids
  @missing_ids
end

#results ⇒ Array<Google::Apis::RetailV2alpha::GoogleCloudRetailV2alphaPredictResponsePredictionResult>

A list of recommended products. The order represents the ranking (from the most relevant product to the least). Corresponds to the JSON property results

Returns:



2015
2016
2017
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2015

def results
  @results
end

#validate_only ⇒ Boolean Also known as: validate_only?

True if the validateOnly property was set in the request. Corresponds to the JSON property validateOnly

Returns:

  • (Boolean) 


2020
2021
2022
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2020

def validate_only
  @validate_only
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2028
2029
2030
2031
2032
2033
 
# File 'lib/google/apis/retail_v2alpha/classes.rb', line 2028

def update!(**args)
  @attribution_token = args[:attribution_token] if args.key?(:attribution_token)
  @missing_ids = args[:missing_ids] if args.key?(:missing_ids)
  @results = args[:results] if args.key?(:results)
  @validate_only = args[:validate_only] if args.key?(:validate_only)
end