aws-sdk-bedrock 1.46.0 → 1.53.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.
@@ -23,6 +23,25 @@ module Aws::Bedrock
23
23
  include Aws::Structure
24
24
  end
25
25
 
26
+ # Information about the agreement availability
27
+ #
28
+ # @!attribute [rw] status
29
+ # Status of the agreement.
30
+ # @return [String]
31
+ #
32
+ # @!attribute [rw] error_message
33
+ # Error message.
34
+ # @return [String]
35
+ #
36
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/AgreementAvailability AWS API Documentation
37
+ #
38
+ class AgreementAvailability < Struct.new(
39
+ :status,
40
+ :error_message)
41
+ SENSITIVE = []
42
+ include Aws::Structure
43
+ end
44
+
26
45
  # The configuration details of an automated evaluation job. The
27
46
  # `EvaluationDatasetMetricConfig` object is used to specify the prompt
28
47
  # datasets, task type, and metric names.
@@ -264,6 +283,97 @@ module Aws::Bedrock
264
283
  include Aws::Structure
265
284
  end
266
285
 
286
+ # @!attribute [rw] model_name
287
+ # A unique name for the custom model.
288
+ # @return [String]
289
+ #
290
+ # @!attribute [rw] model_source_config
291
+ # The data source for the model. The Amazon S3 URI in the model source
292
+ # must be for the Amazon-managed Amazon S3 bucket containing your
293
+ # model artifacts.
294
+ # @return [Types::ModelDataSource]
295
+ #
296
+ # @!attribute [rw] model_kms_key_arn
297
+ # The Amazon Resource Name (ARN) of the customer managed KMS key to
298
+ # encrypt the custom model. If you don't provide a KMS key, Amazon
299
+ # Bedrock uses an Amazon Web Services-managed KMS key to encrypt the
300
+ # model.
301
+ #
302
+ # If you provide a customer managed KMS key, your Amazon Bedrock
303
+ # service role must have permissions to use it. For more information
304
+ # see [Encryption of imported models][1].
305
+ #
306
+ #
307
+ #
308
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/encryption-import-model.html
309
+ # @return [String]
310
+ #
311
+ # @!attribute [rw] role_arn
312
+ # The Amazon Resource Name (ARN) of an IAM service role that Amazon
313
+ # Bedrock assumes to perform tasks on your behalf. This role must have
314
+ # permissions to access the Amazon S3 bucket containing your model
315
+ # artifacts and the KMS key (if specified). For more information, see
316
+ # [Setting up an IAM service role for importing models][1] in the
317
+ # Amazon Bedrock User Guide.
318
+ #
319
+ #
320
+ #
321
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-import-iam-role.html
322
+ # @return [String]
323
+ #
324
+ # @!attribute [rw] model_tags
325
+ # A list of key-value pairs to associate with the custom model
326
+ # resource. You can use these tags to organize and identify your
327
+ # resources.
328
+ #
329
+ # For more information, see [Tagging resources][1] in the [Amazon
330
+ # Bedrock User Guide][2].
331
+ #
332
+ #
333
+ #
334
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
335
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
336
+ # @return [Array<Types::Tag>]
337
+ #
338
+ # @!attribute [rw] client_request_token
339
+ # A unique, case-sensitive identifier to ensure that the API request
340
+ # completes no more than one time. If this token matches a previous
341
+ # request, Amazon Bedrock ignores the request, but does not return an
342
+ # error. For more information, see [Ensuring idempotency][1].
343
+ #
344
+ # **A suitable default value is auto-generated.** You should normally
345
+ # not need to pass this option.
346
+ #
347
+ #
348
+ #
349
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
350
+ # @return [String]
351
+ #
352
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelRequest AWS API Documentation
353
+ #
354
+ class CreateCustomModelRequest < Struct.new(
355
+ :model_name,
356
+ :model_source_config,
357
+ :model_kms_key_arn,
358
+ :role_arn,
359
+ :model_tags,
360
+ :client_request_token)
361
+ SENSITIVE = []
362
+ include Aws::Structure
363
+ end
364
+
365
+ # @!attribute [rw] model_arn
366
+ # The Amazon Resource Name (ARN) of the new custom model.
367
+ # @return [String]
368
+ #
369
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelResponse AWS API Documentation
370
+ #
371
+ class CreateCustomModelResponse < Struct.new(
372
+ :model_arn)
373
+ SENSITIVE = []
374
+ include Aws::Structure
375
+ end
376
+
267
377
  # @!attribute [rw] job_name
268
378
  # A name for the evaluation job. Names must unique with your Amazon
269
379
  # Web Services account, and your account's Amazon Web Services
@@ -365,6 +475,35 @@ module Aws::Bedrock
365
475
  include Aws::Structure
366
476
  end
367
477
 
478
+ # @!attribute [rw] offer_token
479
+ # An offer token encapsulates the information for an offer.
480
+ # @return [String]
481
+ #
482
+ # @!attribute [rw] model_id
483
+ # Model Id of the model for the access request.
484
+ # @return [String]
485
+ #
486
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreementRequest AWS API Documentation
487
+ #
488
+ class CreateFoundationModelAgreementRequest < Struct.new(
489
+ :offer_token,
490
+ :model_id)
491
+ SENSITIVE = []
492
+ include Aws::Structure
493
+ end
494
+
495
+ # @!attribute [rw] model_id
496
+ # Model Id of the model for the access request.
497
+ # @return [String]
498
+ #
499
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreementResponse AWS API Documentation
500
+ #
501
+ class CreateFoundationModelAgreementResponse < Struct.new(
502
+ :model_id)
503
+ SENSITIVE = []
504
+ include Aws::Structure
505
+ end
506
+
368
507
  # @!attribute [rw] name
369
508
  # The name to give the guardrail.
370
509
  # @return [String]
