aws-sdk-customerprofiles 1.90.0 → 1.91.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
  SHA256:
3
- metadata.gz: a67b7e2e43fc83ef061003c56469e1f608877c932f3ae3a179b752c5d921f082
4
- data.tar.gz: 4c56559de81978a7d67552651f08dc222963e4695b2c23410f2edbe3717706c6
3
+ metadata.gz: 459db88096eb2f445ecc1a9d89d2221afeb5ab5f80e9e7965f45f0537047b845
4
+ data.tar.gz: '093c47d3f2150e5a553e8c034b1b8bf50840a6de166ce6f8da062e2458ebae0e'
5
5
  SHA512:
6
- metadata.gz: 67090735b315615dc7b1f92b7cc84ffe5bb57f90561a6f6a83a60134249cc30e9ba263acc8d3295db541f473c3ab077beef1be6698225fa5efcc1c48558f9202
7
- data.tar.gz: a198894d67b462b0f3f86fff543f9bb811bcadd1afa65574515173e27ffdc9ce2ba66f30596c026d83442bc1a4a89aeb728f33321b2b0633d43e7d26fe9025de
6
+ metadata.gz: 33849f306634497fbf5c163365d930da208d045dea7c437a8ca090d9fd2ff18c22602f95917cb0d5640421bd226a71fb73b4b66adecff7553c5fb14dbbd2df19
7
+ data.tar.gz: f90f283bbd213e973bb606f4d6fd17cac2955f67f400d35f5bee652ab8c1ef19f556514ea4951ce3c010771194cfcac4201b2aab968c284371cbdfde22be4d1f
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.91.0 (2026-07-02)
5
+ ------------------
6
+
7
+ * Feature - Amazon Connect Customer Profiles adds support for diversityConfig to recommenderConfig which can be used for diversifying the recommendations. This release also includes model versioning support which helps customer to rollback trained models.
8
+
4
9
  1.90.0 (2026-05-28)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.90.0
1
+ 1.91.0
@@ -1782,6 +1782,15 @@ module Aws::CustomerProfiles
1782
1782
  # excluded_columns: {
1783
1783
  # "String" => ["text"],
1784
1784
  # },
1785
+ # diversity_config: {
1786
+ # diversity_columns: [
1787
+ # {
1788
+ # name: "text", # required
1789
+ # cap_type: "PERCENTAGE", # required, accepts PERCENTAGE, VALUE
1790
+ # target: "DiversityTargetExpression", # required
1791
+ # },
1792
+ # ],
1793
+ # },
1785
1794
  # },
1786
1795
  # description: "sensitiveText",
1787
1796
  # recommender_schema_name: "name",
@@ -4115,6 +4124,11 @@ module Aws::CustomerProfiles
4115
4124
  # response. Use this to specify which metadata columns to return
4116
4125
  # alongside recommended items.
4117
4126
  #
4127
+ # @option params [Types::RecommendationDiversityConfig] :diversity_config
4128
+ # Runtime diversity configuration for this request. Enables
4129
+ # diversity-aware recommendations and optionally supplies values for
4130
+ # placeholder-based diversity caps configured on the recommender.
4131
+ #
4118
4132
  # @return [Types::GetProfileRecommendationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4119
4133
  #
4120
4134
  # * {Types::GetProfileRecommendationsResponse#recommendations #recommendations} => Array<Types::Recommendation>
@@ -4151,6 +4165,12 @@ module Aws::CustomerProfiles
4151
4165
  # metadata_config: {
4152
4166
  # metadata_columns: ["MetadataColumnName"],
4153
4167
  # },
4168
+ # diversity_config: {
4169
+ # enabled: false, # required
4170
+ # values: {
4171
+ # "DiversityPlaceholderName" => 1,
4172
+ # },
4173
+ # },
4154
4174
  # })
4155
4175
  #
4156
4176
  # @example Response structure
@@ -4204,6 +4224,7 @@ module Aws::CustomerProfiles
4204
4224
  # * {Types::GetRecommenderResponse#created_at #created_at} => Time
4205
4225
  # * {Types::GetRecommenderResponse#failure_reason #failure_reason} => String
4206
4226
  # * {Types::GetRecommenderResponse#latest_recommender_update #latest_recommender_update} => Types::RecommenderUpdate
4227
+ # * {Types::GetRecommenderResponse#active_recommender_version_name #active_recommender_version_name} => String
4207
4228
  # * {Types::GetRecommenderResponse#training_metrics #training_metrics} => Array<Types::TrainingMetrics>
4208
4229
  # * {Types::GetRecommenderResponse#tags #tags} => Hash<String,String>
4209
4230
  #
@@ -4232,6 +4253,10 @@ module Aws::CustomerProfiles
4232
4253
  # resp.recommender_config.excluded_columns #=> Hash
4233
4254
  # resp.recommender_config.excluded_columns["String"] #=> Array
4234
4255
  # resp.recommender_config.excluded_columns["String"][0] #=> String
