Class: Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictResponse

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

Response message for predict method.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudRecommendationengineV1beta1PredictResponse

Returns a new instance of GoogleCloudRecommendationengineV1beta1PredictResponse.



1100
1101
1102
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1100

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

Instance Attribute Details

#dry_run ⇒ Boolean Also known as: dry_run?

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

Returns:

  • (Boolean) 


1068
1069
1070
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1068

def dry_run
  @dry_run
end

#items_missing_in_catalog ⇒ Array<String>

IDs of items in the request that were missing from the catalog. Corresponds to the JSON property itemsMissingInCatalog

Returns:

  • (Array<String>) 


1074
1075
1076
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1074

def items_missing_in_catalog
  @items_missing_in_catalog
end

#metadata ⇒ Hash<String,Object>

Additional domain specific prediction response metadata. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,Object>) 


1079
1080
1081
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1079

def metadata
  @metadata
end

#next_page_token ⇒ String

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


1085
1086
1087
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1085

def next_page_token
  @next_page_token
end

#recommendation_token ⇒ String

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

Returns:

  • (String) 


1092
1093
1094
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1092

def recommendation_token
  @recommendation_token
end

#results ⇒ Array<Google::Apis::RecommendationengineV1beta1::GoogleCloudRecommendationengineV1beta1PredictResponsePredictionResult>

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

Returns:



1098
1099
1100
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1098

def results
  @results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1105
1106
1107
1108
1109
1110
1111
1112
 
# File 'lib/google/apis/recommendationengine_v1beta1/classes.rb', line 1105

def update!(**args)
  @dry_run = args[:dry_run] if args.key?(:dry_run)
  @items_missing_in_catalog = args[:items_missing_in_catalog] if args.key?(:items_missing_in_catalog)
  @metadata = args[:metadata] if args.key?(:metadata)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @recommendation_token = args[:recommendation_token] if args.key?(:recommendation_token)
  @results = args[:results] if args.key?(:results)
end