@@ -1301,6 +1440,17 @@ module Aws::Bedrock
1301
1440
  # The unique identifier of the account that owns the model.
1302
1441
  # @return [String]
1303
1442
  #
1443
+ # @!attribute [rw] model_status
1444
+ # The current status of the custom model. Possible values include:
1445
+ #
1446
+ # * `Creating` - The model is being created and validated.
1447
+ #
1448
+ # * `Active` - The model has been successfully created and is ready
1449
+ # for use.
1450
+ #
1451
+ # * `Failed` - The model creation process failed.
1452
+ # @return [String]
1453
+ #
1304
1454
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomModelSummary AWS API Documentation
1305
1455
  #
1306
1456
  class CustomModelSummary < Struct.new(
@@ -1310,7 +1460,8 @@ module Aws::Bedrock
1310
1460
  :base_model_arn,
1311
1461
  :base_model_name,
1312
1462
  :customization_type,
1313
- :owner_account_id)
1463
+ :owner_account_id,
1464
+ :model_status)
1314
1465
  SENSITIVE = []
1315
1466
  include Aws::Structure
1316
1467
  end
@@ -1408,6 +1559,22 @@ module Aws::Bedrock
1408
1559
  #
1409
1560
  class DeleteCustomModelResponse < Aws::EmptyStructure; end
1410
1561
 
1562
+ # @!attribute [rw] model_id
1563
+ # Model Id of the model access to delete.
1564
+ # @return [String]
1565
+ #
1566
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreementRequest AWS API Documentation
1567
+ #
1568
+ class DeleteFoundationModelAgreementRequest < Struct.new(
1569
+ :model_id)
1570
+ SENSITIVE = []
1571
+ include Aws::Structure
1572
+ end
1573
+
1574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreementResponse AWS API Documentation
1575
+ #
1576
+ class DeleteFoundationModelAgreementResponse < Aws::EmptyStructure; end
1577
+
1411
1578
  # @!attribute [rw] guardrail_identifier
1412
1579
  # The unique identifier of the guardrail. This can be an ID or the
1413
1580
  # ARN.
@@ -1539,6 +1706,35 @@ module Aws::Bedrock
1539
1706
  #
1540
1707
  class DeregisterMarketplaceModelEndpointResponse < Aws::EmptyStructure; end
1541
1708
 
1709
+ # Dimensional price rate.
1710
+ #
1711
+ # @!attribute [rw] dimension
1712
+ # Dimension for the price rate.
1713
+ # @return [String]
1714
+ #
1715
+ # @!attribute [rw] price
1716
+ # Single-dimensional rate information.
1717
+ # @return [String]
1718
+ #
1719
+ # @!attribute [rw] description
1720
+ # Description of the price rate.
1721
+ # @return [String]
1722
+ #
1723
+ # @!attribute [rw] unit
1724
+ # Unit associated with the price.
1725
+ # @return [String]
1726
+ #
1727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DimensionalPriceRate AWS API Documentation
1728
+ #
1729
+ class DimensionalPriceRate < Struct.new(
1730
+ :dimension,
1731
+ :price,
1732
+ :description,
1733
+ :unit)
1734
+ SENSITIVE = []
1735
+ include Aws::Structure
1736
+ end
1737
+
1542
1738
  # Settings for distilling a foundation model into a smaller and more
1543
1739
  # efficient model.
1544
1740
  #
@@ -2191,6 +2387,24 @@ module Aws::Bedrock
2191
2387
  include Aws::Structure
2192
2388
  end
2193
2389
 
2390
+ # Specifies a field to be used during the reranking process in a
2391
+ # Knowledge Base vector search. This structure identifies metadata
2392
+ # fields that should be considered when reordering search results to
2393
+ # improve relevance.
2394
+ #
2395
+ # @!attribute [rw] field_name
2396
+ # The name of the metadata field to be used during the reranking
2397
+ # process.
2398
+ # @return [String]
2399
+ #
2400
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FieldForReranking AWS API Documentation
2401
+ #
2402
+ class FieldForReranking < Struct.new(
2403
+ :field_name)
2404
+ SENSITIVE = []
2405
+ include Aws::Structure
2406
+ end
2407
+
2194
2408
  # Specifies the name of the metadata attribute/field to apply filters.
2195
2409
  # You must match the name of the attribute/field in your data
2196
2410
  # source/document metadata.
@@ -2408,7 +2622,13 @@ module Aws::Bedrock
2408
2622
  # @return [String]
2409
2623
  #
2410
2624
  # @!attribute [rw] job_arn
2411
- # Job Amazon Resource Name (ARN) associated with this model.
2625
+ # Job Amazon Resource Name (ARN) associated with this model. For
2626
+ # models that you create with the [CreateCustomModel][1] API
2627
+ # operation, this is `NULL`.
2628
+ #
2629
+ #
2630
+ #
2631
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html
2412
2632
  # @return [String]
2413
2633
  #
2414
2634
  # @!attribute [rw] base_model_arn
@@ -2460,6 +2680,24 @@ module Aws::Bedrock
2460
2680
  # The customization configuration for the custom model.
2461
2681
  # @return [Types::CustomizationConfig]
2462
2682
  #
2683
+ # @!attribute [rw] model_status
2684
+ # The current status of the custom model. Possible values include:
2685
+ #
2686
+ # * `Creating` - The model is being created and validated.
2687
+ #
2688
+ # * `Active` - The model has been successfully created and is ready
2689
+ # for use.
2690
+ #
2691
+ # * `Failed` - The model creation process failed. Check the
2692
+ # `failureMessage` field for details.
2693
+ # @return [String]
2694
+ #
2695
+ # @!attribute [rw] failure_message
2696
+ # A failure message for any issues that occurred when creating the
2697
+ # custom model. This is included for only a failed CreateCustomModel
2698
+ # operation.
2699
+ # @return [String]
2700
+ #
2463
2701
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelResponse AWS API Documentation
2464
2702
  #
