aws-sdk-personalizeruntime 1.5.0 → 1.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: b5f6be600853cc7e7015907b92fb6c84d204e73c
4
- data.tar.gz: a0dbb79d67701ee308eeff1369885c36a290b96b
3
+ metadata.gz: 6ed9cc5b73473ba875d506f9a49029e15443a902
4
+ data.tar.gz: d77b631563143cda033c6cee2467d9e629c180ac
5
5
  SHA512:
6
- metadata.gz: d46ad1ac79c997b704669ee23eeffd1236f43d24353935eb7a8ca2a8c96e2148e20c5962c739c69e5c428a22a9f5322346ff8cb3f13f3c89de41d61644137823
7
- data.tar.gz: f213eaf0a6e5eb6dd17515eca0417c59c41c0dbee76cc1e601b62bbe0eeab494c7c36a63bc5db56b8156ad4dd379877bae3e452a055dac5a1b1e4786d8ee980d
6
+ metadata.gz: b7d03bd1d0bac34d2e3e18392e54ad999c7d2691376b2e9b2e98d3bfffa951ed3c9827179b64fa23087679d18870042848fd4c7739658766d0142d8d6c00aed3
7
+ data.tar.gz: 9736217558d9eb59a7094fea5209eab37da83a5515c840713fd8ac311217860a619c628279a1f3a8f6503f25b90ab44a90a7d7a0338b62b73551ec76ae4f52a7
@@ -42,6 +42,6 @@ require_relative 'aws-sdk-personalizeruntime/customizations'
42
42
  # @service
43
43
  module Aws::PersonalizeRuntime
44
44
 
45
- GEM_VERSION = '1.5.0'
45
+ GEM_VERSION = '1.6.0'
46
46
 
47
47
  end
@@ -270,12 +270,19 @@ module Aws::PersonalizeRuntime
270
270
  # @option params [required, Array<String>] :input_list
271
271
  # A list of items (itemId's) to rank. If an item was not included in
272
272
  # the training dataset, the item is appended to the end of the reranked
273
- # list.
273
+ # list. The maximum is 500.
274
274
  #
275
275
  # @option params [required, String] :user_id
276
276
  # The user for which you want the campaign to provide a personalized
277
277
  # ranking.
278
278
  #
279
+ # @option params [Hash<String,String>] :context
280
+ # The contextual metadata to use when getting recommendations.
281
+ # Contextual metadata includes any interaction information that might be
282
+ # relevant when getting a user's recommendations, such as the user's
283
+ # current location or device type. For more information, see Contextual
284
+ # Metadata.
285
+ #
279
286
  # @return [Types::GetPersonalizedRankingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
280
287
  #
281
288
  # * {Types::GetPersonalizedRankingResponse#personalized_ranking #personalized_ranking} => Array&lt;Types::PredictedItem&gt;
@@ -286,6 +293,9 @@ module Aws::PersonalizeRuntime
286
293
  # campaign_arn: "Arn", # required
287
294
  # input_list: ["ItemID"], # required
288
295
  # user_id: "UserID", # required
296
+ # context: {
297
+ # "AttributeName" => "AttributeValue",
298
+ # },
289
299
  # })
290
300
  #
291
301
  # @example Response structure
@@ -331,7 +341,14 @@ module Aws::PersonalizeRuntime
331
341
  #
332
342
  # @option params [Integer] :num_results
333
343
  # The number of results to return. The default is 25. The maximum is
334
- # 100.
344
+ # 500.
345
+ #
346
+ # @option params [Hash<String,String>] :context
347
+ # The contextual metadata to use when getting recommendations.
348
+ # Contextual metadata includes any interaction information that might be
349
+ # relevant when getting a user's recommendations, such as the user's
350
+ # current location or device type. For more information, see Contextual
351
+ # Metadata.
335
352
  #
336
353
  # @return [Types::GetRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
337
354
  #
@@ -344,6 +361,9 @@ module Aws::PersonalizeRuntime
344
361
  # item_id: "ItemID",
345
362
  # user_id: "UserID",
346
363
  # num_results: 1,
364
+ # context: {
365
+ # "AttributeName" => "AttributeValue",
366
+ # },
347
367
  # })
348
368
  #
349
369
  # @example Response structure
@@ -373,7 +393,7 @@ module Aws::PersonalizeRuntime
373
393
  params: params,
374
394
  config: config)
375
395
  context[:gem_name] = 'aws-sdk-personalizeruntime'
376
- context[:gem_version] = '1.5.0'
396
+ context[:gem_version] = '1.6.0'
377
397
  Seahorse::Client::Request.new(handlers, context)
378
398
  end
379
399
 
@@ -12,6 +12,9 @@ module Aws::PersonalizeRuntime
12
12
  include Seahorse::Model
13
13
 
14
14
  Arn = Shapes::StringShape.new(name: 'Arn')
15
+ AttributeName = Shapes::StringShape.new(name: 'AttributeName')
16
+ AttributeValue = Shapes::StringShape.new(name: 'AttributeValue')
17
+ Context = Shapes::MapShape.new(name: 'Context')
15
18
  ErrorMessage = Shapes::StringShape.new(name: 'ErrorMessage')
16
19
  GetPersonalizedRankingRequest = Shapes::StructureShape.new(name: 'GetPersonalizedRankingRequest')
17
20
  GetPersonalizedRankingResponse = Shapes::StructureShape.new(name: 'GetPersonalizedRankingResponse')
@@ -26,9 +29,13 @@ module Aws::PersonalizeRuntime
26
29
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
27
30
  UserID = Shapes::StringShape.new(name: 'UserID')
28
31
 
