Class: Google::Cloud::Retail::V2::PredictResponse

Inherits:

Object

• Object
• Google::Cloud::Retail::V2::PredictResponse

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/retail/v2/prediction_service.rb

Overview

Response message for predict method.

Defined Under Namespace

Classes: PredictionResult

Instance Attribute Summary

• #attribution_token ⇒ ::String

  A unique attribution token.

• #missing_ids ⇒ ::Array<::String>

  IDs of products in the request that were missing from the inventory.

• #results ⇒ ::Array<::Google::Cloud::Retail::V2::PredictResponse::PredictionResult>

  A list of recommended products.

• #validate_only ⇒ ::Boolean

  True if the validateOnly property was set in the request.

Instance Attribute Details

#attribution_token ⇒ ::String

# File 'proto_docs/google/cloud/retail/v2/prediction_service.rb', line 202

class PredictResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # PredictionResult represents the recommendation prediction results.
  # @!attribute [rw] id
  #   @return [::String]
  #     ID of the recommended product
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional product metadata / annotations.
  #
  #     Possible values:
  #
  #     * `product`: JSON representation of the product. Is set if
  #       `returnProduct` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Is set if
  #       `returnScore` is set to true in `PredictRequest.params`.
  class PredictionResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class MetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#missing_ids ⇒ ::Array<::String>

# File 'proto_docs/google/cloud/retail/v2/prediction_service.rb', line 202

class PredictResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # PredictionResult represents the recommendation prediction results.
  # @!attribute [rw] id
  #   @return [::String]
  #     ID of the recommended product
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional product metadata / annotations.
  #
  #     Possible values:
  #
  #     * `product`: JSON representation of the product. Is set if
  #       `returnProduct` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Is set if
  #       `returnScore` is set to true in `PredictRequest.params`.
  class PredictionResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class MetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#results ⇒ ::Array<::Google::Cloud::Retail::V2::PredictResponse::PredictionResult>

# File 'proto_docs/google/cloud/retail/v2/prediction_service.rb', line 202

class PredictResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # PredictionResult represents the recommendation prediction results.
  # @!attribute [rw] id
  #   @return [::String]
  #     ID of the recommended product
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional product metadata / annotations.
  #
  #     Possible values:
  #
  #     * `product`: JSON representation of the product. Is set if
  #       `returnProduct` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Is set if
  #       `returnScore` is set to true in `PredictRequest.params`.
  class PredictionResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class MetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end

#validate_only ⇒ ::Boolean

# File 'proto_docs/google/cloud/retail/v2/prediction_service.rb', line 202

class PredictResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # PredictionResult represents the recommendation prediction results.
  # @!attribute [rw] id
  #   @return [::String]
  #     ID of the recommended product
  # @!attribute [rw] metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional product metadata / annotations.
  #
  #     Possible values:
  #
  #     * `product`: JSON representation of the product. Is set if
  #       `returnProduct` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Is set if
  #       `returnScore` is set to true in `PredictRequest.params`.
  class PredictionResult
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::Google::Protobuf::Value]
    class MetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end
end