4256
+ # resp.recommender_config.diversity_config.diversity_columns #=> Array
4257
+ # resp.recommender_config.diversity_config.diversity_columns[0].name #=> String
4258
+ # resp.recommender_config.diversity_config.diversity_columns[0].cap_type #=> String, one of "PERCENTAGE", "VALUE"
4259
+ # resp.recommender_config.diversity_config.diversity_columns[0].target #=> String
4235
4260
  # resp.description #=> String
4236
4261
  # resp.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
4237
4262
  # resp.last_updated_at #=> Time
@@ -4249,14 +4274,21 @@ module Aws::CustomerProfiles
4249
4274
  # resp.latest_recommender_update.recommender_config.excluded_columns #=> Hash
4250
4275
  # resp.latest_recommender_update.recommender_config.excluded_columns["String"] #=> Array
4251
4276
  # resp.latest_recommender_update.recommender_config.excluded_columns["String"][0] #=> String
4277
+ # resp.latest_recommender_update.recommender_config.diversity_config.diversity_columns #=> Array
4278
+ # resp.latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].name #=> String
4279
+ # resp.latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].cap_type #=> String, one of "PERCENTAGE", "VALUE"
4280
+ # resp.latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].target #=> String
4252
4281
  # resp.latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
4253
4282
  # resp.latest_recommender_update.created_at #=> Time
4254
4283
  # resp.latest_recommender_update.last_updated_at #=> Time
4255
4284
  # resp.latest_recommender_update.failure_reason #=> String
4285
+ # resp.latest_recommender_update.recommender_version_name #=> String
4286
+ # resp.active_recommender_version_name #=> String
4256
4287
  # resp.training_metrics #=> Array
4257
4288
  # resp.training_metrics[0].time #=> Time
4258
4289
  # resp.training_metrics[0].metrics #=> Hash
4259
4290
  # resp.training_metrics[0].metrics["TrainingMetricName"] #=> Float
4291
+ # resp.training_metrics[0].recommender_version_name #=> String
4260
4292
  # resp.tags #=> Hash
4261
4293
  # resp.tags["TagKey"] #=> String
4262
4294
  #
@@ -6073,6 +6105,10 @@ module Aws::CustomerProfiles
6073
6105
  # resp.recommenders[0].recommender_config.excluded_columns #=> Hash
6074
6106
  # resp.recommenders[0].recommender_config.excluded_columns["String"] #=> Array
6075
6107
  # resp.recommenders[0].recommender_config.excluded_columns["String"][0] #=> String
6108
+ # resp.recommenders[0].recommender_config.diversity_config.diversity_columns #=> Array
6109
+ # resp.recommenders[0].recommender_config.diversity_config.diversity_columns[0].name #=> String
6110
+ # resp.recommenders[0].recommender_config.diversity_config.diversity_columns[0].cap_type #=> String, one of "PERCENTAGE", "VALUE"
6111
+ # resp.recommenders[0].recommender_config.diversity_config.diversity_columns[0].target #=> String
6076
6112
  # resp.recommenders[0].created_at #=> Time
6077
6113
  # resp.recommenders[0].description #=> String
6078
6114
  # resp.recommenders[0].status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
@@ -6092,10 +6128,15 @@ module Aws::CustomerProfiles
6092
6128
  # resp.recommenders[0].latest_recommender_update.recommender_config.excluded_columns #=> Hash
6093
6129
  # resp.recommenders[0].latest_recommender_update.recommender_config.excluded_columns["String"] #=> Array
6094
6130
  # resp.recommenders[0].latest_recommender_update.recommender_config.excluded_columns["String"][0] #=> String
6131
+ # resp.recommenders[0].latest_recommender_update.recommender_config.diversity_config.diversity_columns #=> Array
6132
+ # resp.recommenders[0].latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].name #=> String
6133
+ # resp.recommenders[0].latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].cap_type #=> String, one of "PERCENTAGE", "VALUE"
6134
+ # resp.recommenders[0].latest_recommender_update.recommender_config.diversity_config.diversity_columns[0].target #=> String
6095
6135
  # resp.recommenders[0].latest_recommender_update.status #=> String, one of "PENDING", "IN_PROGRESS", "ACTIVE", "FAILED", "STOPPING", "INACTIVE", "STARTING", "DELETING"
6096
6136
  # resp.recommenders[0].latest_recommender_update.created_at #=> Time
6097
6137
  # resp.recommenders[0].latest_recommender_update.last_updated_at #=> Time
6098
6138
  # resp.recommenders[0].latest_recommender_update.failure_reason #=> String
6139
+ # resp.recommenders[0].latest_recommender_update.recommender_version_name #=> String
6099
6140
  #
6100
6141
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/ListRecommenders AWS API Documentation
6101
6142
  #
@@ -7957,6 +7998,10 @@ module Aws::CustomerProfiles
7957
7998
  # The new configuration settings to apply to the recommender, including