2465
2703
  class GetCustomModelResponse < Struct.new(
@@ -2477,7 +2715,9 @@ module Aws::Bedrock
2477
2715
  :training_metrics,
2478
2716
  :validation_metrics,
2479
2717
  :creation_time,
2480
- :customization_config)
2718
+ :customization_config,
2719
+ :model_status,
2720
+ :failure_message)
2481
2721
  SENSITIVE = []
2482
2722
  include Aws::Structure
2483
2723
  end
@@ -2579,6 +2819,50 @@ module Aws::Bedrock
2579
2819
  include Aws::Structure
2580
2820
  end
2581
2821
 
2822
+ # @!attribute [rw] model_id
2823
+ # The model Id of the foundation model.
2824
+ # @return [String]
2825
+ #
2826
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailabilityRequest AWS API Documentation
2827
+ #
2828
+ class GetFoundationModelAvailabilityRequest < Struct.new(
2829
+ :model_id)
2830
+ SENSITIVE = []
2831
+ include Aws::Structure
2832
+ end
2833
+
2834
+ # @!attribute [rw] model_id
2835
+ # The model Id of the foundation model.
2836
+ # @return [String]
2837
+ #
2838
+ # @!attribute [rw] agreement_availability
2839
+ # Agreement availability.
2840
+ # @return [Types::AgreementAvailability]
2841
+ #
2842
+ # @!attribute [rw] authorization_status
2843
+ # Authorization status.
2844
+ # @return [String]
2845
+ #
2846
+ # @!attribute [rw] entitlement_availability
2847
+ # Entitlement availability.
2848
+ # @return [String]
2849
+ #
2850
+ # @!attribute [rw] region_availability
2851
+ # Region availability.
2852
+ # @return [String]
2853
+ #
2854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailabilityResponse AWS API Documentation
2855
+ #
2856
+ class GetFoundationModelAvailabilityResponse < Struct.new(
2857
+ :model_id,
2858
+ :agreement_availability,
2859
+ :authorization_status,
2860
+ :entitlement_availability,
2861
+ :region_availability)
2862
+ SENSITIVE = []
2863
+ include Aws::Structure
2864
+ end
2865
+
2582
2866
  # @!attribute [rw] model_identifier
2583
2867
  # The model identifier.
2584
2868
  # @return [String]
@@ -3020,15 +3304,15 @@ module Aws::Bedrock
3020
3304
  # failed.
3021
3305
  # @return [String]
3022
3306
  #
3023
- # @!attribute [rw] failure_message
3024
- # Information about why the job failed.
3025
- # @return [String]
3026
- #
3027
3307
  # @!attribute [rw] status_details
3028
3308
  # For a Distillation job, the details about the statuses of the
3029
3309
  # sub-tasks of the customization job.
3030
3310
  # @return [Types::StatusDetails]
3031
3311
  #
3312
+ # @!attribute [rw] failure_message
3313
+ # Information about why the job failed.
3314
+ # @return [String]
3315
+ #
3032
3316
  # @!attribute [rw] creation_time
3033
3317
  # Time that the resource was created.
3034
3318
  # @return [Time]
@@ -3101,8 +3385,8 @@ module Aws::Bedrock
3101
3385
  :client_request_token,
3102
3386
  :role_arn,
3103
3387
  :status,
3104
- :failure_message,
3105
3388
  :status_details,
3389
+ :failure_message,
3106
3390
  :creation_time,
3107
3391
  :last_modified_time,
3108
3392
  :end_time,
@@ -3558,6 +3842,24 @@ module Aws::Bedrock
3558
3842
  include Aws::Structure
3559
3843
  end
3560
3844
 
3845
+ # @api private
3846
+ #
3847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccessRequest AWS API Documentation
3848
+ #
3849
+ class GetUseCaseForModelAccessRequest < Aws::EmptyStructure; end
3850
+
3851
+ # @!attribute [rw] form_data
3852
+ # Get customer profile Response.
3853
+ # @return [String]
3854
+ #
3855
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccessResponse AWS API Documentation
3856
+ #
3857
+ class GetUseCaseForModelAccessResponse < Struct.new(
3858
+ :form_data)
3859
+ SENSITIVE = []
3860
+ include Aws::Structure
3861
+ end
3862
+
3561
3863
  # The configuration details for the guardrail.
3562
3864
  #
3563
3865
  # @!attribute [rw] guardrail_id
@@ -3812,6 +4114,60 @@ module Aws::Bedrock
3812
4114
  include Aws::Structure
3813
4115
  end
3814
4116
 
4117
+ # The tier that your guardrail uses for content filters.
4118
+ #
4119
+ # @!attribute [rw] tier_name
4120
+ # The tier that your guardrail uses for content filters. Valid values
4121
+ # include:
4122
+ #
4123
+ # * `CLASSIC` tier – Provides established guardrails functionality
4124
+ # supporting English, French, and Spanish languages.
4125
+ #
4126
+ # * `STANDARD` tier – Provides a more robust solution than the
4127
+ # `CLASSIC` tier and has more comprehensive language support. This
4128
+ # tier requires that your guardrail use [cross-Region inference][1].
4129
+ #
4130
+ #
4131
+ #
4132
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
4133
+ # @return [String]
4134
+ #
4135
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFiltersTier AWS API Documentation
4136
+ #
4137
+ class GuardrailContentFiltersTier < Struct.new(
4138
+ :tier_name)
4139
+ SENSITIVE = [:tier_name]
4140
+ include Aws::Structure
4141
+ end
4142
+
4143
+ # The tier that your guardrail uses for content filters. Consider using
4144
+ # a tier that balances performance, accuracy, and compatibility with
4145
+ # your existing generative AI workflows.
4146
+ #
4147
+ # @!attribute [rw] tier_name
4148
+ # The tier that your guardrail uses for content filters. Valid values
4149
+ # include:
4150
+ #
4151
+ # * `CLASSIC` tier – Provides established guardrails functionality
4152
+ # supporting English, French, and Spanish languages.
4153
+ #
4154
+ # * `STANDARD` tier – Provides a more robust solution than the
4155
+ # `CLASSIC` tier and has more comprehensive language support. This
4156
+ # tier requires that your guardrail use [cross-Region inference][1].
4157
+ #
4158
+ #
4159
+ #
4160
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
4161
+ # @return [String]
4162
+ #
4163
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFiltersTierConfig AWS API Documentation
4164
+ #
4165
+ class GuardrailContentFiltersTierConfig < Struct.new(
4166
+ :tier_name)
4167
+ SENSITIVE = [:tier_name]
4168
+ include Aws::Structure
4169
+ end
4170
+
3815
4171
  # Contains details about how to handle harmful content.
