aws-sdk-personalizeruntime 1.48.0 → 1.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e56333e5b95d2a8f8a99ff3f35e77b9668d916213f1374106a658fac189f93ca
-  data.tar.gz: 893c84da47cb7a8c9b731087e033129603a1a550ec0453035e35f7d25191c6a0
+  metadata.gz: 6e6097c3f5dfdcf1c95736e8e3482ed92302a9525d24a266e246568136473f0d
+  data.tar.gz: e313368d8f7b48c5368462d008987d42a4658f06e683725ee5857efd3ce4aee2
 SHA512:
-  metadata.gz: bb8188eefa3ea3668184e85f4b2e45e37d441d85fc9cbcc45e5220fb00c7f275b1fc640941ec4ba5a43723076446b78bf1760db2b437a269f72108e210e7de75
-  data.tar.gz: b6da283b46a4ae2eb80beef61d298aeea43f066a0ffaa042aa41a8e27a014c22f759c59124891e2763d4adcaec555c43751b856b57330dd890797478aa22ce3b
+  metadata.gz: e49ec4ac3ee5f3d4b6d4aa08bf4d97c229b526524053a7d8de30906ef0e56ecc3fdbd001de7d393932590cd369bc2f051127944b42f55cad1673d8f7a73bb895
+  data.tar.gz: 36257dbd7c9112f49e6c59de004cadfee86e56ce5aad44a388f0746333e513325127c1fd65e1ca80445ad0ef5b844e2c195015d67771a67d8986cc6cfae08ef2

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.49.0 (2024-05-01)
+------------------
+
+* Feature - This release adds support for a Reason attribute for predicted items generated by User-Personalization-v2.
+
 1.48.0 (2024-04-25)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.48.0
+1.49.0

data/lib/aws-sdk-personalizeruntime/client.rb

@@ -602,6 +602,8 @@ module Aws::PersonalizeRuntime
     #   resp.personalized_ranking[0].promotion_name #=> String
     #   resp.personalized_ranking[0].metadata #=> Hash
     #   resp.personalized_ranking[0].metadata["ColumnName"] #=> String
+    #   resp.personalized_ranking[0].reason #=> Array
+    #   resp.personalized_ranking[0].reason[0] #=> String
     #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRanking AWS API Documentation
@@ -761,6 +763,8 @@ module Aws::PersonalizeRuntime
     #   resp.item_list[0].promotion_name #=> String
     #   resp.item_list[0].metadata #=> Hash
     #   resp.item_list[0].metadata["ColumnName"] #=> String
+    #   resp.item_list[0].reason #=> Array
+    #   resp.item_list[0].reason[0] #=> String
     #   resp.recommendation_id #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendations AWS API Documentation
@@ -785,7 +789,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.48.0'
+      context[:gem_version] = '1.49.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-personalizeruntime/client_api.rb

@@ -46,6 +46,8 @@ module Aws::PersonalizeRuntime
     PredictedItem = Shapes::StructureShape.new(name: 'PredictedItem')
     Promotion = Shapes::StructureShape.new(name: 'Promotion')
     PromotionList = Shapes::ListShape.new(name: 'PromotionList')
+    Reason = Shapes::StringShape.new(name: 'Reason')
+    ReasonList = Shapes::ListShape.new(name: 'ReasonList')
     RecommendationID = Shapes::StringShape.new(name: 'RecommendationID')
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     Score = Shapes::FloatShape.new(name: 'Score')
@@ -122,6 +124,7 @@ module Aws::PersonalizeRuntime
     PredictedItem.add_member(:score, Shapes::ShapeRef.new(shape: Score, location_name: "score"))
     PredictedItem.add_member(:promotion_name, Shapes::ShapeRef.new(shape: Name, location_name: "promotionName"))
     PredictedItem.add_member(:metadata, Shapes::ShapeRef.new(shape: Metadata, location_name: "metadata"))
+    PredictedItem.add_member(:reason, Shapes::ShapeRef.new(shape: ReasonList, location_name: "reason"))
     PredictedItem.struct_class = Types::PredictedItem
 
     Promotion.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
@@ -132,6 +135,8 @@ module Aws::PersonalizeRuntime
 
     PromotionList.member = Shapes::ShapeRef.new(shape: Promotion)
 
+    ReasonList.member = Shapes::ShapeRef.new(shape: Reason)
+
     ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
     ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
 
@@ -146,6 +151,7 @@ module Aws::PersonalizeRuntime
         "endpointPrefix" => "personalize-runtime",
         "jsonVersion" => "1.1",
         "protocol" => "rest-json",
+        "protocols" => ["rest-json"],
         "serviceFullName" => "Amazon Personalize Runtime",
         "serviceId" => "Personalize Runtime",
         "signatureVersion" => "v4",

data/lib/aws-sdk-personalizeruntime/types.rb

@@ -385,14 +385,41 @@ module Aws::PersonalizeRuntime
     #   Metadata about the item from your Items dataset.
     #   @return [Hash<String,String>]
     #
+    # @!attribute [rw] reason
+    #   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][1].
+    #
+    #   * 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.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#about-exploration
+    #   @return [Array<String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/PredictedItem AWS API Documentation
     #
     class PredictedItem < Struct.new(
       :item_id,
       :score,
       :promotion_name,
-      :metadata)
-      SENSITIVE = []
+      :metadata,
+      :reason)
+      SENSITIVE = [:metadata]
       include Aws::Structure
     end
 

data/lib/aws-sdk-personalizeruntime.rb

@@ -52,6 +52,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # @!group service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.48.0'
+  GEM_VERSION = '1.49.0'
 
 end

data/sig/types.rbs

@@ -76,7 +76,8 @@ module Aws::PersonalizeRuntime
       attr_accessor score: ::Float
       attr_accessor promotion_name: ::String
       attr_accessor metadata: ::Hash[::String, ::String]
-      SENSITIVE: []
+      attr_accessor reason: ::Array[::String]
+      SENSITIVE: [:metadata]
     end
 
     class Promotion

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.48.0
+  version: 1.49.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-25 00:00:00.000000000 Z
+date: 2024-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core