7958
7999
  # updated parameters and settings that define its behavior.
7959
8000
  #
8001
+ # @option params [String] :recommender_version_name
8002
+ # The name of a specific recommender version to activate as part of this
8003
+ # update (for example, to roll back to a previously trained version).
8004
+ #
7960
8005
  # @return [Types::UpdateRecommenderResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7961
8006
  #
7962
8007
  # * {Types::UpdateRecommenderResponse#recommender_name #recommender_name} => String
@@ -7987,7 +8032,17 @@ module Aws::CustomerProfiles
7987
8032
  # excluded_columns: {
7988
8033
  # "String" => ["text"],
7989
8034
  # },
8035
+ # diversity_config: {
8036
+ # diversity_columns: [
8037
+ # {
8038
+ # name: "text", # required
8039
+ # cap_type: "PERCENTAGE", # required, accepts PERCENTAGE, VALUE
8040
+ # target: "DiversityTargetExpression", # required
8041
+ # },
8042
+ # ],
8043
+ # },
7990
8044
  # },
8045
+ # recommender_version_name: "RecommenderVersionName",
7991
8046
  # })
7992
8047
  #
7993
8048
  # @example Response structure
@@ -8021,7 +8076,7 @@ module Aws::CustomerProfiles
8021
8076
  tracer: tracer
8022
8077
  )
8023
8078
  context[:gem_name] = 'aws-sdk-customerprofiles'
8024
- context[:gem_version] = '1.90.0'
8079
+ context[:gem_version] = '1.91.0'
8025
8080
  Seahorse::Client::Request.new(handlers, context)
8026
8081
  end
8027
8082
 
@@ -162,6 +162,14 @@ module Aws::CustomerProfiles
162
162
  DetectedProfileObjectTypes = Shapes::ListShape.new(name: 'DetectedProfileObjectTypes')
163
163
  Dimension = Shapes::UnionShape.new(name: 'Dimension')
164
164
  DimensionList = Shapes::ListShape.new(name: 'DimensionList')
165
+ DiversityCapType = Shapes::StringShape.new(name: 'DiversityCapType')
166
+ DiversityCapValue = Shapes::IntegerShape.new(name: 'DiversityCapValue')
167
+ DiversityColumn = Shapes::StructureShape.new(name: 'DiversityColumn')
168
+ DiversityColumnsList = Shapes::ListShape.new(name: 'DiversityColumnsList')
169
+ DiversityConfig = Shapes::StructureShape.new(name: 'DiversityConfig')
170
+ DiversityPlaceholderName = Shapes::StringShape.new(name: 'DiversityPlaceholderName')
171
+ DiversityTargetExpression = Shapes::StringShape.new(name: 'DiversityTargetExpression')
172
+ DiversityValuesMap = Shapes::MapShape.new(name: 'DiversityValuesMap')
165
173
  DomainList = Shapes::ListShape.new(name: 'DomainList')
166
174
  DomainObjectTypeField = Shapes::StructureShape.new(name: 'DomainObjectTypeField')
167
175
  DomainObjectTypeFieldName = Shapes::StringShape.new(name: 'DomainObjectTypeFieldName')
@@ -444,6 +452,7 @@ module Aws::CustomerProfiles
444
452
  Readiness = Shapes::StructureShape.new(name: 'Readiness')
445
453
  ReadinessStatus = Shapes::StringShape.new(name: 'ReadinessStatus')
446
454
  Recommendation = Shapes::StructureShape.new(name: 'Recommendation')
455
+ RecommendationDiversityConfig = Shapes::StructureShape.new(name: 'RecommendationDiversityConfig')
447
456
  Recommendations = Shapes::ListShape.new(name: 'Recommendations')
448
457
  RecommenderConfig = Shapes::StructureShape.new(name: 'RecommenderConfig')
449
458
  RecommenderConfigTrainingFrequencyInteger = Shapes::IntegerShape.new(name: 'RecommenderConfigTrainingFrequencyInteger')
@@ -473,6 +482,7 @@ module Aws::CustomerProfiles
473
482
  RecommenderSummary = Shapes::StructureShape.new(name: 'RecommenderSummary')
474
483
  RecommenderSummaryList = Shapes::ListShape.new(name: 'RecommenderSummaryList')
475
484
  RecommenderUpdate = Shapes::StructureShape.new(name: 'RecommenderUpdate')
485
+ RecommenderVersionName = Shapes::StringShape.new(name: 'RecommenderVersionName')
476
486
  ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
477
487
  ResultsSummary = Shapes::StructureShape.new(name: 'ResultsSummary')
478
488
  RoleArn = Shapes::StringShape.new(name: 'RoleArn')
@@ -1266,6 +1276,19 @@ module Aws::CustomerProfiles
1266
1276
 
1267
1277
  DimensionList.member = Shapes::ShapeRef.new(shape: Dimension)
1268
1278
 