3816
4172
  #
3817
4173
  # This data type is used in the following API operations:
@@ -3829,10 +4185,15 @@ module Aws::Bedrock
3829
4185
  # apply to prompts and model responses.
3830
4186
  # @return [Array<Types::GuardrailContentFilter>]
3831
4187
  #
4188
+ # @!attribute [rw] tier
4189
+ # The tier that your guardrail uses for content filters.
4190
+ # @return [Types::GuardrailContentFiltersTier]
4191
+ #
3832
4192
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicy AWS API Documentation
3833
4193
  #
3834
4194
  class GuardrailContentPolicy < Struct.new(
3835
- :filters)
4195
+ :filters,
4196
+ :tier)
3836
4197
  SENSITIVE = []
3837
4198
  include Aws::Structure
3838
4199
  end
@@ -3844,10 +4205,15 @@ module Aws::Bedrock
3844
4205
  # apply to prompts and model responses.
3845
4206
  # @return [Array<Types::GuardrailContentFilterConfig>]
3846
4207
  #
4208
+ # @!attribute [rw] tier_config
4209
+ # The tier that your guardrail uses for content filters.
4210
+ # @return [Types::GuardrailContentFiltersTierConfig]
4211
+ #
3847
4212
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicyConfig AWS API Documentation
3848
4213
  #
3849
4214
  class GuardrailContentPolicyConfig < Struct.new(
3850
- :filters_config)
4215
+ :filters_config,
4216
+ :tier_config)
3851
4217
  SENSITIVE = []
3852
4218
  include Aws::Structure
3853
4219
  end
@@ -4865,10 +5231,15 @@ module Aws::Bedrock
4865
5231
  # A list of policies related to topics that the guardrail should deny.
4866
5232
  # @return [Array<Types::GuardrailTopic>]
4867
5233
  #
5234
+ # @!attribute [rw] tier
5235
+ # The tier that your guardrail uses for denied topic filters.
5236
+ # @return [Types::GuardrailTopicsTier]
5237
+ #
4868
5238
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicy AWS API Documentation
4869
5239
  #
4870
5240
  class GuardrailTopicPolicy < Struct.new(
4871
- :topics)
5241
+ :topics,
5242
+ :tier)
4872
5243
  SENSITIVE = []
4873
5244
  include Aws::Structure
4874
5245
  end
@@ -4880,14 +5251,73 @@ module Aws::Bedrock
4880
5251
  # A list of policies related to topics that the guardrail should deny.
4881
5252
  # @return [Array<Types::GuardrailTopicConfig>]
4882
5253
  #
5254
+ # @!attribute [rw] tier_config
5255
+ # The tier that your guardrail uses for denied topic filters.
5256
+ # @return [Types::GuardrailTopicsTierConfig]
5257
+ #
4883
5258
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicyConfig AWS API Documentation
4884
5259
  #
4885
5260
  class GuardrailTopicPolicyConfig < Struct.new(
4886
- :topics_config)
5261
+ :topics_config,
5262
+ :tier_config)
4887
5263
  SENSITIVE = []
4888
5264
  include Aws::Structure
4889
5265
  end
4890
5266
 
5267
+ # The tier that your guardrail uses for denied topic filters.
5268
+ #
5269
+ # @!attribute [rw] tier_name
5270
+ # The tier that your guardrail uses for denied topic filters. Valid
5271
+ # values include:
5272
+ #
5273
+ # * `CLASSIC` tier – Provides established guardrails functionality
5274
+ # supporting English, French, and Spanish languages.
5275
+ #
5276
+ # * `STANDARD` tier – Provides a more robust solution than the
5277
+ # `CLASSIC` tier and has more comprehensive language support. This
5278
+ # tier requires that your guardrail use [cross-Region inference][1].
5279
+ #
5280
+ #
5281
+ #
5282
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
5283
+ # @return [String]
5284
+ #
5285
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicsTier AWS API Documentation
5286
+ #
5287
+ class GuardrailTopicsTier < Struct.new(
5288
+ :tier_name)
5289
+ SENSITIVE = [:tier_name]
5290
+ include Aws::Structure
5291
+ end
5292
+
5293
+ # The tier that your guardrail uses for denied topic filters. Consider
5294
+ # using a tier that balances performance, accuracy, and compatibility
5295
+ # with your existing generative AI workflows.
5296
+ #
5297
+ # @!attribute [rw] tier_name
5298
+ # The tier that your guardrail uses for denied topic filters. Valid
5299
+ # values include:
5300
+ #
5301
+ # * `CLASSIC` tier – Provides established guardrails functionality
5302
+ # supporting English, French, and Spanish languages.
5303
+ #
5304
+ # * `STANDARD` tier – Provides a more robust solution than the
5305
+ # `CLASSIC` tier and has more comprehensive language support. This
5306
+ # tier requires that your guardrail use [cross-Region inference][1].
5307
+ #
5308
+ #
5309
+ #
5310
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
5311
+ # @return [String]
5312
+ #
5313
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicsTierConfig AWS API Documentation
5314
+ #
5315
+ class GuardrailTopicsTierConfig < Struct.new(
5316
+ :tier_name)
5317
+ SENSITIVE = [:tier_name]
5318
+ include Aws::Structure
5319
+ end
5320
+
4891
5321
  # A word configured for the guardrail.
