Class: Aws::PersonalizeRuntime::Types::PredictedItem

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb

Overview

An object that identifies an item.

The and APIs return a list of PredictedItems.

See Also:

Constant Summary collapse

SENSITIVE = 
[:metadata]

Instance Attribute Summary collapse

Instance Attribute Details

#item_id ⇒ String

The recommended item ID.

Returns:

  • (String) 


416
417
418
419
420
421
422
423
424
 
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 416

class PredictedItem < Struct.new(
  :item_id,
  :score,
  :promotion_name,
  :metadata,
  :reason)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#metadata ⇒ Hash<String,String>

Metadata about the item from your Items dataset.

Returns:

  • (Hash<String,String>) 


416
417
418
419
420
421
422
423
424
 
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 416

class PredictedItem < Struct.new(
  :item_id,
  :score,
  :promotion_name,
  :metadata,
  :reason)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#promotion_name ⇒ String

The name of the promotion that included the predicted item.

Returns:

  • (String) 


416
417
418
419
420
421
422
423
424
 
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 416

class PredictedItem < Struct.new(
  :item_id,
  :score,
  :promotion_name,
  :metadata,
  :reason)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#reason ⇒ Array<String>

If you use User-Personalization-v2, a list of reasons for why the item was included in recommendations. Possible reasons include the following:

  • Promoted item - Indicates the item was included as part of a promotion that you applied in your recommendation request.

  • Exploration - Indicates the item was included with exploration. With exploration, recommendations include items with less interactions data or relevance for the user. For more information about exploration, see Exploration.

  • Popular item - Indicates the item was included as a placeholder popular item. If you use a filter, depending on how many recommendations the filter removes, Amazon Personalize might add placeholder items to meet the numResults for your recommendation request. These items are popular items, based on interactions data, that satisfy your filter criteria. They don't have a relevance score for the user.

Returns:

  • (Array<String>) 


416
417
418
419
420
421
422
423
424
 
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 416

class PredictedItem < Struct.new(
  :item_id,
  :score,
  :promotion_name,
  :metadata,
  :reason)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#score ⇒ Float

A numeric representation of the model's certainty that the item will be the next user selection. For more information on scoring logic, see how-scores-work.

Returns:

  • (Float) 


416
417
418
419
420
421
422
423
424
 
# File 'gems/aws-sdk-personalizeruntime/lib/aws-sdk-personalizeruntime/types.rb', line 416

class PredictedItem < Struct.new(
  :item_id,
  :score,
  :promotion_name,
  :metadata,
  :reason)
  SENSITIVE = [:metadata]
  include Aws::Structure
end