Class: Google::Cloud::RecommendationEngine::V1beta1::PredictResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/recommendationengine/v1beta1/prediction_service.rb

Overview

Response message for predict method.

Defined Under Namespace

Classes: MetadataEntry, PredictionResult

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ ::Boolean

Returns True if the dryRun property was set in the request.

Returns:

  • (::Boolean) —

    True if the dryRun property was set in the request.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/prediction_service.rb', line 168

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 catalog item
  # @!attribute [rw] item_metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional item metadata / annotations.
  #
  #     Possible values:
  #
  #     * `catalogItem`: JSON representation of the catalogItem. Will be set if
  #       `returnCatalogItem` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Will be set if
  #       `returnItemScore` 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 ItemMetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!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

#items_missing_in_catalog ⇒ ::Array<::String>

Returns 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.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/prediction_service.rb', line 168

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 catalog item
  # @!attribute [rw] item_metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional item metadata / annotations.
  #
  #     Possible values:
  #
  #     * `catalogItem`: JSON representation of the catalogItem. Will be set if
  #       `returnCatalogItem` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Will be set if
  #       `returnItemScore` 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 ItemMetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!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

#metadata ⇒ ::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}

Returns Additional domain specific prediction response metadata.

Returns:

  • (::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}) —

    Additional domain specific prediction response metadata.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/prediction_service.rb', line 168

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 catalog item
  # @!attribute [rw] item_metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional item metadata / annotations.
  #
  #     Possible values:
  #
  #     * `catalogItem`: JSON representation of the catalogItem. Will be set if
  #       `returnCatalogItem` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Will be set if
  #       `returnItemScore` 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 ItemMetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!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

#next_page_token ⇒ ::String

Returns 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.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/prediction_service.rb', line 168

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 catalog item
  # @!attribute [rw] item_metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional item metadata / annotations.
  #
  #     Possible values:
  #
  #     * `catalogItem`: JSON representation of the catalogItem. Will be set if
  #       `returnCatalogItem` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Will be set if
  #       `returnItemScore` 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 ItemMetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!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

#recommendation_token ⇒ ::String

Returns 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.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/prediction_service.rb', line 168

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 catalog item
  # @!attribute [rw] item_metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional item metadata / annotations.
  #
  #     Possible values:
  #
  #     * `catalogItem`: JSON representation of the catalogItem. Will be set if
  #       `returnCatalogItem` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Will be set if
  #       `returnItemScore` 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 ItemMetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!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

#results ⇒ ::Array<::Google::Cloud::RecommendationEngine::V1beta1::PredictResponse::PredictionResult>

Returns A list of recommended items. The order represents the ranking (from the most relevant item to the least).

Returns:



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'proto_docs/google/cloud/recommendationengine/v1beta1/prediction_service.rb', line 168

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 catalog item
  # @!attribute [rw] item_metadata
  #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
  #     Additional item metadata / annotations.
  #
  #     Possible values:
  #
  #     * `catalogItem`: JSON representation of the catalogItem. Will be set if
  #       `returnCatalogItem` is set to true in `PredictRequest.params`.
  #     * `score`: Prediction score in double value. Will be set if
  #       `returnItemScore` 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 ItemMetadataEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # @!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