aws-sdk-personalize 1.55.0 → 1.57.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 +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-personalize/client.rb +125 -33
- data/lib/aws-sdk-personalize/client_api.rb +17 -0
- data/lib/aws-sdk-personalize/endpoint_provider.rb +1 -1
- data/lib/aws-sdk-personalize/plugins/endpoints.rb +3 -2
- data/lib/aws-sdk-personalize/types.rb +149 -24
- data/lib/aws-sdk-personalize.rb +1 -1
- 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: 497ec8ab9d141f4d66a35ea8f66994b1ec0db37e5ff480febc5a4d8ffb75ffaf
|
4
|
+
data.tar.gz: d0d7c01a94947ac6a74f0205a6e4fe96e9b9e4405c27a56abc404ab9689a49d5
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 196eafeab48df267c053ec31ef8dc88f730a677b6f74ed9c765f22fc9bee81b525574ad283c794ee93b336a0a18fa89d2e7abc0b076e69c69c2dc52b16ea6265
|
7
|
+
data.tar.gz: 8d6d7b8423c0de6f5365ff03898db20795f7c23bf8e0d332a9da908e4ed3cfeb8ba3a920078dc459cff708f3ae0d8fc7c3637ff9f3d594bb02cb83fad96ca01a
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.57.0 (2023-11-28)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.56.0 (2023-11-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Enables metadata in recommendations, recommendations with themes, and next best action recommendations
|
13
|
+
|
4
14
|
1.55.0 (2023-11-22)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.57.0
|
@@ -398,13 +398,35 @@ module Aws::Personalize
|
|
398
398
|
|
399
399
|
# @!group API Operations
|
400
400
|
|
401
|
-
#
|
402
|
-
#
|
403
|
-
#
|
401
|
+
# Generates batch recommendations based on a list of items or users
|
402
|
+
# stored in Amazon S3 and exports the recommendations to an Amazon S3
|
403
|
+
# bucket.
|
404
404
|
#
|
405
|
+
# To generate batch recommendations, specify the ARN of a solution
|
406
|
+
# version and an Amazon S3 URI for the input and output data. For user
|
407
|
+
# personalization, popular items, and personalized ranking solutions,
|
408
|
+
# the batch inference job generates a list of recommended items for each
|
409
|
+
# user ID in the input file. For related items solutions, the job
|
410
|
+
# generates a list of recommended items for each item ID in the input
|
411
|
+
# file.
|
405
412
|
#
|
413
|
+
# For more information, see [Creating a batch inference job ][1].
|
406
414
|
#
|
407
|
-
#
|
415
|
+
# If you use the Similar-Items recipe, Amazon Personalize can add
|
416
|
+
# descriptive themes to batch recommendations. To generate themes, set
|
417
|
+
# the job's mode to `THEME_GENERATION` and specify the name of the
|
418
|
+
# field that contains item names in the input data.
|
419
|
+
#
|
420
|
+
# For more information about generating themes, see [Batch
|
421
|
+
# recommendations with themes from Content Generator ][2].
|
422
|
+
#
|
423
|
+
# You can't get batch recommendations with the Trending-Now or
|
424
|
+
# Next-Best-Action recipes.
|
425
|
+
#
|
426
|
+
#
|
427
|
+
#
|
428
|
+
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/getting-batch-recommendations.html
|
429
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/themed-batch-recommendations.html
|
408
430
|
#
|
409
431
|
# @option params [required, String] :job_name
|
410
432
|
# The name of the batch inference job to create.
|
@@ -448,6 +470,24 @@ module Aws::Personalize
|
|
448
470
|
#
|
449
471
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
450
472
|
#
|
473
|
+
# @option params [String] :batch_inference_job_mode
|
474
|
+
# The mode of the batch inference job. To generate descriptive themes
|
475
|
+
# for groups of similar items, set the job mode to `THEME_GENERATION`.
|
476
|
+
# If you don't want to generate themes, use the default
|
477
|
+
# `BATCH_INFERENCE`.
|
478
|
+
#
|
479
|
+
# When you get batch recommendations with themes, you will incur
|
480
|
+
# additional costs. For more information, see [Amazon Personalize
|
481
|
+
# pricing][1].
|
482
|
+
#
|
483
|
+
#
|
484
|
+
#
|
485
|
+
# [1]: https://aws.amazon.com/personalize/pricing/
|
486
|
+
#
|
487
|
+
# @option params [Types::ThemeGenerationConfig] :theme_generation_config
|
488
|
+
# For theme generation jobs, specify the name of the column in your
|
489
|
+
# Items dataset that contains each item's name.
|
490
|
+
#
|
451
491
|
# @return [Types::CreateBatchInferenceJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
452
492
|
#
|
453
493
|
# * {Types::CreateBatchInferenceJobResponse#batch_inference_job_arn #batch_inference_job_arn} => String
|
@@ -483,6 +523,12 @@ module Aws::Personalize
|
|
483
523
|
# tag_value: "TagValue", # required
|
484
524
|
# },
|
485
525
|
# ],
|
526
|
+
# batch_inference_job_mode: "BATCH_INFERENCE", # accepts BATCH_INFERENCE, THEME_GENERATION
|
527
|
+
# theme_generation_config: {
|
528
|
+
# fields_for_theme_generation: { # required
|
529
|
+
# item_name: "ColumnName", # required
|
530
|
+
# },
|
531
|
+
# },
|
486
532
|
# })
|
487
533
|
#
|
488
534
|
# @example Response structure
|
@@ -695,6 +741,7 @@ module Aws::Personalize
|
|
695
741
|
# item_exploration_config: {
|
696
742
|
# "ParameterName" => "ParameterValue",
|
697
743
|
# },
|
744
|
+
# enable_metadata_with_recommendations: false,
|
698
745
|
# },
|
699
746
|
# tags: [
|
700
747
|
# {
|
@@ -721,17 +768,21 @@ module Aws::Personalize
|
|
721
768
|
# Use [CreateDatasetImportJob][1] to import your training data to a
|
722
769
|
# dataset.
|
723
770
|
#
|
724
|
-
# There are
|
771
|
+
# There are 5 types of datasets:
|
725
772
|
#
|
726
|
-
# *
|
773
|
+
# * Item interactions
|
727
774
|
#
|
728
775
|
# * Items
|
729
776
|
#
|
730
777
|
# * Users
|
731
778
|
#
|
779
|
+
# * Action interactions
|
780
|
+
#
|
781
|
+
# * Actions
|
782
|
+
#
|
732
783
|
# Each dataset type has an associated schema with required field types.
|
733
|
-
# Only the `
|
734
|
-
# (also referred to as creating a solution).
|
784
|
+
# Only the `Item interactions` dataset is required in order to train a
|
785
|
+
# model (also referred to as creating a solution).
|
735
786
|
#
|
736
787
|
# A dataset can be in one of the following states:
|
737
788
|
#
|
@@ -782,6 +833,10 @@ module Aws::Personalize
|
|
782
833
|
#
|
783
834
|
# * Users
|
784
835
|
#
|
836
|
+
# * Actions
|
837
|
+
#
|
838
|
+
# * Action\_Interactions
|
839
|
+
#
|
785
840
|
# @option params [Array<Types::Tag>] :tags
|
786
841
|
# A list of [tags][1] to apply to the dataset.
|
787
842
|
#
|
@@ -919,12 +974,16 @@ module Aws::Personalize
|
|
919
974
|
# Amazon Personalize resources. A dataset group can contain at most
|
920
975
|
# three datasets, one for each type of dataset:
|
921
976
|
#
|
922
|
-
# *
|
977
|
+
# * Item interactions
|
923
978
|
#
|
924
979
|
# * Items
|
925
980
|
#
|
926
981
|
# * Users
|
927
982
|
#
|
983
|
+
# * Actions
|
984
|
+
#
|
985
|
+
# * Action interactions
|
986
|
+
#
|
928
987
|
# A dataset group can be a Domain dataset group, where you specify a
|
929
988
|
# domain and use pre-configured resources like recommenders, or a Custom
|
930
989
|
# dataset group, where you use custom resources, such as a solution with
|
@@ -1049,6 +1108,12 @@ module Aws::Personalize
|
|
1049
1108
|
# bucket, see [Giving Amazon Personalize Access to Amazon S3
|
1050
1109
|
# Resources][1].
|
1051
1110
|
#
|
1111
|
+
# If you already created a recommender or deployed a custom solution
|
1112
|
+
# version with a campaign, how new bulk records influence
|
1113
|
+
# recommendations depends on the domain use case or recipe that you use.
|
1114
|
+
# For more information, see [How new data influences real-time
|
1115
|
+
# recommendations][2].
|
1116
|
+
#
|
1052
1117
|
# By default, a dataset import job replaces any existing data in the
|
1053
1118
|
# dataset that you imported in bulk. To add new records without
|
1054
1119
|
# replacing existing data, specify INCREMENTAL for the import mode in
|
@@ -1064,7 +1129,7 @@ module Aws::Personalize
|
|
1064
1129
|
# ^
|
1065
1130
|
#
|
1066
1131
|
# To get the status of the import job, call
|
1067
|
-
# [DescribeDatasetImportJob][
|
1132
|
+
# [DescribeDatasetImportJob][3], providing the Amazon Resource Name
|
1068
1133
|
# (ARN) of the dataset import job. The dataset import is complete when
|
1069
1134
|
# the status shows as ACTIVE. If the status shows as CREATE FAILED, the
|
1070
1135
|
# response includes a `failureReason` key, which describes why the job
|
@@ -1077,15 +1142,16 @@ module Aws::Personalize
|
|
1077
1142
|
#
|
1078
1143
|
# **Related APIs**
|
1079
1144
|
#
|
1080
|
-
# * [ListDatasetImportJobs][
|
1145
|
+
# * [ListDatasetImportJobs][4]
|
1081
1146
|
#
|
1082
|
-
# * [DescribeDatasetImportJob][
|
1147
|
+
# * [DescribeDatasetImportJob][3]
|
1083
1148
|
#
|
1084
1149
|
#
|
1085
1150
|
#
|
1086
1151
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/granting-personalize-s3-access.html
|
1087
|
-
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/
|
1088
|
-
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/
|
1152
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/how-new-data-influences-recommendations.html
|
1153
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeDatasetImportJob.html
|
1154
|
+
# [4]: https://docs.aws.amazon.com/personalize/latest/dg/API_ListDatasetImportJobs.html
|
1089
1155
|
#
|
1090
1156
|
# @option params [required, String] :job_name
|
1091
1157
|
# The name for the dataset import job.
|
@@ -1170,8 +1236,8 @@ module Aws::Personalize
|
|
1170
1236
|
#
|
1171
1237
|
# When you create an event tracker, the response includes a tracking ID,
|
1172
1238
|
# which you pass as a parameter when you use the [PutEvents][1]
|
1173
|
-
# operation. Amazon Personalize then appends the event data to the
|
1174
|
-
#
|
1239
|
+
# operation. Amazon Personalize then appends the event data to the Item
|
1240
|
+
# interactions dataset of the dataset group you specify in your event
|
1175
1241
|
# tracker.
|
1176
1242
|
#
|
1177
1243
|
# The event tracker can be in one of the following states:
|
@@ -1497,6 +1563,7 @@ module Aws::Personalize
|
|
1497
1563
|
# "DatasetType" => ["ColumnName"],
|
1498
1564
|
# },
|
1499
1565
|
# },
|
1566
|
+
# enable_metadata_with_recommendations: false,
|
1500
1567
|
# },
|
1501
1568
|
# tags: [
|
1502
1569
|
# {
|
@@ -1851,21 +1918,30 @@ module Aws::Personalize
|
|
1851
1918
|
#
|
1852
1919
|
# @option params [String] :training_mode
|
1853
1920
|
# The scope of training to be performed when creating the solution
|
1854
|
-
# version. The `FULL
|
1855
|
-
# entirety of the
|
1856
|
-
#
|
1857
|
-
#
|
1858
|
-
#
|
1921
|
+
# version. The default is `FULL`. This creates a completely new model
|
1922
|
+
# based on the entirety of the training data from the datasets in your
|
1923
|
+
# dataset group.
|
1924
|
+
#
|
1925
|
+
# If you use [User-Personalization][1], you can specify a training mode
|
1926
|
+
# of `UPDATE`. This updates the model to consider new items for
|
1927
|
+
# recommendations. It is not a full retraining. You should still
|
1928
|
+
# complete a full retraining weekly. If you specify `UPDATE`, Amazon
|
1929
|
+
# Personalize will stop automatic updates for the solution version. To
|
1930
|
+
# resume updates, create a new solution with training mode set to `FULL`
|
1931
|
+
# and deploy it in a campaign. For more information about automatic
|
1932
|
+
# updates, see [Automatic updates][2].
|
1859
1933
|
#
|
1860
1934
|
# The `UPDATE` option can only be used when you already have an active
|
1861
1935
|
# solution version created from the input solution using the `FULL`
|
1862
1936
|
# option and the input solution was trained with the
|
1863
|
-
# [User-Personalization][1] recipe or the [HRNN-Coldstart][
|
1937
|
+
# [User-Personalization][1] recipe or the legacy [HRNN-Coldstart][3]
|
1938
|
+
# recipe.
|
1864
1939
|
#
|
1865
1940
|
#
|
1866
1941
|
#
|
1867
1942
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
1868
|
-
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/
|
1943
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates
|
1944
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
|
1869
1945
|
#
|
1870
1946
|
# @option params [Array<Types::Tag>] :tags
|
1871
1947
|
# A list of [tags][1] to apply to the solution version.
|
@@ -1994,9 +2070,9 @@ module Aws::Personalize
|
|
1994
2070
|
req.send_request(options)
|
1995
2071
|
end
|
1996
2072
|
|
1997
|
-
# Deletes the event tracker. Does not delete the
|
1998
|
-
# dataset
|
1999
|
-
#
|
2073
|
+
# Deletes the event tracker. Does not delete the dataset from the
|
2074
|
+
# dataset group. For more information on event trackers, see
|
2075
|
+
# [CreateEventTracker][1].
|
2000
2076
|
#
|
2001
2077
|
#
|
2002
2078
|
#
|
@@ -2240,6 +2316,8 @@ module Aws::Personalize
|
|
2240
2316
|
# resp.batch_inference_job.batch_inference_job_config.item_exploration_config #=> Hash
|
2241
2317
|
# resp.batch_inference_job.batch_inference_job_config.item_exploration_config["ParameterName"] #=> String
|
2242
2318
|
# resp.batch_inference_job.role_arn #=> String
|
2319
|
+
# resp.batch_inference_job.batch_inference_job_mode #=> String, one of "BATCH_INFERENCE", "THEME_GENERATION"
|
2320
|
+
# resp.batch_inference_job.theme_generation_config.fields_for_theme_generation.item_name #=> String
|
2243
2321
|
# resp.batch_inference_job.status #=> String
|
2244
2322
|
# resp.batch_inference_job.creation_date_time #=> Time
|
2245
2323
|
# resp.batch_inference_job.last_updated_date_time #=> Time
|
@@ -2335,6 +2413,7 @@ module Aws::Personalize
|
|
2335
2413
|
# resp.campaign.min_provisioned_tps #=> Integer
|
2336
2414
|
# resp.campaign.campaign_config.item_exploration_config #=> Hash
|
2337
2415
|
# resp.campaign.campaign_config.item_exploration_config["ParameterName"] #=> String
|
2416
|
+
# resp.campaign.campaign_config.enable_metadata_with_recommendations #=> Boolean
|
2338
2417
|
# resp.campaign.status #=> String
|
2339
2418
|
# resp.campaign.failure_reason #=> String
|
2340
2419
|
# resp.campaign.creation_date_time #=> Time
|
@@ -2343,6 +2422,7 @@ module Aws::Personalize
|
|
2343
2422
|
# resp.campaign.latest_campaign_update.min_provisioned_tps #=> Integer
|
2344
2423
|
# resp.campaign.latest_campaign_update.campaign_config.item_exploration_config #=> Hash
|
2345
2424
|
# resp.campaign.latest_campaign_update.campaign_config.item_exploration_config["ParameterName"] #=> String
|
2425
|
+
# resp.campaign.latest_campaign_update.campaign_config.enable_metadata_with_recommendations #=> Boolean
|
2346
2426
|
# resp.campaign.latest_campaign_update.status #=> String
|
2347
2427
|
# resp.campaign.latest_campaign_update.failure_reason #=> String
|
2348
2428
|
# resp.campaign.latest_campaign_update.creation_date_time #=> Time
|
@@ -2392,6 +2472,7 @@ module Aws::Personalize
|
|
2392
2472
|
# resp.dataset.latest_dataset_update.failure_reason #=> String
|
2393
2473
|
# resp.dataset.latest_dataset_update.creation_date_time #=> Time
|
2394
2474
|
# resp.dataset.latest_dataset_update.last_updated_date_time #=> Time
|
2475
|
+
# resp.dataset.tracking_id #=> String
|
2395
2476
|
#
|
2396
2477
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/DescribeDataset AWS API Documentation
|
2397
2478
|
#
|
@@ -2783,6 +2864,7 @@ module Aws::Personalize
|
|
2783
2864
|
# resp.recommender.recommender_config.training_data_config.excluded_dataset_columns #=> Hash
|
2784
2865
|
# resp.recommender.recommender_config.training_data_config.excluded_dataset_columns["DatasetType"] #=> Array
|
2785
2866
|
# resp.recommender.recommender_config.training_data_config.excluded_dataset_columns["DatasetType"][0] #=> String
|
2867
|
+
# resp.recommender.recommender_config.enable_metadata_with_recommendations #=> Boolean
|
2786
2868
|
# resp.recommender.creation_date_time #=> Time
|
2787
2869
|
# resp.recommender.last_updated_date_time #=> Time
|
2788
2870
|
# resp.recommender.status #=> String
|
@@ -2793,6 +2875,7 @@ module Aws::Personalize
|
|
2793
2875
|
# resp.recommender.latest_recommender_update.recommender_config.training_data_config.excluded_dataset_columns #=> Hash
|
2794
2876
|
# resp.recommender.latest_recommender_update.recommender_config.training_data_config.excluded_dataset_columns["DatasetType"] #=> Array
|
2795
2877
|
# resp.recommender.latest_recommender_update.recommender_config.training_data_config.excluded_dataset_columns["DatasetType"][0] #=> String
|
2878
|
+
# resp.recommender.latest_recommender_update.recommender_config.enable_metadata_with_recommendations #=> Boolean
|
2796
2879
|
# resp.recommender.latest_recommender_update.creation_date_time #=> Time
|
2797
2880
|
# resp.recommender.latest_recommender_update.last_updated_date_time #=> Time
|
2798
2881
|
# resp.recommender.latest_recommender_update.status #=> String
|
@@ -3074,6 +3157,7 @@ module Aws::Personalize
|
|
3074
3157
|
# resp.batch_inference_jobs[0].last_updated_date_time #=> Time
|
3075
3158
|
# resp.batch_inference_jobs[0].failure_reason #=> String
|
3076
3159
|
# resp.batch_inference_jobs[0].solution_version_arn #=> String
|
3160
|
+
# resp.batch_inference_jobs[0].batch_inference_job_mode #=> String, one of "BATCH_INFERENCE", "THEME_GENERATION"
|
3077
3161
|
# resp.next_token #=> String
|
3078
3162
|
#
|
3079
3163
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ListBatchInferenceJobs AWS API Documentation
|
@@ -3379,8 +3463,8 @@ module Aws::Personalize
|
|
3379
3463
|
# datasets to list.
|
3380
3464
|
#
|
3381
3465
|
# @option params [String] :next_token
|
3382
|
-
# A token returned from the previous call to `
|
3383
|
-
#
|
3466
|
+
# A token returned from the previous call to `ListDatasets` for getting
|
3467
|
+
# the next set of dataset import jobs (if they exist).
|
3384
3468
|
#
|
3385
3469
|
# @option params [Integer] :max_results
|
3386
3470
|
# The maximum number of datasets to return.
|
@@ -3720,6 +3804,7 @@ module Aws::Personalize
|
|
3720
3804
|
# resp.recommenders[0].recommender_config.training_data_config.excluded_dataset_columns #=> Hash
|
3721
3805
|
# resp.recommenders[0].recommender_config.training_data_config.excluded_dataset_columns["DatasetType"] #=> Array
|
3722
3806
|
# resp.recommenders[0].recommender_config.training_data_config.excluded_dataset_columns["DatasetType"][0] #=> String
|
3807
|
+
# resp.recommenders[0].recommender_config.enable_metadata_with_recommendations #=> Boolean
|
3723
3808
|
# resp.recommenders[0].status #=> String
|
3724
3809
|
# resp.recommenders[0].creation_date_time #=> Time
|
3725
3810
|
# resp.recommenders[0].last_updated_date_time #=> Time
|
@@ -4082,8 +4167,10 @@ module Aws::Personalize
|
|
4082
4167
|
req.send_request(options)
|
4083
4168
|
end
|
4084
4169
|
|
4085
|
-
# Updates a campaign
|
4086
|
-
#
|
4170
|
+
# Updates a campaign to deploy a retrained solution version with an
|
4171
|
+
# existing campaign, change your campaign's `minProvisionedTPS`, or
|
4172
|
+
# modify your campaign's configuration, such as the exploration
|
4173
|
+
# configuration.
|
4087
4174
|
#
|
4088
4175
|
# To update a campaign, the campaign status must be ACTIVE or CREATE
|
4089
4176
|
# FAILED. Check the campaign status using the [DescribeCampaign][1]
|
@@ -4096,12 +4183,15 @@ module Aws::Personalize
|
|
4096
4183
|
#
|
4097
4184
|
# </note>
|
4098
4185
|
#
|
4099
|
-
# For more information
|
4186
|
+
# For more information about updating a campaign, including code
|
4187
|
+
# samples, see [Updating a campaign][2]. For more information about
|
4188
|
+
# campaigns, see [Creating a campaign][3].
|
4100
4189
|
#
|
4101
4190
|
#
|
4102
4191
|
#
|
4103
4192
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/API_DescribeCampaign.html
|
4104
|
-
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/
|
4193
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/update-campaigns.html
|
4194
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html
|
4105
4195
|
#
|
4106
4196
|
# @option params [required, String] :campaign_arn
|
4107
4197
|
# The Amazon Resource Name (ARN) of the campaign.
|
@@ -4134,6 +4224,7 @@ module Aws::Personalize
|
|
4134
4224
|
# item_exploration_config: {
|
4135
4225
|
# "ParameterName" => "ParameterValue",
|
4136
4226
|
# },
|
4227
|
+
# enable_metadata_with_recommendations: false,
|
4137
4228
|
# },
|
4138
4229
|
# })
|
4139
4230
|
#
|
@@ -4276,6 +4367,7 @@ module Aws::Personalize
|
|
4276
4367
|
# "DatasetType" => ["ColumnName"],
|
4277
4368
|
# },
|
4278
4369
|
# },
|
4370
|
+
# enable_metadata_with_recommendations: false,
|
4279
4371
|
# },
|
4280
4372
|
# })
|
4281
4373
|
#
|
@@ -4305,7 +4397,7 @@ module Aws::Personalize
|
|
4305
4397
|
params: params,
|
4306
4398
|
config: config)
|
4307
4399
|
context[:gem_name] = 'aws-sdk-personalize'
|
4308
|
-
context[:gem_version] = '1.
|
4400
|
+
context[:gem_version] = '1.57.0'
|
4309
4401
|
Seahorse::Client::Request.new(handlers, context)
|
4310
4402
|
end
|
4311
4403
|
|
@@ -24,6 +24,7 @@ module Aws::Personalize
|
|
24
24
|
BatchInferenceJob = Shapes::StructureShape.new(name: 'BatchInferenceJob')
|
25
25
|
BatchInferenceJobConfig = Shapes::StructureShape.new(name: 'BatchInferenceJobConfig')
|
26
26
|
BatchInferenceJobInput = Shapes::StructureShape.new(name: 'BatchInferenceJobInput')
|
27
|
+
BatchInferenceJobMode = Shapes::StringShape.new(name: 'BatchInferenceJobMode')
|
27
28
|
BatchInferenceJobOutput = Shapes::StructureShape.new(name: 'BatchInferenceJobOutput')
|
28
29
|
BatchInferenceJobSummary = Shapes::StructureShape.new(name: 'BatchInferenceJobSummary')
|
29
30
|
BatchInferenceJobs = Shapes::ListShape.new(name: 'BatchInferenceJobs')
|
@@ -159,6 +160,7 @@ module Aws::Personalize
|
|
159
160
|
FeatureTransformation = Shapes::StructureShape.new(name: 'FeatureTransformation')
|
160
161
|
FeatureTransformationParameters = Shapes::MapShape.new(name: 'FeatureTransformationParameters')
|
161
162
|
FeaturizationParameters = Shapes::MapShape.new(name: 'FeaturizationParameters')
|
163
|
+
FieldsForThemeGeneration = Shapes::StructureShape.new(name: 'FieldsForThemeGeneration')
|
162
164
|
Filter = Shapes::StructureShape.new(name: 'Filter')
|
163
165
|
FilterExpression = Shapes::StringShape.new(name: 'FilterExpression')
|
164
166
|
FilterSummary = Shapes::StructureShape.new(name: 'FilterSummary')
|
@@ -277,6 +279,7 @@ module Aws::Personalize
|
|
277
279
|
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
278
280
|
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
279
281
|
Tags = Shapes::ListShape.new(name: 'Tags')
|
282
|
+
ThemeGenerationConfig = Shapes::StructureShape.new(name: 'ThemeGenerationConfig')
|
280
283
|
TooManyTagKeysException = Shapes::StructureShape.new(name: 'TooManyTagKeysException')
|
281
284
|
TooManyTagsException = Shapes::StructureShape.new(name: 'TooManyTagsException')
|
282
285
|
TrackingId = Shapes::StringShape.new(name: 'TrackingId')
|
@@ -333,6 +336,8 @@ module Aws::Personalize
|
|
333
336
|
BatchInferenceJob.add_member(:job_output, Shapes::ShapeRef.new(shape: BatchInferenceJobOutput, location_name: "jobOutput"))
|
334
337
|
BatchInferenceJob.add_member(:batch_inference_job_config, Shapes::ShapeRef.new(shape: BatchInferenceJobConfig, location_name: "batchInferenceJobConfig"))
|
335
338
|
BatchInferenceJob.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "roleArn"))
|
339
|
+
BatchInferenceJob.add_member(:batch_inference_job_mode, Shapes::ShapeRef.new(shape: BatchInferenceJobMode, location_name: "batchInferenceJobMode"))
|
340
|
+
BatchInferenceJob.add_member(:theme_generation_config, Shapes::ShapeRef.new(shape: ThemeGenerationConfig, location_name: "themeGenerationConfig"))
|
336
341
|
BatchInferenceJob.add_member(:status, Shapes::ShapeRef.new(shape: Status, location_name: "status"))
|
337
342
|
BatchInferenceJob.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
|
338
343
|
BatchInferenceJob.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
|
@@ -354,6 +359,7 @@ module Aws::Personalize
|
|
354
359
|
BatchInferenceJobSummary.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
|
355
360
|
BatchInferenceJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "failureReason"))
|
356
361
|
BatchInferenceJobSummary.add_member(:solution_version_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "solutionVersionArn"))
|
362
|
+
BatchInferenceJobSummary.add_member(:batch_inference_job_mode, Shapes::ShapeRef.new(shape: BatchInferenceJobMode, location_name: "batchInferenceJobMode"))
|
357
363
|
BatchInferenceJobSummary.struct_class = Types::BatchInferenceJobSummary
|
358
364
|
|
359
365
|
BatchInferenceJobs.member = Shapes::ShapeRef.new(shape: BatchInferenceJobSummary)
|
@@ -402,6 +408,7 @@ module Aws::Personalize
|
|
402
408
|
Campaign.struct_class = Types::Campaign
|
403
409
|
|
404
410
|
CampaignConfig.add_member(:item_exploration_config, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "itemExplorationConfig"))
|
411
|
+
CampaignConfig.add_member(:enable_metadata_with_recommendations, Shapes::ShapeRef.new(shape: Boolean, location_name: "enableMetadataWithRecommendations"))
|
405
412
|
CampaignConfig.struct_class = Types::CampaignConfig
|
406
413
|
|
407
414
|
CampaignSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
|
@@ -449,6 +456,8 @@ module Aws::Personalize
|
|
449
456
|
CreateBatchInferenceJobRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "roleArn"))
|
450
457
|
CreateBatchInferenceJobRequest.add_member(:batch_inference_job_config, Shapes::ShapeRef.new(shape: BatchInferenceJobConfig, location_name: "batchInferenceJobConfig"))
|
451
458
|
CreateBatchInferenceJobRequest.add_member(:tags, Shapes::ShapeRef.new(shape: Tags, location_name: "tags"))
|
459
|
+
CreateBatchInferenceJobRequest.add_member(:batch_inference_job_mode, Shapes::ShapeRef.new(shape: BatchInferenceJobMode, location_name: "batchInferenceJobMode"))
|
460
|
+
CreateBatchInferenceJobRequest.add_member(:theme_generation_config, Shapes::ShapeRef.new(shape: ThemeGenerationConfig, location_name: "themeGenerationConfig"))
|
452
461
|
CreateBatchInferenceJobRequest.struct_class = Types::CreateBatchInferenceJobRequest
|
453
462
|
|
454
463
|
CreateBatchInferenceJobResponse.add_member(:batch_inference_job_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "batchInferenceJobArn"))
|
@@ -600,6 +609,7 @@ module Aws::Personalize
|
|
600
609
|
Dataset.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
|
601
610
|
Dataset.add_member(:last_updated_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "lastUpdatedDateTime"))
|
602
611
|
Dataset.add_member(:latest_dataset_update, Shapes::ShapeRef.new(shape: DatasetUpdateSummary, location_name: "latestDatasetUpdate"))
|
612
|
+
Dataset.add_member(:tracking_id, Shapes::ShapeRef.new(shape: TrackingId, location_name: "trackingId"))
|
603
613
|
Dataset.struct_class = Types::Dataset
|
604
614
|
|
605
615
|
DatasetExportJob.add_member(:job_name, Shapes::ShapeRef.new(shape: Name, location_name: "jobName"))
|
@@ -898,6 +908,9 @@ module Aws::Personalize
|
|
898
908
|
FeaturizationParameters.key = Shapes::ShapeRef.new(shape: ParameterName)
|
899
909
|
FeaturizationParameters.value = Shapes::ShapeRef.new(shape: ParameterValue)
|
900
910
|
|
911
|
+
FieldsForThemeGeneration.add_member(:item_name, Shapes::ShapeRef.new(shape: ColumnName, required: true, location_name: "itemName"))
|
912
|
+
FieldsForThemeGeneration.struct_class = Types::FieldsForThemeGeneration
|
913
|
+
|
901
914
|
Filter.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
|
902
915
|
Filter.add_member(:filter_arn, Shapes::ShapeRef.new(shape: Arn, location_name: "filterArn"))
|
903
916
|
Filter.add_member(:creation_date_time, Shapes::ShapeRef.new(shape: Date, location_name: "creationDateTime"))
|
@@ -1190,6 +1203,7 @@ module Aws::Personalize
|
|
1190
1203
|
RecommenderConfig.add_member(:item_exploration_config, Shapes::ShapeRef.new(shape: HyperParameters, location_name: "itemExplorationConfig"))
|
1191
1204
|
RecommenderConfig.add_member(:min_recommendation_requests_per_second, Shapes::ShapeRef.new(shape: TransactionsPerSecond, location_name: "minRecommendationRequestsPerSecond"))
|
1192
1205
|
RecommenderConfig.add_member(:training_data_config, Shapes::ShapeRef.new(shape: TrainingDataConfig, location_name: "trainingDataConfig"))
|
1206
|
+
RecommenderConfig.add_member(:enable_metadata_with_recommendations, Shapes::ShapeRef.new(shape: Boolean, location_name: "enableMetadataWithRecommendations"))
|
1193
1207
|
RecommenderConfig.struct_class = Types::RecommenderConfig
|
1194
1208
|
|
1195
1209
|
RecommenderSummary.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "name"))
|
@@ -1319,6 +1333,9 @@ module Aws::Personalize
|
|
1319
1333
|
|
1320
1334
|
Tags.member = Shapes::ShapeRef.new(shape: Tag)
|
1321
1335
|
|
1336
|
+
ThemeGenerationConfig.add_member(:fields_for_theme_generation, Shapes::ShapeRef.new(shape: FieldsForThemeGeneration, required: true, location_name: "fieldsForThemeGeneration"))
|
1337
|
+
ThemeGenerationConfig.struct_class = Types::ThemeGenerationConfig
|
1338
|
+
|
1322
1339
|
TooManyTagKeysException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "message"))
|
1323
1340
|
TooManyTagKeysException.struct_class = Types::TooManyTagKeysException
|
1324
1341
|
|
@@ -32,7 +32,7 @@ module Aws::Personalize
|
|
32
32
|
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
33
33
|
end
|
34
34
|
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
35
|
-
if Aws::Endpoints::Matchers.boolean_equals?(
|
35
|
+
if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
|
36
36
|
return Aws::Endpoints::Endpoint.new(url: "https://personalize-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
37
37
|
end
|
38
38
|
raise ArgumentError, "FIPS is enabled but this partition does not support FIPS"
|
@@ -25,16 +25,17 @@ module Aws::Personalize
|
|
25
25
|
# @api private
|
26
26
|
class Handler < Seahorse::Client::Handler
|
27
27
|
def call(context)
|
28
|
-
# If endpoint was discovered, do not resolve or apply the endpoint.
|
29
28
|
unless context[:discovered_endpoint]
|
30
29
|
params = parameters_for_operation(context)
|
31
30
|
endpoint = context.config.endpoint_provider.resolve_endpoint(params)
|
32
31
|
|
33
32
|
context.http_request.endpoint = endpoint.url
|
34
33
|
apply_endpoint_headers(context, endpoint.headers)
|
34
|
+
|
35
|
+
context[:endpoint_params] = params
|
36
|
+
context[:endpoint_properties] = endpoint.properties
|
35
37
|
end
|
36
38
|
|
37
|
-
context[:endpoint_params] = params
|
38
39
|
context[:auth_scheme] =
|
39
40
|
Aws::Endpoints.resolve_auth_scheme(context, endpoint)
|
40
41
|
|
@@ -187,6 +187,14 @@ module Aws::Personalize
|
|
187
187
|
# requested the batch inference job.
|
188
188
|
# @return [String]
|
189
189
|
#
|
190
|
+
# @!attribute [rw] batch_inference_job_mode
|
191
|
+
# The job's mode.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] theme_generation_config
|
195
|
+
# The job's theme generation settings.
|
196
|
+
# @return [Types::ThemeGenerationConfig]
|
197
|
+
#
|
190
198
|
# @!attribute [rw] status
|
191
199
|
# The status of the batch inference job. The status is one of the
|
192
200
|
# following values:
|
@@ -221,6 +229,8 @@ module Aws::Personalize
|
|
221
229
|
:job_output,
|
222
230
|
:batch_inference_job_config,
|
223
231
|
:role_arn,
|
232
|
+
:batch_inference_job_mode,
|
233
|
+
:theme_generation_config,
|
224
234
|
:status,
|
225
235
|
:creation_date_time,
|
226
236
|
:last_updated_date_time)
|
@@ -327,6 +337,10 @@ module Aws::Personalize
|
|
327
337
|
# The ARN of the solution version used by the batch inference job.
|
328
338
|
# @return [String]
|
329
339
|
#
|
340
|
+
# @!attribute [rw] batch_inference_job_mode
|
341
|
+
# The job's mode.
|
342
|
+
# @return [String]
|
343
|
+
#
|
330
344
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/BatchInferenceJobSummary AWS API Documentation
|
331
345
|
#
|
332
346
|
class BatchInferenceJobSummary < Struct.new(
|
@@ -336,7 +350,8 @@ module Aws::Personalize
|
|
336
350
|
:creation_date_time,
|
337
351
|
:last_updated_date_time,
|
338
352
|
:failure_reason,
|
339
|
-
:solution_version_arn
|
353
|
+
:solution_version_arn,
|
354
|
+
:batch_inference_job_mode)
|
340
355
|
SENSITIVE = []
|
341
356
|
include Aws::Structure
|
342
357
|
end
|
@@ -611,10 +626,25 @@ module Aws::Personalize
|
|
611
626
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
612
627
|
# @return [Hash<String,String>]
|
613
628
|
#
|
629
|
+
# @!attribute [rw] enable_metadata_with_recommendations
|
630
|
+
# Whether metadata with recommendations is enabled for the campaign.
|
631
|
+
# If enabled, you can specify the columns from your Items dataset in
|
632
|
+
# your request for recommendations. Amazon Personalize returns this
|
633
|
+
# data for each item in the recommendation response.
|
634
|
+
#
|
635
|
+
# If you enable metadata in recommendations, you will incur additional
|
636
|
+
# costs. For more information, see [Amazon Personalize pricing][1].
|
637
|
+
#
|
638
|
+
#
|
639
|
+
#
|
640
|
+
# [1]: https://aws.amazon.com/personalize/pricing/
|
641
|
+
# @return [Boolean]
|
642
|
+
#
|
614
643
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CampaignConfig AWS API Documentation
|
615
644
|
#
|
616
645
|
class CampaignConfig < Struct.new(
|
617
|
-
:item_exploration_config
|
646
|
+
:item_exploration_config,
|
647
|
+
:enable_metadata_with_recommendations)
|
618
648
|
SENSITIVE = []
|
619
649
|
include Aws::Structure
|
620
650
|
end
|
@@ -823,6 +853,26 @@ module Aws::Personalize
|
|
823
853
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/tagging-resources.html
|
824
854
|
# @return [Array<Types::Tag>]
|
825
855
|
#
|
856
|
+
# @!attribute [rw] batch_inference_job_mode
|
857
|
+
# The mode of the batch inference job. To generate descriptive themes
|
858
|
+
# for groups of similar items, set the job mode to `THEME_GENERATION`.
|
859
|
+
# If you don't want to generate themes, use the default
|
860
|
+
# `BATCH_INFERENCE`.
|
861
|
+
#
|
862
|
+
# When you get batch recommendations with themes, you will incur
|
863
|
+
# additional costs. For more information, see [Amazon Personalize
|
864
|
+
# pricing][1].
|
865
|
+
#
|
866
|
+
#
|
867
|
+
#
|
868
|
+
# [1]: https://aws.amazon.com/personalize/pricing/
|
869
|
+
# @return [String]
|
870
|
+
#
|
871
|
+
# @!attribute [rw] theme_generation_config
|
872
|
+
# For theme generation jobs, specify the name of the column in your
|
873
|
+
# Items dataset that contains each item's name.
|
874
|
+
# @return [Types::ThemeGenerationConfig]
|
875
|
+
#
|
826
876
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/CreateBatchInferenceJobRequest AWS API Documentation
|
827
877
|
#
|
828
878
|
class CreateBatchInferenceJobRequest < Struct.new(
|
@@ -834,7 +884,9 @@ module Aws::Personalize
|
|
834
884
|
:job_output,
|
835
885
|
:role_arn,
|
836
886
|
:batch_inference_job_config,
|
837
|
-
:tags
|
887
|
+
:tags,
|
888
|
+
:batch_inference_job_mode,
|
889
|
+
:theme_generation_config)
|
838
890
|
SENSITIVE = []
|
839
891
|
include Aws::Structure
|
840
892
|
end
|
@@ -1193,6 +1245,10 @@ module Aws::Personalize
|
|
1193
1245
|
# * Items
|
1194
1246
|
#
|
1195
1247
|
# * Users
|
1248
|
+
#
|
1249
|
+
# * Actions
|
1250
|
+
#
|
1251
|
+
# * Action\_Interactions
|
1196
1252
|
# @return [String]
|
1197
1253
|
#
|
1198
1254
|
# @!attribute [rw] tags
|
@@ -1571,22 +1627,30 @@ module Aws::Personalize
|
|
1571
1627
|
#
|
1572
1628
|
# @!attribute [rw] training_mode
|
1573
1629
|
# The scope of training to be performed when creating the solution
|
1574
|
-
# version. The `FULL
|
1575
|
-
# entirety of the
|
1576
|
-
#
|
1577
|
-
#
|
1578
|
-
#
|
1579
|
-
#
|
1630
|
+
# version. The default is `FULL`. This creates a completely new model
|
1631
|
+
# based on the entirety of the training data from the datasets in your
|
1632
|
+
# dataset group.
|
1633
|
+
#
|
1634
|
+
# If you use [User-Personalization][1], you can specify a training
|
1635
|
+
# mode of `UPDATE`. This updates the model to consider new items for
|
1636
|
+
# recommendations. It is not a full retraining. You should still
|
1637
|
+
# complete a full retraining weekly. If you specify `UPDATE`, Amazon
|
1638
|
+
# Personalize will stop automatic updates for the solution version. To
|
1639
|
+
# resume updates, create a new solution with training mode set to
|
1640
|
+
# `FULL` and deploy it in a campaign. For more information about
|
1641
|
+
# automatic updates, see [Automatic updates][2].
|
1580
1642
|
#
|
1581
1643
|
# The `UPDATE` option can only be used when you already have an active
|
1582
1644
|
# solution version created from the input solution using the `FULL`
|
1583
1645
|
# option and the input solution was trained with the
|
1584
|
-
# [User-Personalization][1] recipe or the [HRNN-Coldstart][
|
1646
|
+
# [User-Personalization][1] recipe or the legacy [HRNN-Coldstart][3]
|
1647
|
+
# recipe.
|
1585
1648
|
#
|
1586
1649
|
#
|
1587
1650
|
#
|
1588
1651
|
# [1]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-new-item-USER_PERSONALIZATION.html
|
1589
|
-
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/
|
1652
|
+
# [2]: https://docs.aws.amazon.com/personalize/latest/dg/use-case-recipe-features.html#maintaining-with-automatic-updates
|
1653
|
+
# [3]: https://docs.aws.amazon.com/personalize/latest/dg/native-recipe-hrnn-coldstart.html
|
1590
1654
|
# @return [String]
|
1591
1655
|
#
|
1592
1656
|
# @!attribute [rw] tags
|
@@ -1661,6 +1725,10 @@ module Aws::Personalize
|
|
1661
1725
|
# * Items
|
1662
1726
|
#
|
1663
1727
|
# * Users
|
1728
|
+
#
|
1729
|
+
# * Actions
|
1730
|
+
#
|
1731
|
+
# * Action\_Interactions
|
1664
1732
|
# @return [String]
|
1665
1733
|
#
|
1666
1734
|
# @!attribute [rw] schema_arn
|
@@ -1690,6 +1758,13 @@ module Aws::Personalize
|
|
1690
1758
|
# Describes the latest update to the dataset.
|
1691
1759
|
# @return [Types::DatasetUpdateSummary]
|
1692
1760
|
#
|
1761
|
+
# @!attribute [rw] tracking_id
|
1762
|
+
# The ID of the event tracker for an Action interactions dataset. You
|
1763
|
+
# specify the tracker's ID in the `PutActionInteractions` API
|
1764
|
+
# operation. Amazon Personalize uses it to direct new data to the
|
1765
|
+
# Action interactions dataset in your dataset group.
|
1766
|
+
# @return [String]
|
1767
|
+
#
|
1693
1768
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/Dataset AWS API Documentation
|
1694
1769
|
#
|
1695
1770
|
class Dataset < Struct.new(
|
@@ -1701,7 +1776,8 @@ module Aws::Personalize
|
|
1701
1776
|
:status,
|
1702
1777
|
:creation_date_time,
|
1703
1778
|
:last_updated_date_time,
|
1704
|
-
:latest_dataset_update
|
1779
|
+
:latest_dataset_update,
|
1780
|
+
:tracking_id)
|
1705
1781
|
SENSITIVE = []
|
1706
1782
|
include Aws::Structure
|
1707
1783
|
end
|
@@ -1860,12 +1936,13 @@ module Aws::Personalize
|
|
1860
1936
|
include Aws::Structure
|
1861
1937
|
end
|
1862
1938
|
|
1863
|
-
# A dataset group is a collection of related datasets (
|
1864
|
-
#
|
1865
|
-
# [CreateDatasetGroup][1]. You then create a
|
1866
|
-
# dataset group by calling [CreateDataset][2].
|
1867
|
-
# to create and train a solution by calling
|
1868
|
-
# dataset group can contain only one of each type
|
1939
|
+
# A dataset group is a collection of related datasets (Item
|
1940
|
+
# interactions, Users, Items, Actions, Action interactions). You create
|
1941
|
+
# a dataset group by calling [CreateDatasetGroup][1]. You then create a
|
1942
|
+
# dataset and add it to a dataset group by calling [CreateDataset][2].
|
1943
|
+
# The dataset group is used to create and train a solution by calling
|
1944
|
+
# [CreateSolution][3]. A dataset group can contain only one of each type
|
1945
|
+
# of dataset.
|
1869
1946
|
#
|
1870
1947
|
# You can specify an Key Management Service (KMS) key to encrypt the
|
1871
1948
|
# datasets in the group.
|
@@ -1896,8 +1973,9 @@ module Aws::Personalize
|
|
1896
1973
|
# @return [String]
|
1897
1974
|
#
|
1898
1975
|
# @!attribute [rw] role_arn
|
1899
|
-
# The ARN of the IAM role that has
|
1900
|
-
#
|
1976
|
+
# The ARN of the Identity and Access Management (IAM) role that has
|
1977
|
+
# permissions to access the Key Management Service (KMS) key.
|
1978
|
+
# Supplying an IAM role is only valid when also specifying a KMS key.
|
1901
1979
|
# @return [String]
|
1902
1980
|
#
|
1903
1981
|
# @!attribute [rw] kms_key_arn
|
@@ -3140,6 +3218,22 @@ module Aws::Personalize
|
|
3140
3218
|
include Aws::Structure
|
3141
3219
|
end
|
3142
3220
|
|
3221
|
+
# A string to string map of the configuration details for theme
|
3222
|
+
# generation.
|
3223
|
+
#
|
3224
|
+
# @!attribute [rw] item_name
|
3225
|
+
# The name of the Items dataset column that stores the name of each
|
3226
|
+
# item in the dataset.
|
3227
|
+
# @return [String]
|
3228
|
+
#
|
3229
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/FieldsForThemeGeneration AWS API Documentation
|
3230
|
+
#
|
3231
|
+
class FieldsForThemeGeneration < Struct.new(
|
3232
|
+
:item_name)
|
3233
|
+
SENSITIVE = []
|
3234
|
+
include Aws::Structure
|
3235
|
+
end
|
3236
|
+
|
3143
3237
|
# Contains information on a recommendation filter, including its ARN,
|
3144
3238
|
# status, and filter expression.
|
3145
3239
|
#
|
@@ -3701,8 +3795,8 @@ module Aws::Personalize
|
|
3701
3795
|
# @return [String]
|
3702
3796
|
#
|
3703
3797
|
# @!attribute [rw] next_token
|
3704
|
-
# A token returned from the previous call to `
|
3705
|
-
#
|
3798
|
+
# A token returned from the previous call to `ListDatasets` for
|
3799
|
+
# getting the next set of dataset import jobs (if they exist).
|
3706
3800
|
# @return [String]
|
3707
3801
|
#
|
3708
3802
|
# @!attribute [rw] max_results
|
@@ -4547,12 +4641,27 @@ module Aws::Personalize
|
|
4547
4641
|
# domain recommender.
|
4548
4642
|
# @return [Types::TrainingDataConfig]
|
4549
4643
|
#
|
4644
|
+
# @!attribute [rw] enable_metadata_with_recommendations
|
4645
|
+
# Whether metadata with recommendations is enabled for the
|
4646
|
+
# recommender. If enabled, you can specify the columns from your Items
|
4647
|
+
# dataset in your request for recommendations. Amazon Personalize
|
4648
|
+
# returns this data for each item in the recommendation response.
|
4649
|
+
#
|
4650
|
+
# If you enable metadata in recommendations, you will incur additional
|
4651
|
+
# costs. For more information, see [Amazon Personalize pricing][1].
|
4652
|
+
#
|
4653
|
+
#
|
4654
|
+
#
|
4655
|
+
# [1]: https://aws.amazon.com/personalize/pricing/
|
4656
|
+
# @return [Boolean]
|
4657
|
+
#
|
4550
4658
|
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/RecommenderConfig AWS API Documentation
|
4551
4659
|
#
|
4552
4660
|
class RecommenderConfig < Struct.new(
|
4553
4661
|
:item_exploration_config,
|
4554
4662
|
:min_recommendation_requests_per_second,
|
4555
|
-
:training_data_config
|
4663
|
+
:training_data_config,
|
4664
|
+
:enable_metadata_with_recommendations)
|
4556
4665
|
SENSITIVE = []
|
4557
4666
|
include Aws::Structure
|
4558
4667
|
end
|
@@ -4841,7 +4950,7 @@ module Aws::Personalize
|
|
4841
4950
|
# @return [Types::HPOConfig]
|
4842
4951
|
#
|
4843
4952
|
# @!attribute [rw] algorithm_hyper_parameters
|
4844
|
-
# Lists the
|
4953
|
+
# Lists the algorithm hyperparameters and their values.
|
4845
4954
|
# @return [Hash<String,String>]
|
4846
4955
|
#
|
4847
4956
|
# @!attribute [rw] feature_transformation_parameters
|
@@ -5233,6 +5342,22 @@ module Aws::Personalize
|
|
5233
5342
|
#
|
5234
5343
|
class TagResourceResponse < Aws::EmptyStructure; end
|
5235
5344
|
|
5345
|
+
# The configuration details for generating themes with a batch inference
|
5346
|
+
# job.
|
5347
|
+
#
|
5348
|
+
# @!attribute [rw] fields_for_theme_generation
|
5349
|
+
# Fields used to generate descriptive themes for a batch inference
|
5350
|
+
# job.
|
5351
|
+
# @return [Types::FieldsForThemeGeneration]
|
5352
|
+
#
|
5353
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/personalize-2018-05-22/ThemeGenerationConfig AWS API Documentation
|
5354
|
+
#
|
5355
|
+
class ThemeGenerationConfig < Struct.new(
|
5356
|
+
:fields_for_theme_generation)
|
5357
|
+
SENSITIVE = []
|
5358
|
+
include Aws::Structure
|
5359
|
+
end
|
5360
|
+
|
5236
5361
|
# The request contains more tag keys than can be associated with a
|
5237
5362
|
# resource (50 tag keys per resource).
|
5238
5363
|
#
|
data/lib/aws-sdk-personalize.rb
CHANGED
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.57.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: 2023-11-
|
11
|
+
date: 2023-11-28 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|