1279
+ DiversityColumn.add_member(:name, Shapes::ShapeRef.new(shape: text, required: true, location_name: "Name"))
1280
+ DiversityColumn.add_member(:cap_type, Shapes::ShapeRef.new(shape: DiversityCapType, required: true, location_name: "CapType"))
1281
+ DiversityColumn.add_member(:target, Shapes::ShapeRef.new(shape: DiversityTargetExpression, required: true, location_name: "Target"))
1282
+ DiversityColumn.struct_class = Types::DiversityColumn
1283
+
1284
+ DiversityColumnsList.member = Shapes::ShapeRef.new(shape: DiversityColumn)
1285
+
1286
+ DiversityConfig.add_member(:diversity_columns, Shapes::ShapeRef.new(shape: DiversityColumnsList, location_name: "DiversityColumns"))
1287
+ DiversityConfig.struct_class = Types::DiversityConfig
1288
+
1289
+ DiversityValuesMap.key = Shapes::ShapeRef.new(shape: DiversityPlaceholderName)
1290
+ DiversityValuesMap.value = Shapes::ShapeRef.new(shape: DiversityCapValue)
1291
+
1269
1292
  DomainList.member = Shapes::ShapeRef.new(shape: ListDomainItem)
1270
1293
 
1271
1294
  DomainObjectTypeField.add_member(:source, Shapes::ShapeRef.new(shape: text, required: true, location_name: "Source"))
@@ -1671,6 +1694,7 @@ module Aws::CustomerProfiles
1671
1694
  GetProfileRecommendationsRequest.add_member(:candidate_ids, Shapes::ShapeRef.new(shape: CandidateIdList, location_name: "CandidateIds"))
1672
1695
  GetProfileRecommendationsRequest.add_member(:max_results, Shapes::ShapeRef.new(shape: maxSize500, location_name: "MaxResults"))
1673
1696
  GetProfileRecommendationsRequest.add_member(:metadata_config, Shapes::ShapeRef.new(shape: MetadataConfig, location_name: "MetadataConfig"))
1697
+ GetProfileRecommendationsRequest.add_member(:diversity_config, Shapes::ShapeRef.new(shape: RecommendationDiversityConfig, location_name: "DiversityConfig"))
1674
1698
  GetProfileRecommendationsRequest.struct_class = Types::GetProfileRecommendationsRequest
1675
1699
 
1676
1700
  GetProfileRecommendationsResponse.add_member(:recommendations, Shapes::ShapeRef.new(shape: Recommendations, location_name: "Recommendations"))
@@ -1705,6 +1729,7 @@ module Aws::CustomerProfiles
1705
1729
  GetRecommenderResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreatedAt"))
1706
1730
  GetRecommenderResponse.add_member(:failure_reason, Shapes::ShapeRef.new(shape: String, location_name: "FailureReason"))
1707
1731
  GetRecommenderResponse.add_member(:latest_recommender_update, Shapes::ShapeRef.new(shape: RecommenderUpdate, location_name: "LatestRecommenderUpdate"))
1732
+ GetRecommenderResponse.add_member(:active_recommender_version_name, Shapes::ShapeRef.new(shape: RecommenderVersionName, location_name: "ActiveRecommenderVersionName"))
1708
1733
  GetRecommenderResponse.add_member(:training_metrics, Shapes::ShapeRef.new(shape: TrainingMetricsList, location_name: "TrainingMetrics"))
1709
1734
  GetRecommenderResponse.add_member(:tags, Shapes::ShapeRef.new(shape: TagMap, location_name: "Tags"))
1710
1735
  GetRecommenderResponse.struct_class = Types::GetRecommenderResponse
@@ -2517,6 +2542,10 @@ module Aws::CustomerProfiles
2517
2542
  Recommendation.add_member(:score, Shapes::ShapeRef.new(shape: Double0To1, location_name: "Score"))
2518
2543
  Recommendation.struct_class = Types::Recommendation
2519
2544
 
2545
+ RecommendationDiversityConfig.add_member(:enabled, Shapes::ShapeRef.new(shape: optionalBoolean, required: true, location_name: "Enabled"))
2546
+ RecommendationDiversityConfig.add_member(:values, Shapes::ShapeRef.new(shape: DiversityValuesMap, location_name: "Values"))
2547
+ RecommendationDiversityConfig.struct_class = Types::RecommendationDiversityConfig
2548
+
2520
2549
  Recommendations.member = Shapes::ShapeRef.new(shape: Recommendation)
2521
2550
 
2522
2551
  RecommenderConfig.add_member(:events_config, Shapes::ShapeRef.new(shape: EventsConfig, location_name: "EventsConfig"))
@@ -2524,6 +2553,7 @@ module Aws::CustomerProfiles
2524
2553
  RecommenderConfig.add_member(:inference_config, Shapes::ShapeRef.new(shape: InferenceConfig, location_name: "InferenceConfig"))
