aws-sdk-personalizeruntime 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5f6be600853cc7e7015907b92fb6c84d204e73c
-  data.tar.gz: a0dbb79d67701ee308eeff1369885c36a290b96b
+  metadata.gz: 6ed9cc5b73473ba875d506f9a49029e15443a902
+  data.tar.gz: d77b631563143cda033c6cee2467d9e629c180ac
 SHA512:
-  metadata.gz: d46ad1ac79c997b704669ee23eeffd1236f43d24353935eb7a8ca2a8c96e2148e20c5962c739c69e5c428a22a9f5322346ff8cb3f13f3c89de41d61644137823
-  data.tar.gz: f213eaf0a6e5eb6dd17515eca0417c59c41c0dbee76cc1e601b62bbe0eeab494c7c36a63bc5db56b8156ad4dd379877bae3e452a055dac5a1b1e4786d8ee980d
+  metadata.gz: b7d03bd1d0bac34d2e3e18392e54ad999c7d2691376b2e9b2e98d3bfffa951ed3c9827179b64fa23087679d18870042848fd4c7739658766d0142d8d6c00aed3
+  data.tar.gz: 9736217558d9eb59a7094fea5209eab37da83a5515c840713fd8ac311217860a619c628279a1f3a8f6503f25b90ab44a90a7d7a0338b62b73551ec76ae4f52a7

data/lib/aws-sdk-personalizeruntime.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
 # @service
 module Aws::PersonalizeRuntime
 
-  GEM_VERSION = '1.5.0'
+  GEM_VERSION = '1.6.0'
 
 end

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

@@ -270,12 +270,19 @@ module Aws::PersonalizeRuntime
     # @option params [required, Array<String>] :input_list
     #   A list of items (itemId's) to rank. If an item was not included in
     #   the training dataset, the item is appended to the end of the reranked
-    #   list.
+    #   list. The maximum is 500.
     #
     # @option params [required, String] :user_id
     #   The user for which you want the campaign to provide a personalized
     #   ranking.
     #
+    # @option params [Hash<String,String>] :context
+    #   The contextual metadata to use when getting recommendations.
+    #   Contextual metadata includes any interaction information that might be
+    #   relevant when getting a user's recommendations, such as the user's
+    #   current location or device type. For more information, see Contextual
+    #   Metadata.
+    #
     # @return [Types::GetPersonalizedRankingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::GetPersonalizedRankingResponse#personalized_ranking #personalized_ranking} => Array&lt;Types::PredictedItem&gt;
@@ -286,6 +293,9 @@ module Aws::PersonalizeRuntime
     #     campaign_arn: "Arn", # required
     #     input_list: ["ItemID"], # required
     #     user_id: "UserID", # required
+    #     context: {
+    #       "AttributeName" => "AttributeValue",
+    #     },
     #   })
     #
     # @example Response structure
@@ -331,7 +341,14 @@ module Aws::PersonalizeRuntime
     #
     # @option params [Integer] :num_results
     #   The number of results to return. The default is 25. The maximum is
-    #   100.
+    #   500.
+    #
+    # @option params [Hash<String,String>] :context
+    #   The contextual metadata to use when getting recommendations.
+    #   Contextual metadata includes any interaction information that might be
+    #   relevant when getting a user's recommendations, such as the user's
+    #   current location or device type. For more information, see Contextual
+    #   Metadata.
     #
     # @return [Types::GetRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
@@ -344,6 +361,9 @@ module Aws::PersonalizeRuntime
     #     item_id: "ItemID",
     #     user_id: "UserID",
     #     num_results: 1,
+    #     context: {
+    #       "AttributeName" => "AttributeValue",
+    #     },
     #   })
     #
     # @example Response structure
@@ -373,7 +393,7 @@ module Aws::PersonalizeRuntime
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-personalizeruntime'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.6.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -12,6 +12,9 @@ module Aws::PersonalizeRuntime
     include Seahorse::Model
 
     Arn = Shapes::StringShape.new(name: 'Arn')
+    AttributeName = Shapes::StringShape.new(name: 'AttributeName')
+    AttributeValue = Shapes::StringShape.new(name: 'AttributeValue')
+    Context = Shapes::MapShape.new(name: 'Context')
     ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
     GetPersonalizedRankingRequest = Shapes::StructureShape.new(name: 'GetPersonalizedRankingRequest')
     GetPersonalizedRankingResponse = Shapes::StructureShape.new(name: 'GetPersonalizedRankingResponse')