4892
5322
  #
4893
5323
  # @!attribute [rw] text
@@ -5123,6 +5553,32 @@ module Aws::Bedrock
5123
5553
  include Aws::Structure
5124
5554
  end
5125
5555
 
5556
+ # Configuration for implicit filtering in Knowledge Base vector
5557
+ # searches. Implicit filtering allows you to automatically filter search
5558
+ # results based on metadata attributes without requiring explicit filter
5559
+ # expressions in each query.
5560
+ #
5561
+ # @!attribute [rw] metadata_attributes
5562
+ # A list of metadata attribute schemas that define the structure and
5563
+ # properties of metadata fields used for implicit filtering. Each
5564
+ # attribute defines a key, type, and optional description.
5565
+ # @return [Array<Types::MetadataAttributeSchema>]
5566
+ #
5567
+ # @!attribute [rw] model_arn
5568
+ # The Amazon Resource Name (ARN) of the foundation model used for
5569
+ # implicit filtering. This model processes the query to extract
5570
+ # relevant filtering criteria.
5571
+ # @return [String]
5572
+ #
5573
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ImplicitFilterConfiguration AWS API Documentation
5574
+ #
5575
+ class ImplicitFilterConfiguration < Struct.new(
5576
+ :metadata_attributes,
5577
+ :model_arn)
5578
+ SENSITIVE = [:metadata_attributes]
5579
+ include Aws::Structure
5580
+ end
5581
+
5126
5582
  # Information about the imported model.
5127
5583
  #
5128
5584
  # @!attribute [rw] model_arn
@@ -5448,16 +5904,45 @@ module Aws::Bedrock
5448
5904
  # base data sources before returning results.
5449
5905
  # @return [Types::RetrievalFilter]
5450
5906
  #
5907
+ # @!attribute [rw] implicit_filter_configuration
5908
+ # Configuration for implicit filtering in Knowledge Base vector
5909
+ # searches. This allows the system to automatically apply filters
5910
+ # based on the query context without requiring explicit filter
5911
+ # expressions.
5912
+ # @return [Types::ImplicitFilterConfiguration]
5913
+ #
5914
+ # @!attribute [rw] reranking_configuration
5915
+ # Configuration for reranking search results in Knowledge Base vector
5916
+ # searches. Reranking improves search relevance by reordering initial
5917
+ # vector search results using more sophisticated relevance models.
5918
+ # @return [Types::VectorSearchRerankingConfiguration]
5919
+ #
5451
5920
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
5452
5921
  #
5453
5922
  class KnowledgeBaseVectorSearchConfiguration < Struct.new(
5454
5923
  :number_of_results,
5455
5924
  :override_search_type,
5456
- :filter)
5925
+ :filter,
5926
+ :implicit_filter_configuration,
5927
+ :reranking_configuration)
5457
5928
  SENSITIVE = [:filter]
5458
5929
  include Aws::Structure
5459
5930
  end
5460
5931
 
5932
+ # The legal term of the agreement.
5933
+ #
5934
+ # @!attribute [rw] url
5935
+ # URL to the legal term document.
5936
+ # @return [String]
5937
+ #
5938
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/LegalTerm AWS API Documentation
5939
+ #
5940
+ class LegalTerm < Struct.new(
5941
+ :url)
5942
+ SENSITIVE = []
5943
+ include Aws::Structure
5944
+ end
5945
+
5461
5946
  # @!attribute [rw] creation_time_before
5462
5947
  # Return custom models created before the specified time.
5463
5948
  # @return [Time]
@@ -5507,6 +5992,22 @@ module Aws::Bedrock
5507
5992
  # (`true`) or if they were shared with the current account (`false`).
5508
5993
  # @return [Boolean]
5509
5994
  #
5995
+ # @!attribute [rw] model_status
5996
+ # The status of them model to filter results by. Possible values
5997
+ # include:
5998
+ #
5999
+ # * `Creating` - Include only models that are currently being created
6000
+ # and validated.
6001
+ #
6002
+ # * `Active` - Include only models that have been successfully created
6003
+ # and are ready for use.
6004
+ #
6005
+ # * `Failed` - Include only models where the creation process failed.
6006
+ #
6007
+ # If you don't specify a status, the API returns models in all
6008
+ # states.
6009
+ # @return [String]
6010
+ #
5510
6011
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelsRequest AWS API Documentation
5511
6012
  #
5512
6013
  class ListCustomModelsRequest < Struct.new(
@@ -5519,7 +6020,8 @@ module Aws::Bedrock
5519
6020
  :next_token,
5520
6021
  :sort_by,
5521
6022
  :sort_order,
5522
- :is_owned)
6023
+ :is_owned,
6024
+ :model_status)
5523
6025
  SENSITIVE = []
5524
6026
  include Aws::Structure
5525
6027
  end
@@ -5621,6 +6123,40 @@ module Aws::Bedrock
5621
6123
  include Aws::Structure
5622
6124
  end
5623
6125
 