2525
2554
  RecommenderConfig.add_member(:included_columns, Shapes::ShapeRef.new(shape: IncludedColumns, location_name: "IncludedColumns"))
2526
2555
  RecommenderConfig.add_member(:excluded_columns, Shapes::ShapeRef.new(shape: IncludedColumns, location_name: "ExcludedColumns"))
2556
+ RecommenderConfig.add_member(:diversity_config, Shapes::ShapeRef.new(shape: DiversityConfig, location_name: "DiversityConfig"))
2527
2557
  RecommenderConfig.struct_class = Types::RecommenderConfig
2528
2558
 
2529
2559
  RecommenderContext.key = Shapes::ShapeRef.new(shape: ContextKey)
@@ -2602,6 +2632,7 @@ module Aws::CustomerProfiles
2602
2632
  RecommenderUpdate.add_member(:created_at, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreatedAt"))
2603
2633
  RecommenderUpdate.add_member(:last_updated_at, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastUpdatedAt"))
2604
2634
  RecommenderUpdate.add_member(:failure_reason, Shapes::ShapeRef.new(shape: String, location_name: "FailureReason"))
2635
+ RecommenderUpdate.add_member(:recommender_version_name, Shapes::ShapeRef.new(shape: RecommenderVersionName, location_name: "RecommenderVersionName"))
2605
2636
  RecommenderUpdate.struct_class = Types::RecommenderUpdate
2606
2637
 
2607
2638
  ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: message, location_name: "Message"))
@@ -2783,6 +2814,7 @@ module Aws::CustomerProfiles
2783
2814
 
2784
2815
  TrainingMetrics.add_member(:time, Shapes::ShapeRef.new(shape: timestamp, location_name: "Time"))
2785
2816
  TrainingMetrics.add_member(:metrics, Shapes::ShapeRef.new(shape: Metrics, location_name: "Metrics"))
2817
+ TrainingMetrics.add_member(:recommender_version_name, Shapes::ShapeRef.new(shape: RecommenderVersionName, location_name: "RecommenderVersionName"))
2786
2818
  TrainingMetrics.struct_class = Types::TrainingMetrics
2787
2819
 
2788
2820
  TrainingMetricsList.member = Shapes::ShapeRef.new(shape: TrainingMetrics)
@@ -2935,6 +2967,7 @@ module Aws::CustomerProfiles
2935
2967
  UpdateRecommenderRequest.add_member(:recommender_name, Shapes::ShapeRef.new(shape: name, required: true, location: "uri", location_name: "RecommenderName"))
2936
2968
  UpdateRecommenderRequest.add_member(:description, Shapes::ShapeRef.new(shape: sensitiveText, location_name: "Description"))
2937
2969
  UpdateRecommenderRequest.add_member(:recommender_config, Shapes::ShapeRef.new(shape: RecommenderConfig, location_name: "RecommenderConfig"))
2970
+ UpdateRecommenderRequest.add_member(:recommender_version_name, Shapes::ShapeRef.new(shape: RecommenderVersionName, location_name: "RecommenderVersionName"))
2938
2971
  UpdateRecommenderRequest.struct_class = Types::UpdateRecommenderRequest
2939
2972
 
2940
2973
  UpdateRecommenderResponse.add_member(:recommender_name, Shapes::ShapeRef.new(shape: name, required: true, location_name: "RecommenderName"))
@@ -2900,6 +2900,54 @@ module Aws::CustomerProfiles
2900
2900
  class Unknown < Dimension; end
2901
2901
  end
2902
2902
 
2903
+ # Defines a diversity constraint for a single item column, specifying a
2904
+ # cap type and a target value or placeholder that controls how many
2905
+ # recommended items may share the same column value.
2906
+ #
2907
+ # @!attribute [rw] name
2908
+ # The name of the item catalog column on which to apply the diversity
2909
+ # cap. The column must be defined in the recommender schema.
2910
+ # @return [String]
2911
+ #
2912
+ # @!attribute [rw] cap_type
2913
+ # The type of diversity cap to apply. Valid values are `PERCENTAGE`
2914
+ # (interpret `Target` as a percentage of returned items) and `VALUE`
2915
+ # (interpret `Target` as an absolute count).
2916
+ # @return [String]
2917
+ #
2918
+ # @!attribute [rw] target
2919
+ # The diversity cap target. Either an integer literal (for example,
2920
+ # `"25"`) or a placeholder expression of the form `$name` whose value
2921
+ # is supplied at inference time through `GetProfileRecommendations`.
2922
+ # @return [String]
2923
+ #
2924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DiversityColumn AWS API Documentation
2925
+ #
2926
+ class DiversityColumn < Struct.new(
2927
+ :name,
2928
+ :cap_type,
2929
+ :target)
2930
+ SENSITIVE = []
2931
+ include Aws::Structure
2932
+ end
2933
+
2934
+ # Configuration that controls diversity of recommendation results by
2935
+ # capping the representation of specified item columns.
2936
+ #
2937
+ # @!attribute [rw] diversity_columns
2938
+ # A list of up to two diversity columns. Each column defines a cap on
2939
+ # the number or percentage of recommended items that share the same
2940
+ # value for that column.
2941
+ # @return [Array<Types::DiversityColumn>]
2942
+ #
2943
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/DiversityConfig AWS API Documentation
2944
+ #
2945
+ class DiversityConfig < Struct.new(
2946
+ :diversity_columns)
2947
+ SENSITIVE = []
2948
+ include Aws::Structure
2949
+ end
2950
+
2903
2951
  # The standard domain object type.