32
+ Context.key = Shapes::ShapeRef.new(shape: AttributeName)
33
+ Context.value = Shapes::ShapeRef.new(shape: AttributeValue)
34
+
29
35
  GetPersonalizedRankingRequest.add_member(:campaign_arn, Shapes::ShapeRef.new(shape: Arn, required: true, location_name: "campaignArn"))
30
36
  GetPersonalizedRankingRequest.add_member(:input_list, Shapes::ShapeRef.new(shape: InputList, required: true, location_name: "inputList"))
31
37
  GetPersonalizedRankingRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, required: true, location_name: "userId"))
38
+ GetPersonalizedRankingRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
32
39
  GetPersonalizedRankingRequest.struct_class = Types::GetPersonalizedRankingRequest
33
40
 
34
41
  GetPersonalizedRankingResponse.add_member(:personalized_ranking, Shapes::ShapeRef.new(shape: ItemList, location_name: "personalizedRanking"))
@@ -38,6 +45,7 @@ module Aws::PersonalizeRuntime
38
45
  GetRecommendationsRequest.add_member(:item_id, Shapes::ShapeRef.new(shape: ItemID, location_name: "itemId"))
39
46
  GetRecommendationsRequest.add_member(:user_id, Shapes::ShapeRef.new(shape: UserID, location_name: "userId"))
40
47
  GetRecommendationsRequest.add_member(:num_results, Shapes::ShapeRef.new(shape: NumResults, location_name: "numResults"))
48
+ GetRecommendationsRequest.add_member(:context, Shapes::ShapeRef.new(shape: Context, location_name: "context"))
41
49
  GetRecommendationsRequest.struct_class = Types::GetRecommendationsRequest
42
50
 
43
51
  GetRecommendationsResponse.add_member(:item_list, Shapes::ShapeRef.new(shape: ItemList, location_name: "itemList"))
@@ -15,6 +15,9 @@ module Aws::PersonalizeRuntime
15
15
  # campaign_arn: "Arn", # required
16
16
  # input_list: ["ItemID"], # required
17
17
  # user_id: "UserID", # required
18
+ # context: {
19
+ # "AttributeName" => "AttributeValue",
20
+ # },
18
21
  # }
19
22
  #
20
23
  # @!attribute [rw] campaign_arn
@@ -25,7 +28,7 @@ module Aws::PersonalizeRuntime
25
28
  # @!attribute [rw] input_list
26
29
  # A list of items (itemId's) to rank. If an item was not included in
27
30
  # the training dataset, the item is appended to the end of the
28
- # reranked list.
31
+ # reranked list. The maximum is 500.
29
32
  # @return [Array<String>]
30
33
  #
31
34
  # @!attribute [rw] user_id
@@ -33,17 +36,27 @@ module Aws::PersonalizeRuntime
33
36
  # ranking.
34
37
  # @return [String]
35
38
  #
39
+ # @!attribute [rw] context
40
+ # The contextual metadata to use when getting recommendations.
41
+ # Contextual metadata includes any interaction information that might
42
+ # be relevant when getting a user's recommendations, such as the
43
+ # user's current location or device type. For more information, see
44
+ # Contextual Metadata.
45
+ # @return [Hash<String,String>]
46
+ #
36
47
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingRequest AWS API Documentation
37
48
  #
38
49
  class GetPersonalizedRankingRequest < Struct.new(
39
50
  :campaign_arn,
40
51
  :input_list,
41
- :user_id)
52
+ :user_id,
53
+ :context)
42
54
  include Aws::Structure
43
55
  end
44
56
 
45
57
  # @!attribute [rw] personalized_ranking
46
- # A list of items in order of most likely interest to the user.
58
+ # A list of items in order of most likely interest to the user. The
59
+ # maximum is 500.
47
60
  # @return [Array<Types::PredictedItem>]
48
61
  #
49
62
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetPersonalizedRankingResponse AWS API Documentation
@@ -61,6 +74,9 @@ module Aws::PersonalizeRuntime
61
74
  # item_id: "ItemID",
62
75
  # user_id: "UserID",
63
76
  # num_results: 1,
77
+ # context: {
78
+ # "AttributeName" => "AttributeValue",
79
+ # },
64
80
  # }
65
81
  #
66
82
  # @!attribute [rw] campaign_arn
@@ -82,21 +98,31 @@ module Aws::PersonalizeRuntime
82
98
  #
83
99
  # @!attribute [rw] num_results
84
100
  # The number of results to return. The default is 25. The maximum is
85
- # 100.
101
+ # 500.
86
102
  # @return [Integer]
87
103
  #
104
+ # @!attribute [rw] context
105
+ # The contextual metadata to use when getting recommendations.
106
+ # Contextual metadata includes any interaction information that might
107
+ # be relevant when getting a user's recommendations, such as the
108
+ # user's current location or device type. For more information, see
109
+ # Contextual Metadata.
110
+ # @return [Hash<String,String>]
111
+ #
88
112
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsRequest AWS API Documentation
89
113
  #
90
114
  class GetRecommendationsRequest < Struct.new(
91
115
  :campaign_arn,
92
116
  :item_id,
93
117
  :user_id,
94
- :num_results)
118
+ :num_results,
119
+ :context)
95
120
  include Aws::Structure
96
121
  end
97
122
 
98
123
  # @!attribute [rw] item_list
99
- # A list of recommendations.
124
+ # A list of recommendations sorted in ascending order by prediction
125
+ # score. There can be a maximum of 500 items in the list.
100
126
  # @return [Array<Types::PredictedItem>]
101
127
  #
102
128
  # @see http://docs.aws.amazon.com/goto/WebAPI/personalize-runtime-2018-05-22/GetRecommendationsResponse AWS API Documentation
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-personalizeruntime
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.5.0
4
+ version: 1.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2019-10-23 00:00:00.000000000 Z
11
+ date: 2019-12-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core