6126
+ # @!attribute [rw] model_id
6127
+ # Model Id of the foundation model.
6128
+ # @return [String]
6129
+ #
6130
+ # @!attribute [rw] offer_type
6131
+ # Type of offer associated with the model.
6132
+ # @return [String]
6133
+ #
6134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffersRequest AWS API Documentation
6135
+ #
6136
+ class ListFoundationModelAgreementOffersRequest < Struct.new(
6137
+ :model_id,
6138
+ :offer_type)
6139
+ SENSITIVE = []
6140
+ include Aws::Structure
6141
+ end
6142
+
6143
+ # @!attribute [rw] model_id
6144
+ # Model Id of the foundation model.
6145
+ # @return [String]
6146
+ #
6147
+ # @!attribute [rw] offers
6148
+ # List of the offers associated with the specified model.
6149
+ # @return [Array<Types::Offer>]
6150
+ #
6151
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffersResponse AWS API Documentation
6152
+ #
6153
+ class ListFoundationModelAgreementOffersResponse < Struct.new(
6154
+ :model_id,
6155
+ :offers)
6156
+ SENSITIVE = []
6157
+ include Aws::Structure
6158
+ end
6159
+
5624
6160
  # @!attribute [rw] by_provider
5625
6161
  # Return models belonging to the model provider that you specify.
5626
6162
  # @return [String]
@@ -6543,6 +7079,62 @@ module Aws::Bedrock
6543
7079
  include Aws::Structure
6544
7080
  end
6545
7081
 
7082
+ # Defines the schema for a metadata attribute used in Knowledge Base
7083
+ # vector searches. Metadata attributes provide additional context for
7084
+ # documents and can be used for filtering and reranking search results.
7085
+ #
7086
+ # @!attribute [rw] key
7087
+ # The unique identifier for the metadata attribute. This key is used
7088
+ # to reference the attribute in filter expressions and reranking
7089
+ # configurations.
7090
+ # @return [String]
7091
+ #
7092
+ # @!attribute [rw] type
7093
+ # The data type of the metadata attribute. The type determines how the
7094
+ # attribute can be used in filter expressions and reranking.
7095
+ # @return [String]
7096
+ #
7097
+ # @!attribute [rw] description
7098
+ # An optional description of the metadata attribute that provides
7099
+ # additional context about its purpose and usage.
7100
+ # @return [String]
7101
+ #
7102
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/MetadataAttributeSchema AWS API Documentation
7103
+ #
7104
+ class MetadataAttributeSchema < Struct.new(
7105
+ :key,
7106
+ :type,
7107
+ :description)
7108
+ SENSITIVE = []
7109
+ include Aws::Structure
7110
+ end
7111
+
7112
+ # Configuration for how metadata should be used during the reranking
7113
+ # process in Knowledge Base vector searches. This determines which
7114
+ # metadata fields are included or excluded when reordering search
7115
+ # results.
7116
+ #
7117
+ # @!attribute [rw] selection_mode
7118
+ # The mode for selecting which metadata fields to include in the
7119
+ # reranking process. Valid values are ALL (use all available metadata
7120
+ # fields) or SELECTIVE (use only specified fields).
7121
+ # @return [String]
7122
+ #
7123
+ # @!attribute [rw] selective_mode_configuration
7124
+ # Configuration for selective mode, which allows you to explicitly
7125
+ # include or exclude specific metadata fields during reranking. This
7126
+ # is only used when selectionMode is set to SELECTIVE.
7127
+ # @return [Types::RerankingMetadataSelectiveModeConfiguration]
7128
+ #
7129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/MetadataConfigurationForReranking AWS API Documentation
7130
+ #
7131
+ class MetadataConfigurationForReranking < Struct.new(
7132
+ :selection_mode,
7133
+ :selective_mode_configuration)
7134
+ SENSITIVE = []
7135
+ include Aws::Structure
7136
+ end
7137
+
6546
7138
  # Contains details about each model copy job.
6547
7139
  #
6548
7140
  # This data type is used in the following API operations:
@@ -6638,14 +7230,14 @@ module Aws::Bedrock
6638
7230
  # Status of the customization job.
6639
7231
  # @return [String]
6640
7232
  #
6641
- # @!attribute [rw] last_modified_time
6642
- # Time that the customization job was last modified.
6643
- # @return [Time]
6644
- #
6645
7233
  # @!attribute [rw] status_details
6646
7234
  # Details about the status of the data processing sub-task of the job.
6647
7235
  # @return [Types::StatusDetails]
6648
7236
  #
7237
+ # @!attribute [rw] last_modified_time
7238
+ # Time that the customization job was last modified.
7239
+ # @return [Time]
7240
+ #
6649
7241
  # @!attribute [rw] creation_time
6650
7242
  # Creation time of the custom model.
6651
7243
  # @return [Time]
@@ -6679,8 +7271,8 @@ module Aws::Bedrock
6679
7271
  :base_model_arn,
6680
7272
  :job_name,
6681
7273
  :status,
6682
- :last_modified_time,
6683
7274
  :status_details,
7275
+ :last_modified_time,
6684
7276
  :creation_time,
6685
7277
  :end_time,
6686
7278
  :custom_model_arn,
@@ -6690,14 +7282,14 @@ module Aws::Bedrock
6690
7282
  include Aws::Structure
6691
7283
  end
6692
7284
 
6693
- # Data source for the imported model.
7285
+ # The data source of the model to import.
6694
7286
  #
6695
7287
  # @note ModelDataSource is a union - when making an API calls you must set exactly one of the members.
6696
7288
  #
6697
7289
  # @note ModelDataSource is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ModelDataSource corresponding to the set member.
6698
7290
  #
6699
7291
  # @!attribute [rw] s3_data_source
6700
- # The Amazon S3 data source of the imported model.
7292
+ # The Amazon S3 data source of the model to import.
6701
7293
  # @return [Types::S3DataSource]
6702
7294
  #
6703
7295
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelDataSource AWS API Documentation
@@ -7015,6 +7607,30 @@ module Aws::Bedrock
7015
7607
  include Aws::Structure
7016
7608
  end
7017
7609
 