2904
2952
  #
2905
2953
  # @!attribute [rw] source
@@ -4811,6 +4859,12 @@ module Aws::CustomerProfiles
4811
4859
  # alongside recommended items.
4812
4860
  # @return [Types::MetadataConfig]
4813
4861
  #
4862
+ # @!attribute [rw] diversity_config
4863
+ # Runtime diversity configuration for this request. Enables
4864
+ # diversity-aware recommendations and optionally supplies values for
4865
+ # placeholder-based diversity caps configured on the recommender.
4866
+ # @return [Types::RecommendationDiversityConfig]
4867
+ #
4814
4868
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/GetProfileRecommendationsRequest AWS API Documentation
4815
4869
  #
4816
4870
  class GetProfileRecommendationsRequest < Struct.new(
@@ -4822,7 +4876,8 @@ module Aws::CustomerProfiles
4822
4876
  :recommender_promotional_filters,
4823
4877
  :candidate_ids,
4824
4878
  :max_results,
4825
- :metadata_config)
4879
+ :metadata_config,
4880
+ :diversity_config)
4826
4881
  SENSITIVE = [:context]
4827
4882
  include Aws::Structure
4828
4883
  end
@@ -4974,6 +5029,11 @@ module Aws::CustomerProfiles
4974
5029
  # recommender, including status and timestamp.
4975
5030
  # @return [Types::RecommenderUpdate]
4976
5031
  #
5032
+ # @!attribute [rw] active_recommender_version_name
5033
+ # The name of the recommender version currently serving
5034
+ # recommendations. Omitted when no active recommender version is set.
5035
+ # @return [String]
5036
+ #
4977
5037
  # @!attribute [rw] training_metrics
4978
5038
  # A set of metrics that provide information about the recommender's
4979
5039
  # training performance and accuracy.
@@ -4997,6 +5057,7 @@ module Aws::CustomerProfiles
4997
5057
  :created_at,
4998
5058
  :failure_reason,
4999
5059
  :latest_recommender_update,
5060
+ :active_recommender_version_name,
5000
5061
  :training_metrics,
5001
5062
  :tags)
5002
5063
  SENSITIVE = [:description]
@@ -8792,6 +8853,29 @@ module Aws::CustomerProfiles
8792
8853
  include Aws::Structure
8793
8854
  end
8794
8855
 
8856
+ # Runtime diversity configuration for a `GetProfileRecommendations`
8857
+ # request.
8858
+ #
8859
+ # @!attribute [rw] enabled
8860
+ # Whether diversity-aware recommendations are enabled for this
8861
+ # request.
8862
+ # @return [Boolean]
8863
+ #
8864
+ # @!attribute [rw] values
8865
+ # An optional map of placeholder name to integer cap value used to
8866
+ # resolve `$name` placeholders defined in the recommender's
8867
+ # `DiversityConfig` at inference time. Up to 2 entries are supported.
8868
+ # @return [Hash<String,Integer>]
8869
+ #
8870
+ # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RecommendationDiversityConfig AWS API Documentation
8871
+ #
8872
+ class RecommendationDiversityConfig < Struct.new(
8873
+ :enabled,
8874
+ :values)
8875
+ SENSITIVE = []
8876
+ include Aws::Structure
8877
+ end
8878
+
8795
8879
  # Configuration settings that define the behavior and parameters of a
8796
8880
  # recommender.
8797
8881
  #
@@ -8833,6 +8917,12 @@ module Aws::CustomerProfiles
8833
8917
  # IncludedColumns — both cannot be specified in the same request.
8834
8918
  # @return [Hash<String,Array<String>>]
8835
8919
  #
8920
+ # @!attribute [rw] diversity_config
8921
+ # Configuration for diversity-aware recommendations. When set, the
8922
+ # recommender applies diversity constraints defined per item column to
8923
+ # reduce over-concentration of similar items in the results.
8924
+ # @return [Types::DiversityConfig]
8925
+ #
8836
8926
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RecommenderConfig AWS API Documentation
8837
8927
  #
8838
8928
  class RecommenderConfig < Struct.new(
@@ -8840,7 +8930,8 @@ module Aws::CustomerProfiles
8840
8930
  :training_frequency,
8841
8931
  :inference_config,
8842
8932
  :included_columns,
8843
- :excluded_columns)
8933
+ :excluded_columns,
8934
+ :diversity_config)
8844
8935
  SENSITIVE = []
