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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/recommendationengine_v1beta1/classes.rb,
generated/google/apis/recommendationengine_v1beta1/representations.rb,
generated/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.



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

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) 


1060
1061
1062
 
# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1060

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


1066
1067
1068
 
# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1066

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


1071
1072
1073
 
# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1071

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) 


1077
1078
1079
 
# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1077

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) 


1084
1085
1086
 
# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1084

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:



1090
1091
1092
 
# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1090

def results
  @results
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'generated/google/apis/recommendationengine_v1beta1/classes.rb', line 1097

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