7610
+ # An offer dictates usage terms for the model.
7611
+ #
7612
+ # @!attribute [rw] offer_id
7613
+ # Offer Id for a model offer.
7614
+ # @return [String]
7615
+ #
7616
+ # @!attribute [rw] offer_token
7617
+ # Offer token.
7618
+ # @return [String]
7619
+ #
7620
+ # @!attribute [rw] term_details
7621
+ # Details about the terms of the offer.
7622
+ # @return [Types::TermDetails]
7623
+ #
7624
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/Offer AWS API Documentation
7625
+ #
7626
+ class Offer < Struct.new(
7627
+ :offer_id,
7628
+ :offer_token,
7629
+ :term_details)
7630
+ SENSITIVE = []
7631
+ include Aws::Structure
7632
+ end
7633
+
7018
7634
  # The configuration details for the model to process the prompt prior to
7019
7635
  # retrieval and response generation.
7020
7636
  #
@@ -7059,6 +7675,20 @@ module Aws::Bedrock
7059
7675
  include Aws::Structure
7060
7676
  end
7061
7677
 
7678
+ # Describes the usage-based pricing term.
7679
+ #
7680
+ # @!attribute [rw] rate_card
7681
+ # Describes a usage price for each dimension.
7682
+ # @return [Array<Types::DimensionalPriceRate>]
7683
+ #
7684
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PricingTerm AWS API Documentation
7685
+ #
7686
+ class PricingTerm < Struct.new(
7687
+ :rate_card)
7688
+ SENSITIVE = []
7689
+ include Aws::Structure
7690
+ end
7691
+
7062
7692
  # Details about a prompt router.
7063
7693
  #
7064
7694
  # @!attribute [rw] prompt_router_name
@@ -7262,6 +7892,22 @@ module Aws::Bedrock
7262
7892
  #
7263
7893
  class PutModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
7264
7894
 
7895
+ # @!attribute [rw] form_data
7896
+ # Put customer profile Request.
7897
+ # @return [String]
7898
+ #
7899
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccessRequest AWS API Documentation
7900
+ #
7901
+ class PutUseCaseForModelAccessRequest < Struct.new(
7902
+ :form_data)
7903
+ SENSITIVE = []
7904
+ include Aws::Structure
7905
+ end
7906
+
7907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccessResponse AWS API Documentation
7908
+ #
7909
+ class PutUseCaseForModelAccessResponse < Aws::EmptyStructure; end
7910
+
7265
7911
  # The configuration details for transforming the prompt.
7266
7912
  #
7267
7913
  # @!attribute [rw] type
@@ -7455,6 +8101,43 @@ module Aws::Bedrock
7455
8101
  class Unknown < RequestMetadataFilters; end
7456
8102
  end
7457
8103
 
8104
+ # Configuration for selectively including or excluding metadata fields
8105
+ # during the reranking process. This allows you to control which
8106
+ # metadata attributes are considered when reordering search results.
8107
+ #
8108
+ # @note RerankingMetadataSelectiveModeConfiguration is a union - when making an API calls you must set exactly one of the members.
8109
+ #
8110
+ # @note RerankingMetadataSelectiveModeConfiguration is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of RerankingMetadataSelectiveModeConfiguration corresponding to the set member.
8111
+ #
8112
+ # @!attribute [rw] fields_to_include
8113
+ # A list of metadata field names to explicitly include in the
8114
+ # reranking process. Only these fields will be considered when
8115
+ # reordering search results. This parameter cannot be used together
8116
+ # with fieldsToExclude.
8117
+ # @return [Array<Types::FieldForReranking>]
8118
+ #
8119
+ # @!attribute [rw] fields_to_exclude
8120
+ # A list of metadata field names to explicitly exclude from the
8121
+ # reranking process. All metadata fields except these will be
8122
+ # considered when reordering search results. This parameter cannot be
8123
+ # used together with fieldsToInclude.
8124
+ # @return [Array<Types::FieldForReranking>]
8125
+ #
8126
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/RerankingMetadataSelectiveModeConfiguration AWS API Documentation
8127
+ #
8128
+ class RerankingMetadataSelectiveModeConfiguration < Struct.new(
8129
+ :fields_to_include,
8130
+ :fields_to_exclude,
8131
+ :unknown)
8132
+ SENSITIVE = [:fields_to_include, :fields_to_exclude]
8133
+ include Aws::Structure
8134
+ include Aws::Structure::Union
8135
+
8136
+ class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
8137
+ class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
8138
+ class Unknown < RerankingMetadataSelectiveModeConfiguration; end
8139
+ end
8140
+
7458
8141
  # The specified resource Amazon Resource Name (ARN) was not found. Check
7459
8142
  # the Amazon Resource Name (ARN) and try your request again.
7460
8143
  #
@@ -7727,7 +8410,7 @@ module Aws::Bedrock
7727
8410
  include Aws::Structure
7728
8411
  end
7729
8412
 
7730
- # The Amazon S3 data source of the imported job.
8413
+ # The Amazon S3 data source of the model to import.
7731
8414
  #
7732
8415
  # @!attribute [rw] s3_uri
7733
8416
  # The URI of the Amazon S3 data source.
@@ -7908,6 +8591,20 @@ module Aws::Bedrock
7908
8591
  #
7909
8592
  class StopModelInvocationJobResponse < Aws::EmptyStructure; end
7910
8593
 
8594
+ # Describes a support term.
8595
+ #
8596
+ # @!attribute [rw] refund_policy_description
8597
+ # Describes the refund policy.
8598
+ # @return [String]
8599
+ #
8600
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/SupportTerm AWS API Documentation
8601
+ #
8602
+ class SupportTerm < Struct.new(
8603
+ :refund_policy_description)
8604
+ SENSITIVE = []
8605
+ include Aws::Structure
8606
+ end
8607
+
7911
8608
  # Definition of the key/value pair for a tag.
7912
8609
  #
7913
8610
  # @!attribute [rw] key
@@ -7968,6 +8665,35 @@ module Aws::Bedrock
7968
8665
  include Aws::Structure
