aws-sdk-personalize 1.19.0 → 1.20.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-personalize.rb +1 -1
- data/lib/aws-sdk-personalize/client.rb +43 -37
- data/lib/aws-sdk-personalize/types.rb +67 -47
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8333cc2dfa8b08e53cb45d0af74c9118c86371c9a94e91d4db31148392025396
|
4
|
+
data.tar.gz: 4b055092fa7edf9652ae2141ba0adc91b2374b4647af288a62d9b03ac5bc6848
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f445293c7374cbf3a7b76ebfa35eefed35b2855e58bfec982fe3864ee99a3cf4fb4b7ce61515f487b2803cde48f64ce8bc47ef799c441747655007d03f55378f
|
7
|
+
data.tar.gz: 7f1bb9a106c77285346532d9b9bff5809724d8c78686c2364d8e2a3d96b56365409693b1c979c1e7b2832a4cfa765b12ffa41c528f56ec207a990c51354e5268
|
data/lib/aws-sdk-personalize.rb
CHANGED
@@ -427,11 +427,16 @@ module Aws::Personalize
|
|
427
427
|
# throughput and unit of billing for Amazon Personalize. The minimum
|
428
428
|
# provisioned TPS (`minProvisionedTPS`) specifies the baseline
|
429
429
|
# throughput provisioned by Amazon Personalize, and thus, the minimum
|
430
|
-
# billing charge.
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
434
|
-
#
|
430
|
+
# billing charge.
|
431
|
+
#
|
432
|
+
# If your TPS increases beyond `minProvisionedTPS`, Amazon Personalize
|
433
|
+
# auto-scales the provisioned capacity up and down, but never below
|
434
|
+
# `minProvisionedTPS`. There's a short time delay while the capacity is
|
435
|
+
# increased that might cause loss of transactions.
|
436
|
+
#
|
437
|
+
# The actual TPS used is calculated as the average requests/second
|
438
|
+
# within a 5-minute window. You pay for maximum of either the minimum
|
439
|
+
# provisioned TPS or the actual TPS. We recommend starting with a low
|
435
440
|
# `minProvisionedTPS`, track your usage using Amazon CloudWatch metrics,
|
436
441
|
# and then increase the `minProvisionedTPS` as necessary.
|
437
442
|
#
|
@@ -686,7 +691,8 @@ module Aws::Personalize
|
|
686
691
|
# from the data source, as Amazon Personalize makes a copy of your data
|
687
692
|
# and processes it in an internal AWS system.
|
688
693
|
#
|
689
|
-
# The dataset import job replaces any
|
694
|
+
# The dataset import job replaces any existing data in the dataset that
|
695
|
+
# you imported in bulk.
|
690
696
|
#
|
691
697
|
# **Status**
|
692
698
|
#
|
@@ -755,23 +761,20 @@ module Aws::Personalize
|
|
755
761
|
req.send_request(options)
|
756
762
|
end
|
757
763
|
|
758
|
-
# Creates an event tracker that you use when
|
764
|
+
# Creates an event tracker that you use when adding event data to a
|
759
765
|
# specified dataset group using the [PutEvents][1] API.
|
760
766
|
#
|
761
|
-
# When Amazon Personalize creates an event tracker, it also creates an
|
762
|
-
# *event-interactions* dataset in the dataset group associated with the
|
763
|
-
# event tracker. The event-interactions dataset stores the event data
|
764
|
-
# from the `PutEvents` call. The contents of this dataset are not
|
765
|
-
# available to the user.
|
766
|
-
#
|
767
767
|
# <note markdown="1"> Only one event tracker can be associated with a dataset group. You
|
768
768
|
# will get an error if you call `CreateEventTracker` using the same
|
769
769
|
# dataset group as an existing event tracker.
|
770
770
|
#
|
771
771
|
# </note>
|
772
772
|
#
|
773
|
-
# When you
|
774
|
-
#
|
773
|
+
# When you create an event tracker, the response includes a tracking ID,
|
774
|
+
# which you pass as a parameter when you use the [PutEvents][1]
|
775
|
+
# operation. Amazon Personalize then appends the event data to the
|
776
|
+
# Interactions dataset of the dataset group you specify in your event
|
777
|
+
# tracker.
|
775
778
|
#
|
776
779
|
# The event tracker can be in one of the following states:
|
777
780
|
#
|
@@ -832,12 +835,7 @@ module Aws::Personalize
|
|
832
835
|
req.send_request(options)
|
833
836
|
end
|
834
837
|
|
835
|
-
# Creates a recommendation filter. For more information, see
|
836
|
-
# Filters with Amazon Personalize][1].
|
837
|
-
#
|
838
|
-
#
|
839
|
-
#
|
840
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
|
838
|
+
# Creates a recommendation filter. For more information, see filter.
|
841
839
|
#
|
842
840
|
# @option params [required, String] :name
|
843
841
|
# The name of the filter to create.
|
@@ -846,20 +844,10 @@ module Aws::Personalize
|
|
846
844
|
# The ARN of the dataset group that the filter will belong to.
|
847
845
|
#
|
848
846
|
# @option params [required, String] :filter_expression
|
849
|
-
# The filter expression
|
850
|
-
#
|
851
|
-
#
|
852
|
-
#
|
853
|
-
# `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
|
854
|
-
#
|
855
|
-
# Where "EVENT\_TYPE" is the type of event to filter out. To filter
|
856
|
-
# out all items with any interactions history, set `"*"` as the
|
857
|
-
# EVENT\_TYPE. For more information, see [Using Filters with Amazon
|
858
|
-
# Personalize][1].
|
859
|
-
#
|
860
|
-
#
|
861
|
-
#
|
862
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
|
847
|
+
# The filter expression defines which items are included or excluded
|
848
|
+
# from recommendations. Filter expression must follow specific format
|
849
|
+
# rules. For information about filter expression structure and syntax,
|
850
|
+
# see filter-expressions.
|
863
851
|
#
|
864
852
|
# @return [Types::CreateFilterResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
865
853
|
#
|
@@ -950,6 +938,11 @@ module Aws::Personalize
|
|
950
938
|
# `performAutoML` and Amazon Personalize will analyze your data and
|
951
939
|
# select the optimum USER\_PERSONALIZATION recipe for you.
|
952
940
|
#
|
941
|
+
# <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` for
|
942
|
+
# solution hyperparameter optimization at this time.
|
943
|
+
#
|
944
|
+
# </note>
|
945
|
+
#
|
953
946
|
# **Status**
|
954
947
|
#
|
955
948
|
# A solution can be in one of the following states:
|
@@ -1015,11 +1008,19 @@ module Aws::Personalize
|
|
1015
1008
|
# field), this parameter specifies which event type (for example,
|
1016
1009
|
# 'click' or 'like') is used for training the model.
|
1017
1010
|
#
|
1011
|
+
# If you do not provide an `eventType`, Amazon Personalize will use all
|
1012
|
+
# interactions for training with equal weight regardless of type.
|
1013
|
+
#
|
1018
1014
|
# @option params [Types::SolutionConfig] :solution_config
|
1019
1015
|
# The configuration to use with the solution. When `performAutoML` is
|
1020
1016
|
# set to true, Amazon Personalize only evaluates the `autoMLConfig`
|
1021
1017
|
# section of the solution configuration.
|
1022
1018
|
#
|
1019
|
+
# <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
|
1020
|
+
# this time.
|
1021
|
+
#
|
1022
|
+
# </note>
|
1023
|
+
#
|
1023
1024
|
# @return [Types::CreateSolutionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1024
1025
|
#
|
1025
1026
|
# * {Types::CreateSolutionResponse#solution_arn #solution_arn} => String
|
@@ -1144,7 +1145,12 @@ module Aws::Personalize
|
|
1144
1145
|
# The `UPDATE` option can only be used when you already have an active
|
1145
1146
|
# solution version created from the input solution using the `FULL`
|
1146
1147
|
# option and the input solution was trained with the
|
1147
|
-
#
|
1148
|
+
# [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
|
1149
|
+
#
|
1150
|
+
#
|
1151
|
+
#
|
1152
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
1153
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
|
1148
1154
|
#
|
1149
1155
|
# @return [Types::CreateSolutionVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1150
1156
|
#
|
@@ -2587,7 +2593,7 @@ module Aws::Personalize
|
|
2587
2593
|
params: params,
|
2588
2594
|
config: config)
|
2589
2595
|
context[:gem_name] = 'aws-sdk-personalize'
|
2590
|
-
context[:gem_version] = '1.
|
2596
|
+
context[:gem_version] = '1.20.0'
|
2591
2597
|
Seahorse::Client::Request.new(handlers, context)
|
2592
2598
|
end
|
2593
2599
|
|
@@ -240,9 +240,11 @@ module Aws::Personalize
|
|
240
240
|
# }
|
241
241
|
#
|
242
242
|
# @!attribute [rw] item_exploration_config
|
243
|
-
# A string to string map specifying the
|
244
|
-
#
|
245
|
-
#
|
243
|
+
# A string to string map specifying the exploration configuration
|
244
|
+
# hyperparameters, including `explorationWeight` and
|
245
|
+
# `explorationItemAgeCutOff`, you want to use to configure the amount
|
246
|
+
# of item exploration Amazon Personalize uses when recommending items.
|
247
|
+
# See native-recipe-new-item-USER\_PERSONALIZATION.
|
246
248
|
# @return [Hash<String,String>]
|
247
249
|
#
|
248
250
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobConfig AWS API Documentation
|
@@ -442,9 +444,16 @@ module Aws::Personalize
|
|
442
444
|
# }
|
443
445
|
#
|
444
446
|
# @!attribute [rw] item_exploration_config
|
445
|
-
# A string to string map specifying the
|
446
|
-
#
|
447
|
-
#
|
447
|
+
# A string to string map specifying the exploration configuration
|
448
|
+
# hyperparameters, including `explorationWeight` and
|
449
|
+
# `explorationItemAgeCutOff`, you want to use to configure the amount
|
450
|
+
# of item exploration Amazon Personalize uses when recommending items.
|
451
|
+
# Provide `itemExplorationConfig` data only if your solution uses the
|
452
|
+
# [User-Personalization][1] recipe.
|
453
|
+
#
|
454
|
+
#
|
455
|
+
#
|
456
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
448
457
|
# @return [Hash<String,String>]
|
449
458
|
#
|
450
459
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
|
@@ -988,20 +997,10 @@ module Aws::Personalize
|
|
988
997
|
# @return [String]
|
989
998
|
#
|
990
999
|
# @!attribute [rw] filter_expression
|
991
|
-
# The filter expression
|
992
|
-
#
|
993
|
-
#
|
994
|
-
#
|
995
|
-
# `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
|
996
|
-
#
|
997
|
-
# Where "EVENT\_TYPE" is the type of event to filter out. To filter
|
998
|
-
# out all items with any interactions history, set `"*"` as the
|
999
|
-
# EVENT\_TYPE. For more information, see [Using Filters with Amazon
|
1000
|
-
# Personalize][1].
|
1001
|
-
#
|
1002
|
-
#
|
1003
|
-
#
|
1004
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
|
1000
|
+
# The filter expression defines which items are included or excluded
|
1001
|
+
# from recommendations. Filter expression must follow specific format
|
1002
|
+
# rules. For information about filter expression structure and syntax,
|
1003
|
+
# see filter-expressions.
|
1005
1004
|
# @return [String]
|
1006
1005
|
#
|
1007
1006
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateFilterRequest AWS API Documentation
|
@@ -1159,12 +1158,20 @@ module Aws::Personalize
|
|
1159
1158
|
# When your have multiple event types (using an `EVENT_TYPE` schema
|
1160
1159
|
# field), this parameter specifies which event type (for example,
|
1161
1160
|
# 'click' or 'like') is used for training the model.
|
1161
|
+
#
|
1162
|
+
# If you do not provide an `eventType`, Amazon Personalize will use
|
1163
|
+
# all interactions for training with equal weight regardless of type.
|
1162
1164
|
# @return [String]
|
1163
1165
|
#
|
1164
1166
|
# @!attribute [rw] solution_config
|
1165
1167
|
# The configuration to use with the solution. When `performAutoML` is
|
1166
1168
|
# set to true, Amazon Personalize only evaluates the `autoMLConfig`
|
1167
1169
|
# section of the solution configuration.
|
1170
|
+
#
|
1171
|
+
# <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective`
|
1172
|
+
# at this time.
|
1173
|
+
#
|
1174
|
+
# </note>
|
1168
1175
|
# @return [Types::SolutionConfig]
|
1169
1176
|
#
|
1170
1177
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionRequest AWS API Documentation
|
@@ -1218,7 +1225,12 @@ module Aws::Personalize
|
|
1218
1225
|
# The `UPDATE` option can only be used when you already have an active
|
1219
1226
|
# solution version created from the input solution using the `FULL`
|
1220
1227
|
# option and the input solution was trained with the
|
1221
|
-
#
|
1228
|
+
# [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
|
1229
|
+
#
|
1230
|
+
#
|
1231
|
+
#
|
1232
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
1233
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
|
1222
1234
|
# @return [String]
|
1223
1235
|
#
|
1224
1236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateSolutionVersionRequest AWS API Documentation
|
@@ -2533,17 +2545,9 @@ module Aws::Personalize
|
|
2533
2545
|
#
|
2534
2546
|
# @!attribute [rw] filter_expression
|
2535
2547
|
# Specifies the type of item interactions to filter out of
|
2536
|
-
# recommendation results. The filter expression must follow
|
2537
|
-
#
|
2538
|
-
#
|
2539
|
-
# `EXCLUDE itemId WHERE INTERACTIONS.event_type in ("EVENT_TYPE")`
|
2540
|
-
#
|
2541
|
-
# Where "EVENT\_TYPE" is the type of event to filter out. For more
|
2542
|
-
# information, see [Using Filters with Amazon Personalize][1].
|
2543
|
-
#
|
2544
|
-
#
|
2545
|
-
#
|
2546
|
-
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/filters.html
|
2548
|
+
# recommendation results. The filter expression must follow specific
|
2549
|
+
# format rules. For information about filter expression structure and
|
2550
|
+
# syntax, see filter-expressions.
|
2547
2551
|
# @return [String]
|
2548
2552
|
#
|
2549
2553
|
# @!attribute [rw] status
|
@@ -2646,9 +2650,7 @@ module Aws::Personalize
|
|
2646
2650
|
include Aws::Structure
|
2647
2651
|
end
|
2648
2652
|
|
2649
|
-
# Describes the properties for hyperparameter optimization (HPO).
|
2650
|
-
# use with the bring-your-own-recipe feature. Do not use for Amazon
|
2651
|
-
# Personalize native recipes.
|
2653
|
+
# Describes the properties for hyperparameter optimization (HPO).
|
2652
2654
|
#
|
2653
2655
|
# @note When making an API call, you may pass HPOConfig
|
2654
2656
|
# data as a hash:
|
@@ -2689,6 +2691,11 @@ module Aws::Personalize
|
|
2689
2691
|
#
|
2690
2692
|
# @!attribute [rw] hpo_objective
|
2691
2693
|
# The metric to optimize during HPO.
|
2694
|
+
#
|
2695
|
+
# <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective`
|
2696
|
+
# at this time.
|
2697
|
+
#
|
2698
|
+
# </note>
|
2692
2699
|
# @return [Types::HPOObjective]
|
2693
2700
|
#
|
2694
2701
|
# @!attribute [rw] hpo_resource_config
|
@@ -2711,6 +2718,11 @@ module Aws::Personalize
|
|
2711
2718
|
|
2712
2719
|
# The metric to optimize during hyperparameter optimization (HPO).
|
2713
2720
|
#
|
2721
|
+
# <note markdown="1"> Amazon Personalize doesn't support configuring the `hpoObjective` at
|
2722
|
+
# this time.
|
2723
|
+
#
|
2724
|
+
# </note>
|
2725
|
+
#
|
2714
2726
|
# @note When making an API call, you may pass HPOObjective
|
2715
2727
|
# data as a hash:
|
2716
2728
|
#
|
@@ -3633,7 +3645,9 @@ module Aws::Personalize
|
|
3633
3645
|
#
|
3634
3646
|
# @!attribute [rw] event_type
|
3635
3647
|
# The event type (for example, 'click' or 'like') that is used for
|
3636
|
-
# training the model.
|
3648
|
+
# training the model. If no `eventType` is provided, Amazon
|
3649
|
+
# Personalize uses all interactions for training with equal weight
|
3650
|
+
# regardless of type.
|
3637
3651
|
# @return [String]
|
3638
3652
|
#
|
3639
3653
|
# @!attribute [rw] solution_config
|
@@ -3863,17 +3877,23 @@ module Aws::Personalize
|
|
3863
3877
|
# @return [Float]
|
3864
3878
|
#
|
3865
3879
|
# @!attribute [rw] training_mode
|
3866
|
-
# The scope of training
|
3867
|
-
# `FULL` option trains the solution version based on the
|
3868
|
-
# the input solution's training data, while the `UPDATE`
|
3869
|
-
# processes only the
|
3870
|
-
#
|
3871
|
-
#
|
3872
|
-
#
|
3873
|
-
#
|
3874
|
-
# The `UPDATE` option can only be used
|
3875
|
-
# solution version
|
3876
|
-
#
|
3880
|
+
# The scope of training to be performed when creating the solution
|
3881
|
+
# version. The `FULL` option trains the solution version based on the
|
3882
|
+
# entirety of the input solution's training data, while the `UPDATE`
|
3883
|
+
# option processes only the data that has changed in comparison to the
|
3884
|
+
# input solution. Choose `UPDATE` when you want to incrementally
|
3885
|
+
# update your solution version instead of creating an entirely new
|
3886
|
+
# one.
|
3887
|
+
#
|
3888
|
+
# The `UPDATE` option can only be used when you already have an active
|
3889
|
+
# solution version created from the input solution using the `FULL`
|
3890
|
+
# option and the input solution was trained with the
|
3891
|
+
# [User-Personalization][1] recipe or the [HRNN-Coldstart][2] recipe.
|
3892
|
+
#
|
3893
|
+
#
|
3894
|
+
#
|
3895
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
3896
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
|
3877
3897
|
# @return [String]
|
3878
3898
|
#
|
3879
3899
|
# @!attribute [rw] tuned_hpo_params
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-personalize
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.20.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:
|
11
|
+
date: 2021-01-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|