8845
8936
  include Aws::Structure
8846
8937
  end
@@ -9129,6 +9220,11 @@ module Aws::CustomerProfiles
9129
9220
  # If the update operation failed, provides the reason for the failure.
9130
9221
  # @return [String]
9131
9222
  #
9223
+ # @!attribute [rw] recommender_version_name
9224
+ # The name of the recommender version associated with this update
9225
+ # operation.
9226
+ # @return [String]
9227
+ #
9132
9228
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/RecommenderUpdate AWS API Documentation
9133
9229
  #
9134
9230
  class RecommenderUpdate < Struct.new(
@@ -9136,7 +9232,8 @@ module Aws::CustomerProfiles
9136
9232
  :status,
9137
9233
  :created_at,
9138
9234
  :last_updated_at,
9139
- :failure_reason)
9235
+ :failure_reason,
9236
+ :recommender_version_name)
9140
9237
  SENSITIVE = []
9141
9238
  include Aws::Structure
9142
9239
  end
@@ -9991,11 +10088,17 @@ module Aws::CustomerProfiles
9991
10088
  # process.
9992
10089
  # @return [Hash<String,Float>]
9993
10090
  #
10091
+ # @!attribute [rw] recommender_version_name
10092
+ # The name of the recommender version that produced these training
10093
+ # metrics.
10094
+ # @return [String]
10095
+ #
9994
10096
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/TrainingMetrics AWS API Documentation
9995
10097
  #
9996
10098
  class TrainingMetrics < Struct.new(
9997
10099
  :time,
9998
- :metrics)
10100
+ :metrics,
10101
+ :recommender_version_name)
9999
10102
  SENSITIVE = []
10000
10103
  include Aws::Structure
10001
10104
  end
@@ -10773,13 +10876,20 @@ module Aws::CustomerProfiles
10773
10876
  # including updated parameters and settings that define its behavior.
10774
10877
  # @return [Types::RecommenderConfig]
10775
10878
  #
10879
+ # @!attribute [rw] recommender_version_name
10880
+ # The name of a specific recommender version to activate as part of
10881
+ # this update (for example, to roll back to a previously trained
10882
+ # version).
10883
+ # @return [String]
10884
+ #
10776
10885
  # @see http://docs.aws.amazon.com/goto/WebAPI/customer-profiles-2020-08-15/UpdateRecommenderRequest AWS API Documentation
10777
10886
  #
10778
10887
  class UpdateRecommenderRequest < Struct.new(
10779
10888
  :domain_name,
10780
10889
  :recommender_name,
10781
10890
  :description,
10782
- :recommender_config)
10891
+ :recommender_config,
10892
+ :recommender_version_name)
10783
10893
  SENSITIVE = [:description]
10784
10894
  include Aws::Structure
10785
10895
  end
@@ -54,7 +54,7 @@ module Aws::CustomerProfiles
54
54
  autoload :EndpointProvider, 'aws-sdk-customerprofiles/endpoint_provider'
55
55
  autoload :Endpoints, 'aws-sdk-customerprofiles/endpoints'
56
56
 
57
- GEM_VERSION = '1.90.0'
57
+ GEM_VERSION = '1.91.0'
58
58
 
59
59
  end
60
60
 
data/sig/client.rbs CHANGED
@@ -995,6 +995,10 @@ module Aws
995
995
  ?max_results: ::Integer,
996
996
  ?metadata_config: {
997
997
  metadata_columns: Array[::String]?
998
+ },
999
+ ?diversity_config: {
1000
+ enabled: bool,
1001
+ values: Hash[::String, ::Integer]?
998
1002
  }
999
1003
  ) -> _GetProfileRecommendationsResponseSuccess
1000
1004
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetProfileRecommendationsResponseSuccess
@@ -1011,6 +1015,7 @@ module Aws
1011
1015
  def created_at: () -> ::Time
1012
1016
  def failure_reason: () -> ::String
1013
1017
  def latest_recommender_update: () -> Types::RecommenderUpdate
1018
+ def active_recommender_version_name: () -> ::String
1014
1019
  def training_metrics: () -> ::Array[Types::TrainingMetrics]
1015
1020
  def tags: () -> ::Hash[::String, ::String]
1016
1021
  end
@@ -1943,7 +1948,8 @@ module Aws
1943
1948
  domain_name: ::String,
1944
1949
  recommender_name: ::String,
1945
1950
  ?description: ::String,
1946
- ?recommender_config: Params::recommender_config
1951
+ ?recommender_config: Params::recommender_config,
1952
+ ?recommender_version_name: ::String
1947
1953
  ) -> _UpdateRecommenderResponseSuccess
1948
1954
  | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateRecommenderResponseSuccess
1949
1955
  end
data/sig/params.rbs CHANGED
@@ -235,7 +235,16 @@ module Aws
235
235
  min_provisioned_tps: ::Integer?