7969
8666
  end
7970
8667
 
8668
+ # Describes the usage terms of an offer.
8669
+ #
8670
+ # @!attribute [rw] usage_based_pricing_term
8671
+ # Describes the usage-based pricing term.
8672
+ # @return [Types::PricingTerm]
8673
+ #
8674
+ # @!attribute [rw] legal_term
8675
+ # Describes the legal terms.
8676
+ # @return [Types::LegalTerm]
8677
+ #
8678
+ # @!attribute [rw] support_term
8679
+ # Describes the support terms.
8680
+ # @return [Types::SupportTerm]
8681
+ #
8682
+ # @!attribute [rw] validity_term
8683
+ # Describes the validity terms.
8684
+ # @return [Types::ValidityTerm]
8685
+ #
8686
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TermDetails AWS API Documentation
8687
+ #
8688
+ class TermDetails < Struct.new(
8689
+ :usage_based_pricing_term,
8690
+ :legal_term,
8691
+ :support_term,
8692
+ :validity_term)
8693
+ SENSITIVE = []
8694
+ include Aws::Structure
8695
+ end
8696
+
7971
8697
  # The configuration details for text generation using a language model
7972
8698
  # via the `RetrieveAndGenerate` function.
7973
8699
  #
@@ -8390,6 +9116,104 @@ module Aws::Bedrock
8390
9116
  include Aws::Structure
8391
9117
  end
8392
9118
 
9119
+ # Describes the validity terms.
9120
+ #
9121
+ # @!attribute [rw] agreement_duration
9122
+ # Describes the agreement duration.
9123
+ # @return [String]
9124
+ #
9125
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidityTerm AWS API Documentation
9126
+ #
9127
+ class ValidityTerm < Struct.new(
9128
+ :agreement_duration)
9129
+ SENSITIVE = []
9130
+ include Aws::Structure
9131
+ end
9132
+
9133
+ # Configuration for using Amazon Bedrock foundation models to rerank
9134
+ # Knowledge Base vector search results. This enables more sophisticated
9135
+ # relevance ranking using large language models.
9136
+ #
9137
+ # @!attribute [rw] model_configuration
9138
+ # Configuration for the Amazon Bedrock foundation model used for
9139
+ # reranking. This includes the model ARN and any additional request
9140
+ # fields required by the model.
9141
+ # @return [Types::VectorSearchBedrockRerankingModelConfiguration]
9142
+ #
9143
+ # @!attribute [rw] number_of_reranked_results
9144
+ # The maximum number of results to rerank. This limits how many of the
9145
+ # initial vector search results will be processed by the reranking
9146
+ # model. A smaller number improves performance but may exclude
9147
+ # potentially relevant results.
9148
+ # @return [Integer]
9149
+ #
9150
+ # @!attribute [rw] metadata_configuration
9151
+ # Configuration for how document metadata should be used during the
9152
+ # reranking process. This determines which metadata fields are
9153
+ # included when reordering search results.
9154
+ # @return [Types::MetadataConfigurationForReranking]
9155
+ #
9156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchBedrockRerankingConfiguration AWS API Documentation
9157
+ #
9158
+ class VectorSearchBedrockRerankingConfiguration < Struct.new(
9159
+ :model_configuration,
9160
+ :number_of_reranked_results,
9161
+ :metadata_configuration)
9162
+ SENSITIVE = []
9163
+ include Aws::Structure
9164
+ end
9165
+
9166
+ # Configuration for the Amazon Bedrock foundation model used for
9167
+ # reranking vector search results. This specifies which model to use and
9168
+ # any additional parameters required by the model.
9169
+ #
9170
+ # @!attribute [rw] model_arn
9171
+ # The Amazon Resource Name (ARN) of the foundation model to use for
9172
+ # reranking. This model processes the query and search results to
9173
+ # determine a more relevant ordering.
9174
+ # @return [String]
9175
+ #
9176
+ # @!attribute [rw] additional_model_request_fields
9177
+ # A list of additional fields to include in the model request during
9178
+ # reranking. These fields provide extra context or configuration
9179
+ # options specific to the selected foundation model.
9180
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
9181
+ #
9182
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchBedrockRerankingModelConfiguration AWS API Documentation
9183
+ #
9184
+ class VectorSearchBedrockRerankingModelConfiguration < Struct.new(
9185
+ :model_arn,
9186
+ :additional_model_request_fields)
9187
+ SENSITIVE = []
9188
+ include Aws::Structure
9189
+ end
9190
+
9191
+ # Configuration for reranking vector search results to improve
9192
+ # relevance. Reranking applies additional relevance models to reorder
9193
+ # the initial vector search results based on more sophisticated
9194
+ # criteria.
9195
+ #
9196
+ # @!attribute [rw] type
9197
+ # The type of reranking to apply to vector search results. Currently,
9198
+ # the only supported value is BEDROCK, which uses Amazon Bedrock
9199
+ # foundation models for reranking.
9200
+ # @return [String]
9201
+ #
9202
+ # @!attribute [rw] bedrock_reranking_configuration
9203
+ # Configuration for using Amazon Bedrock foundation models to rerank
9204
+ # search results. This is required when the reranking type is set to
9205
+ # BEDROCK.
9206
+ # @return [Types::VectorSearchBedrockRerankingConfiguration]
9207
+ #
9208
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchRerankingConfiguration AWS API Documentation
9209
+ #
9210
+ class VectorSearchRerankingConfiguration < Struct.new(
9211
+ :type,
9212
+ :bedrock_reranking_configuration)
9213
+ SENSITIVE = []
9214
+ include Aws::Structure
9215
+ end
9216
+
8393
9217
  # The configuration of a virtual private cloud (VPC). For more
8394
9218
  # information, see [Protect your data using Amazon Virtual Private Cloud
8395
9219
  # and Amazon Web Services PrivateLink][1].