Recommendations AI V1beta1 API - Class Google::Cloud::RecommendationEngine::V1beta1::PredictResponse (v0.5.0)

Reference documentation and code samples for the Recommendations AI V1beta1 API class Google::Cloud::RecommendationEngine::V1beta1::PredictResponse.

Response message for predict method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#dry_run

def dry_run() -> ::Boolean
Returns
  • (::Boolean) — True if the dryRun property was set in the request.

#dry_run=

def dry_run=(value) -> ::Boolean
Parameter
  • value (::Boolean) — True if the dryRun property was set in the request.
Returns
  • (::Boolean) — True if the dryRun property was set in the request.

#items_missing_in_catalog

def items_missing_in_catalog() -> ::Array<::String>
Returns
  • (::Array<::String>) — IDs of items in the request that were missing from the catalog.

#items_missing_in_catalog=

def items_missing_in_catalog=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — IDs of items in the request that were missing from the catalog.
Returns
  • (::Array<::String>) — IDs of items in the request that were missing from the catalog.

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) — Additional domain specific prediction response metadata.

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}
Parameter
  • value (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) — Additional domain specific prediction response metadata.
Returns
  • (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) — Additional domain specific prediction response metadata.

#next_page_token

def next_page_token() -> ::String
Returns
  • (::String) — If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

#next_page_token=

def next_page_token=(value) -> ::String
Parameter
  • value (::String) — If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.
Returns
  • (::String) — If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

#recommendation_token

def recommendation_token() -> ::String
Returns
  • (::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.

#recommendation_token=

def recommendation_token=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#results

def results() -> ::Array<::Google::Cloud::RecommendationEngine::V1beta1::PredictResponse::PredictionResult>
Returns

#results=

def results=(value) -> ::Array<::Google::Cloud::RecommendationEngine::V1beta1::PredictResponse::PredictionResult>
Parameter
Returns