@@ -26,9 +29,13 @@ module Aws::PersonalizeRuntime
     ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
     UserID = Shapes::StringShape.new(name: 'UserID')
 
+    Context.key = Shapes::ShapeRef.new(shape: AttributeName)
+    Context.value = Shapes::ShapeRef.new(shape: AttributeValue)
+
     GetPersonalizedRankingRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
     GetPersonalizedRankingRequest.add_member(:input_list, Shapes::ShapeRef.new(shape: InputList, required: true, location_name: "inputList"))
     GetPersonalizedRankingRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, required: true, location_name: "userId"))
+    GetPersonalizedRankingRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
     GetPersonalizedRankingRequest.struct_class = Types::GetPersonalizedRankingRequest
 
     GetPersonalizedRankingResponse.add_member(:personalized_ranking, Shapes::ShapeRef.new(shape: ItemList, location_name: "personalizedRanking"))
@@ -38,6 +45,7 @@ module Aws::PersonalizeRuntime
     GetRecommendationsRequest.add_member(:item_id, Shapes::ShapeRef.new(shape: ItemID, location_name: "itemId"))
     GetRecommendationsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, location_name: "userId"))
     GetRecommendationsRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumResults, location_name: "numResults"))
+    GetRecommendationsRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
     GetRecommendationsRequest.struct_class = Types::GetRecommendationsRequest
 
     GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))

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

@@ -15,6 +15,9 @@ module Aws::PersonalizeRuntime
     #         campaign_arn: "Arn", # required
     #         input_list: ["ItemID"], # required
     #         user_id: "UserID", # required
+    #         context: {
+    #           "AttributeName" => "AttributeValue",
+    #         },
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -25,7 +28,7 @@ module Aws::PersonalizeRuntime
     # @!attribute [rw] input_list
     #   A list of items (itemId's) to rank. If an item was not included in
     #   the training dataset, the item is appended to the end of the
-    #   reranked list.
+    #   reranked list. The maximum is 500.
     #   @return [Array<String>]
     #
     # @!attribute [rw] user_id
@@ -33,17 +36,27 @@ module Aws::PersonalizeRuntime
     #   ranking.
     #   @return [String]
     #
+    # @!attribute [rw] context
+    #   The contextual metadata to use when getting recommendations.
+    #   Contextual metadata includes any interaction information that might
+    #   be relevant when getting a user's recommendations, such as the
+    #   user's current location or device type. For more information, see
+    #   Contextual Metadata.
+    #   @return [Hash<String,String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingRequest AWS API Documentation
     #
     class GetPersonalizedRankingRequest < Struct.new(
       :campaign_arn,
       :input_list,
-      :user_id)
+      :user_id,
+      :context)
       include Aws::Structure
     end
 
     # @!attribute [rw] personalized_ranking
-    #   A list of items in order of most likely interest to the user.
+    #   A list of items in order of most likely interest to the user. The
+    #   maximum is 500.
     #   @return [Array<Types::PredictedItem>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingResponse AWS API Documentation
@@ -61,6 +74,9 @@ module Aws::PersonalizeRuntime
     #         item_id: "ItemID",
     #         user_id: "UserID",
     #         num_results: 1,
+    #         context: {
+    #           "AttributeName" => "AttributeValue",
+    #         },
     #       }
     #
     # @!attribute [rw] campaign_arn
@@ -82,21 +98,31 @@ module Aws::PersonalizeRuntime
     #
     # @!attribute [rw] num_results
     #   The number of results to return. The default is 25. The maximum is
-    #   100.
+    #   500.
     #   @return [Integer]
     #
+    # @!attribute [rw] context
+    #   The contextual metadata to use when getting recommendations.
+    #   Contextual metadata includes any interaction information that might
+    #   be relevant when getting a user's recommendations, such as the
+    #   user's current location or device type. For more information, see
+    #   Contextual Metadata.
+    #   @return [Hash<String,String>]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
     #
     class GetRecommendationsRequest < Struct.new(
       :campaign_arn,
       :item_id,
       :user_id,
-      :num_results)
+      :num_results,
+      :context)
       include Aws::Structure
     end
 
     # @!attribute [rw] item_list
-    #   A list of recommendations.
+    #   A list of recommendations sorted in ascending order by prediction
+    #   score. There can be a maximum of 500 items in the list.
     #   @return [Array<Types::PredictedItem>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsResponse AWS API Documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-personalizeruntime
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core