236
236
  }?,
237
237
  included_columns: Hash[::String, Array[::String]]?,
238
- excluded_columns: Hash[::String, Array[::String]]?
238
+ excluded_columns: Hash[::String, Array[::String]]?,
239
+ diversity_config: {
240
+ diversity_columns: Array[
241
+ {
242
+ name: ::String,
243
+ cap_type: ("PERCENTAGE" | "VALUE"),
244
+ target: ::String
245
+ }
246
+ ]?
247
+ }?
239
248
  }
240
249
 
241
250
  type group = {
data/sig/types.rbs CHANGED
@@ -797,6 +797,18 @@ module Aws::CustomerProfiles
797
797
  end
798
798
  end
799
799
 
800
+ class DiversityColumn
801
+ attr_accessor name: ::String
802
+ attr_accessor cap_type: ("PERCENTAGE" | "VALUE")
803
+ attr_accessor target: ::String
804
+ SENSITIVE: []
805
+ end
806
+
807
+ class DiversityConfig
808
+ attr_accessor diversity_columns: ::Array[Types::DiversityColumn]
809
+ SENSITIVE: []
810
+ end
811
+
800
812
  class DomainObjectTypeField
801
813
  attr_accessor source: ::String
802
814
  attr_accessor target: ::String
@@ -1275,6 +1287,7 @@ module Aws::CustomerProfiles
1275
1287
  attr_accessor candidate_ids: ::Array[::String]
1276
1288
  attr_accessor max_results: ::Integer
1277
1289
  attr_accessor metadata_config: Types::MetadataConfig
1290
+ attr_accessor diversity_config: Types::RecommendationDiversityConfig
1278
1291
  SENSITIVE: [:context]
1279
1292
  end
1280
1293
 
@@ -1319,6 +1332,7 @@ module Aws::CustomerProfiles
1319
1332
  attr_accessor created_at: ::Time
1320
1333
  attr_accessor failure_reason: ::String
1321
1334
  attr_accessor latest_recommender_update: Types::RecommenderUpdate
1335
+ attr_accessor active_recommender_version_name: ::String
1322
1336
  attr_accessor training_metrics: ::Array[Types::TrainingMetrics]
1323
1337
  attr_accessor tags: ::Hash[::String, ::String]
1324
1338
  SENSITIVE: [:description]
@@ -2308,12 +2322,19 @@ module Aws::CustomerProfiles
2308
2322
  SENSITIVE: []
2309
2323
  end
2310
2324
 
2325
+ class RecommendationDiversityConfig
2326
+ attr_accessor enabled: bool
2327
+ attr_accessor values: ::Hash[::String, ::Integer]
2328
+ SENSITIVE: []
2329
+ end
2330
+
2311
2331
  class RecommenderConfig
2312
2332
  attr_accessor events_config: Types::EventsConfig
2313
2333
  attr_accessor training_frequency: ::Integer
2314
2334
  attr_accessor inference_config: Types::InferenceConfig
2315
2335
  attr_accessor included_columns: ::Hash[::String, ::Array[::String]]
2316
2336
  attr_accessor excluded_columns: ::Hash[::String, ::Array[::String]]
2337
+ attr_accessor diversity_config: Types::DiversityConfig
2317
2338
  SENSITIVE: []
2318
2339
  end
2319
2340
 
@@ -2385,6 +2406,7 @@ module Aws::CustomerProfiles
2385
2406
  attr_accessor created_at: ::Time
2386
2407
  attr_accessor last_updated_at: ::Time
2387
2408
  attr_accessor failure_reason: ::String
2409
+ attr_accessor recommender_version_name: ::String
2388
2410
  SENSITIVE: []
2389
2411
  end
2390
2412
 
@@ -2607,6 +2629,7 @@ module Aws::CustomerProfiles
2607
2629
  class TrainingMetrics
2608
2630
  attr_accessor time: ::Time
2609
2631
  attr_accessor metrics: ::Hash[("hit" | "coverage" | "recall" | "popularity" | "freshness" | "similarity" | "mean_reciprocal_rank_at_25" | "normalized_discounted_cumulative_gain_at_5" | "normalized_discounted_cumulative_gain_at_10" | "normalized_discounted_cumulative_gain_at_25" | "precision_at_5" | "precision_at_10" | "precision_at_25"), ::Float]
2632
+ attr_accessor recommender_version_name: ::String
2610
2633
  SENSITIVE: []
2611
2634
  end
2612
2635
 
@@ -2785,6 +2808,7 @@ module Aws::CustomerProfiles
2785
2808
  attr_accessor recommender_name: ::String
2786
2809
  attr_accessor description: ::String
2787
2810
  attr_accessor recommender_config: Types::RecommenderConfig
2811
+ attr_accessor recommender_version_name: ::String
2788
2812
  SENSITIVE: [:description]
2789
2813
  end
2790
2814
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-customerprofiles
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.90.0
4
+ version: 1.91.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services