aws-sdk-bedrock 1.46.0 → 1.56.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,158 @@ module Aws::Bedrock
264
283
  include Aws::Structure
265
284
  end
266
285
 
286
+ # @!attribute [rw] model_deployment_name
287
+ # The name for the custom model deployment. The name must be unique
288
+ # within your Amazon Web Services account and Region.
289
+ # @return [String]
290
+ #
291
+ # @!attribute [rw] model_arn
292
+ # The Amazon Resource Name (ARN) of the custom model to deploy for
293
+ # on-demand inference. The custom model must be in the `Active` state.
294
+ # @return [String]
295
+ #
296
+ # @!attribute [rw] description
297
+ # A description for the custom model deployment to help you identify
298
+ # its purpose.
299
+ # @return [String]
300
+ #
301
+ # @!attribute [rw] tags
302
+ # Tags to assign to the custom model deployment. You can use tags to
303
+ # organize and track your Amazon Web Services resources for cost
304
+ # allocation and management purposes.
305
+ # @return [Array<Types::Tag>]
306
+ #
307
+ # @!attribute [rw] client_request_token
308
+ # A unique, case-sensitive identifier to ensure that the operation
309
+ # completes no more than one time. If this token matches a previous
310
+ # request, Amazon Bedrock ignores the request, but does not return an
311
+ # error. For more information, see [Ensuring idempotency][1].
312
+ #
313
+ # **A suitable default value is auto-generated.** You should normally
314
+ # not need to pass this option.
315
+ #
316
+ #
317
+ #
318
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-idempotency.html
319
+ # @return [String]
320
+ #
321
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelDeploymentRequest AWS API Documentation
322
+ #
323
+ class CreateCustomModelDeploymentRequest < Struct.new(
324
+ :model_deployment_name,
325
+ :model_arn,
326
+ :description,
327
+ :tags,
328
+ :client_request_token)
329
+ SENSITIVE = []
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @!attribute [rw] custom_model_deployment_arn
334
+ # The Amazon Resource Name (ARN) of the custom model deployment. Use
335
+ # this ARN as the `modelId` parameter when invoking the model with the
336
+ # `InvokeModel` or `Converse` operations.
337
+ # @return [String]
338
+ #
339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelDeploymentResponse AWS API Documentation
340
+ #
341
+ class CreateCustomModelDeploymentResponse < Struct.new(
342
+ :custom_model_deployment_arn)
343
+ SENSITIVE = []
344
+ include Aws::Structure
345
+ end
346
+
347
+ # @!attribute [rw] model_name
348
+ # A unique name for the custom model.
349
+ # @return [String]
350
+ #
351
+ # @!attribute [rw] model_source_config
352
+ # The data source for the model. The Amazon S3 URI in the model source
353
+ # must be for the Amazon-managed Amazon S3 bucket containing your
354
+ # model artifacts.
355
+ # @return [Types::ModelDataSource]
356
+ #
357
+ # @!attribute [rw] model_kms_key_arn
358
+ # The Amazon Resource Name (ARN) of the customer managed KMS key to
359
+ # encrypt the custom model. If you don't provide a KMS key, Amazon
360
+ # Bedrock uses an Amazon Web Services-managed KMS key to encrypt the
361
+ # model.
362
+ #
363
+ # If you provide a customer managed KMS key, your Amazon Bedrock
364
+ # service role must have permissions to use it. For more information
365
+ # see [Encryption of imported models][1].
366
+ #
367
+ #
368
+ #
369
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/encryption-import-model.html
370
+ # @return [String]
371
+ #
372
+ # @!attribute [rw] role_arn
373
+ # The Amazon Resource Name (ARN) of an IAM service role that Amazon
374
+ # Bedrock assumes to perform tasks on your behalf. This role must have
375
+ # permissions to access the Amazon S3 bucket containing your model
376
+ # artifacts and the KMS key (if specified). For more information, see
377
+ # [Setting up an IAM service role for importing models][1] in the
378
+ # Amazon Bedrock User Guide.
379
+ #
380
+ #
381
+ #
382
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/model-import-iam-role.html
383
+ # @return [String]
384
+ #
385
+ # @!attribute [rw] model_tags
386
+ # A list of key-value pairs to associate with the custom model
387
+ # resource. You can use these tags to organize and identify your
388
+ # resources.
389
+ #
390
+ # For more information, see [Tagging resources][1] in the [Amazon
391
+ # Bedrock User Guide][2].
392
+ #
393
+ #
394
+ #
395
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/tagging.html
396
+ # [2]: https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html
397
+ # @return [Array<Types::Tag>]
398
+ #
399
+ # @!attribute [rw] client_request_token
400
+ # A unique, case-sensitive identifier to ensure that the API request
401
+ # completes no more than one time. If this token matches a previous
402
+ # request, Amazon Bedrock ignores the request, but does not return an
403
+ # error. For more information, see [Ensuring idempotency][1].
404
+ #
405
+ # **A suitable default value is auto-generated.** You should normally
406
+ # not need to pass this option.
407
+ #
408
+ #
409
+ #
410
+ # [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html
411
+ # @return [String]
412
+ #
413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelRequest AWS API Documentation
414
+ #
415
+ class CreateCustomModelRequest < Struct.new(
416
+ :model_name,
417
+ :model_source_config,
418
+ :model_kms_key_arn,
419
+ :role_arn,
420
+ :model_tags,
421
+ :client_request_token)
422
+ SENSITIVE = []
423
+ include Aws::Structure
424
+ end
425
+
426
+ # @!attribute [rw] model_arn
427
+ # The Amazon Resource Name (ARN) of the new custom model.
428
+ # @return [String]
429
+ #
430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateCustomModelResponse AWS API Documentation
431
+ #
432
+ class CreateCustomModelResponse < Struct.new(
433
+ :model_arn)
434
+ SENSITIVE = []
435
+ include Aws::Structure
436
+ end
437
+
267
438
  # @!attribute [rw] job_name
268
439
  # A name for the evaluation job. Names must unique with your Amazon
269
440
  # Web Services account, and your account's Amazon Web Services
@@ -365,6 +536,35 @@ module Aws::Bedrock
365
536
  include Aws::Structure
366
537
  end
367
538
 
539
+ # @!attribute [rw] offer_token
540
+ # An offer token encapsulates the information for an offer.
541
+ # @return [String]
542
+ #
543
+ # @!attribute [rw] model_id
544
+ # Model Id of the model for the access request.
545
+ # @return [String]
546
+ #
547
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreementRequest AWS API Documentation
548
+ #
549
+ class CreateFoundationModelAgreementRequest < Struct.new(
550
+ :offer_token,
551
+ :model_id)
552
+ SENSITIVE = []
553
+ include Aws::Structure
554
+ end
555
+
556
+ # @!attribute [rw] model_id
557
+ # Model Id of the model for the access request.
558
+ # @return [String]
559
+ #
560
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CreateFoundationModelAgreementResponse AWS API Documentation
561
+ #
562
+ class CreateFoundationModelAgreementResponse < Struct.new(
563
+ :model_id)
564
+ SENSITIVE = []
565
+ include Aws::Structure
566
+ end
567
+
368
568
  # @!attribute [rw] name
369
569
  # The name to give the guardrail.
370
570
  # @return [String]
@@ -1265,6 +1465,55 @@ module Aws::Bedrock
1265
1465
  include Aws::Structure
1266
1466
  end
1267
1467
 
1468
+ # Contains summary information about a custom model deployment,
1469
+ # including its ARN, name, status, and associated custom model.
1470
+ #
1471
+ # @!attribute [rw] custom_model_deployment_arn
1472
+ # The Amazon Resource Name (ARN) of the custom model deployment.
1473
+ # @return [String]
1474
+ #
1475
+ # @!attribute [rw] custom_model_deployment_name
1476
+ # The name of the custom model deployment.
1477
+ # @return [String]
1478
+ #
1479
+ # @!attribute [rw] model_arn
1480
+ # The Amazon Resource Name (ARN) of the custom model associated with
1481
+ # this deployment.
1482
+ # @return [String]
1483
+ #
1484
+ # @!attribute [rw] created_at
1485
+ # The date and time when the custom model deployment was created.
1486
+ # @return [Time]
1487
+ #
1488
+ # @!attribute [rw] status
1489
+ # The status of the custom model deployment. Possible values are
1490
+ # `CREATING`, `ACTIVE`, and `FAILED`.
1491
+ # @return [String]
1492
+ #
1493
+ # @!attribute [rw] last_updated_at
1494
+ # The date and time when the custom model deployment was last
1495
+ # modified.
1496
+ # @return [Time]
1497
+ #
1498
+ # @!attribute [rw] failure_message
1499
+ # If the deployment status is `FAILED`, this field contains a message
1500
+ # describing the failure reason.
1501
+ # @return [String]
1502
+ #
1503
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomModelDeploymentSummary AWS API Documentation
1504
+ #
1505
+ class CustomModelDeploymentSummary < Struct.new(
1506
+ :custom_model_deployment_arn,
1507
+ :custom_model_deployment_name,
1508
+ :model_arn,
1509
+ :created_at,
1510
+ :status,
1511
+ :last_updated_at,
1512
+ :failure_message)
1513
+ SENSITIVE = []
1514
+ include Aws::Structure
1515
+ end
1516
+
1268
1517
  # Summary information for a custom model.
1269
1518
  #
1270
1519
  # @!attribute [rw] model_arn
@@ -1301,6 +1550,17 @@ module Aws::Bedrock
1301
1550
  # The unique identifier of the account that owns the model.
1302
1551
  # @return [String]
1303
1552
  #
1553
+ # @!attribute [rw] model_status
1554
+ # The current status of the custom model. Possible values include:
1555
+ #
1556
+ # * `Creating` - The model is being created and validated.
1557
+ #
1558
+ # * `Active` - The model has been successfully created and is ready
1559
+ # for use.
1560
+ #
1561
+ # * `Failed` - The model creation process failed.
1562
+ # @return [String]
1563
+ #
1304
1564
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/CustomModelSummary AWS API Documentation
1305
1565
  #
1306
1566
  class CustomModelSummary < Struct.new(
@@ -1310,7 +1570,8 @@ module Aws::Bedrock
1310
1570
  :base_model_arn,
1311
1571
  :base_model_name,
1312
1572
  :customization_type,
1313
- :owner_account_id)
1573
+ :owner_account_id,
1574
+ :model_status)
1314
1575
  SENSITIVE = []
1315
1576
  include Aws::Structure
1316
1577
  end
@@ -1392,6 +1653,23 @@ module Aws::Bedrock
1392
1653
  include Aws::Structure
1393
1654
  end
1394
1655
 
1656
+ # @!attribute [rw] custom_model_deployment_identifier
1657
+ # The Amazon Resource Name (ARN) or name of the custom model
1658
+ # deployment to delete.
1659
+ # @return [String]
1660
+ #
1661
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelDeploymentRequest AWS API Documentation
1662
+ #
1663
+ class DeleteCustomModelDeploymentRequest < Struct.new(
1664
+ :custom_model_deployment_identifier)
1665
+ SENSITIVE = []
1666
+ include Aws::Structure
1667
+ end
1668
+
1669
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteCustomModelDeploymentResponse AWS API Documentation
1670
+ #
1671
+ class DeleteCustomModelDeploymentResponse < Aws::EmptyStructure; end
1672
+
1395
1673
  # @!attribute [rw] model_identifier
1396
1674
  # Name of the model to delete.
1397
1675
  # @return [String]
@@ -1408,6 +1686,22 @@ module Aws::Bedrock
1408
1686
  #
1409
1687
  class DeleteCustomModelResponse < Aws::EmptyStructure; end
1410
1688
 
1689
+ # @!attribute [rw] model_id
1690
+ # Model Id of the model access to delete.
1691
+ # @return [String]
1692
+ #
1693
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreementRequest AWS API Documentation
1694
+ #
1695
+ class DeleteFoundationModelAgreementRequest < Struct.new(
1696
+ :model_id)
1697
+ SENSITIVE = []
1698
+ include Aws::Structure
1699
+ end
1700
+
1701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DeleteFoundationModelAgreementResponse AWS API Documentation
1702
+ #
1703
+ class DeleteFoundationModelAgreementResponse < Aws::EmptyStructure; end
1704
+
1411
1705
  # @!attribute [rw] guardrail_identifier
1412
1706
  # The unique identifier of the guardrail. This can be an ID or the
1413
1707
  # ARN.
@@ -1539,6 +1833,35 @@ module Aws::Bedrock
1539
1833
  #
1540
1834
  class DeregisterMarketplaceModelEndpointResponse < Aws::EmptyStructure; end
1541
1835
 
1836
+ # Dimensional price rate.
1837
+ #
1838
+ # @!attribute [rw] dimension
1839
+ # Dimension for the price rate.
1840
+ # @return [String]
1841
+ #
1842
+ # @!attribute [rw] price
1843
+ # Single-dimensional rate information.
1844
+ # @return [String]
1845
+ #
1846
+ # @!attribute [rw] description
1847
+ # Description of the price rate.
1848
+ # @return [String]
1849
+ #
1850
+ # @!attribute [rw] unit
1851
+ # Unit associated with the price.
1852
+ # @return [String]
1853
+ #
1854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/DimensionalPriceRate AWS API Documentation
1855
+ #
1856
+ class DimensionalPriceRate < Struct.new(
1857
+ :dimension,
1858
+ :price,
1859
+ :description,
1860
+ :unit)
1861
+ SENSITIVE = []
1862
+ include Aws::Structure
1863
+ end
1864
+
1542
1865
  # Settings for distilling a foundation model into a smaller and more
1543
1866
  # efficient model.
1544
1867
  #
@@ -2191,6 +2514,24 @@ module Aws::Bedrock
2191
2514
  include Aws::Structure
2192
2515
  end
2193
2516
 
2517
+ # Specifies a field to be used during the reranking process in a
2518
+ # Knowledge Base vector search. This structure identifies metadata
2519
+ # fields that should be considered when reordering search results to
2520
+ # improve relevance.
2521
+ #
2522
+ # @!attribute [rw] field_name
2523
+ # The name of the metadata field to be used during the reranking
2524
+ # process.
2525
+ # @return [String]
2526
+ #
2527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/FieldForReranking AWS API Documentation
2528
+ #
2529
+ class FieldForReranking < Struct.new(
2530
+ :field_name)
2531
+ SENSITIVE = []
2532
+ include Aws::Structure
2533
+ end
2534
+
2194
2535
  # Specifies the name of the metadata attribute/field to apply filters.
2195
2536
  # You must match the name of the attribute/field in your data
2196
2537
  # source/document metadata.
@@ -2383,6 +2724,77 @@ module Aws::Bedrock
2383
2724
  include Aws::Structure
2384
2725
  end
2385
2726
 
2727
+ # @!attribute [rw] custom_model_deployment_identifier
2728
+ # The Amazon Resource Name (ARN) or name of the custom model
2729
+ # deployment to retrieve information about.
2730
+ # @return [String]
2731
+ #
2732
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelDeploymentRequest AWS API Documentation
2733
+ #
2734
+ class GetCustomModelDeploymentRequest < Struct.new(
2735
+ :custom_model_deployment_identifier)
2736
+ SENSITIVE = []
2737
+ include Aws::Structure
2738
+ end
2739
+
2740
+ # @!attribute [rw] custom_model_deployment_arn
2741
+ # The Amazon Resource Name (ARN) of the custom model deployment.
2742
+ # @return [String]
2743
+ #
2744
+ # @!attribute [rw] model_deployment_name
2745
+ # The name of the custom model deployment.
2746
+ # @return [String]
2747
+ #
2748
+ # @!attribute [rw] model_arn
2749
+ # The Amazon Resource Name (ARN) of the custom model associated with
2750
+ # this deployment.
2751
+ # @return [String]
2752
+ #
2753
+ # @!attribute [rw] created_at
2754
+ # The date and time when the custom model deployment was created.
2755
+ # @return [Time]
2756
+ #
2757
+ # @!attribute [rw] status
2758
+ # The status of the custom model deployment. Possible values are:
2759
+ #
2760
+ # * `CREATING` - The deployment is being set up and prepared for
2761
+ # inference.
2762
+ #
2763
+ # * `ACTIVE` - The deployment is ready and available for inference
2764
+ # requests.
2765
+ #
2766
+ # * `FAILED` - The deployment failed to be created or became
2767
+ # unavailable.
2768
+ # @return [String]
2769
+ #
2770
+ # @!attribute [rw] description
2771
+ # The description of the custom model deployment.
2772
+ # @return [String]
2773
+ #
2774
+ # @!attribute [rw] failure_message
2775
+ # If the deployment status is `FAILED`, this field contains a message
2776
+ # describing the failure reason.
2777
+ # @return [String]
2778
+ #
2779
+ # @!attribute [rw] last_updated_at
2780
+ # The date and time when the custom model deployment was last updated.
2781
+ # @return [Time]
2782
+ #
2783
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelDeploymentResponse AWS API Documentation
2784
+ #
2785
+ class GetCustomModelDeploymentResponse < Struct.new(
2786
+ :custom_model_deployment_arn,
2787
+ :model_deployment_name,
2788
+ :model_arn,
2789
+ :created_at,
2790
+ :status,
2791
+ :description,
2792
+ :failure_message,
2793
+ :last_updated_at)
2794
+ SENSITIVE = []
2795
+ include Aws::Structure
2796
+ end
2797
+
2386
2798
  # @!attribute [rw] model_identifier
2387
2799
  # Name or Amazon Resource Name (ARN) of the custom model.
2388
2800
  # @return [String]
@@ -2408,7 +2820,13 @@ module Aws::Bedrock
2408
2820
  # @return [String]
2409
2821
  #
2410
2822
  # @!attribute [rw] job_arn
2411
- # Job Amazon Resource Name (ARN) associated with this model.
2823
+ # Job Amazon Resource Name (ARN) associated with this model. For
2824
+ # models that you create with the [CreateCustomModel][1] API
2825
+ # operation, this is `NULL`.
2826
+ #
2827
+ #
2828
+ #
2829
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModel.html
2412
2830
  # @return [String]
2413
2831
  #
2414
2832
  # @!attribute [rw] base_model_arn
@@ -2460,6 +2878,24 @@ module Aws::Bedrock
2460
2878
  # The customization configuration for the custom model.
2461
2879
  # @return [Types::CustomizationConfig]
2462
2880
  #
2881
+ # @!attribute [rw] model_status
2882
+ # The current status of the custom model. Possible values include:
2883
+ #
2884
+ # * `Creating` - The model is being created and validated.
2885
+ #
2886
+ # * `Active` - The model has been successfully created and is ready
2887
+ # for use.
2888
+ #
2889
+ # * `Failed` - The model creation process failed. Check the
2890
+ # `failureMessage` field for details.
2891
+ # @return [String]
2892
+ #
2893
+ # @!attribute [rw] failure_message
2894
+ # A failure message for any issues that occurred when creating the
2895
+ # custom model. This is included for only a failed CreateCustomModel
2896
+ # operation.
2897
+ # @return [String]
2898
+ #
2463
2899
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetCustomModelResponse AWS API Documentation
2464
2900
  #
2465
2901
  class GetCustomModelResponse < Struct.new(
@@ -2477,7 +2913,9 @@ module Aws::Bedrock
2477
2913
  :training_metrics,
2478
2914
  :validation_metrics,
2479
2915
  :creation_time,
2480
- :customization_config)
2916
+ :customization_config,
2917
+ :model_status,
2918
+ :failure_message)
2481
2919
  SENSITIVE = []
2482
2920
  include Aws::Structure
2483
2921
  end
@@ -2579,6 +3017,50 @@ module Aws::Bedrock
2579
3017
  include Aws::Structure
2580
3018
  end
2581
3019
 
3020
+ # @!attribute [rw] model_id
3021
+ # The model Id of the foundation model.
3022
+ # @return [String]
3023
+ #
3024
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailabilityRequest AWS API Documentation
3025
+ #
3026
+ class GetFoundationModelAvailabilityRequest < Struct.new(
3027
+ :model_id)
3028
+ SENSITIVE = []
3029
+ include Aws::Structure
3030
+ end
3031
+
3032
+ # @!attribute [rw] model_id
3033
+ # The model Id of the foundation model.
3034
+ # @return [String]
3035
+ #
3036
+ # @!attribute [rw] agreement_availability
3037
+ # Agreement availability.
3038
+ # @return [Types::AgreementAvailability]
3039
+ #
3040
+ # @!attribute [rw] authorization_status
3041
+ # Authorization status.
3042
+ # @return [String]
3043
+ #
3044
+ # @!attribute [rw] entitlement_availability
3045
+ # Entitlement availability.
3046
+ # @return [String]
3047
+ #
3048
+ # @!attribute [rw] region_availability
3049
+ # Region availability.
3050
+ # @return [String]
3051
+ #
3052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetFoundationModelAvailabilityResponse AWS API Documentation
3053
+ #
3054
+ class GetFoundationModelAvailabilityResponse < Struct.new(
3055
+ :model_id,
3056
+ :agreement_availability,
3057
+ :authorization_status,
3058
+ :entitlement_availability,
3059
+ :region_availability)
3060
+ SENSITIVE = []
3061
+ include Aws::Structure
3062
+ end
3063
+
2582
3064
  # @!attribute [rw] model_identifier
2583
3065
  # The model identifier.
2584
3066
  # @return [String]
@@ -3020,15 +3502,15 @@ module Aws::Bedrock
3020
3502
  # failed.
3021
3503
  # @return [String]
3022
3504
  #
3023
- # @!attribute [rw] failure_message
3024
- # Information about why the job failed.
3025
- # @return [String]
3026
- #
3027
3505
  # @!attribute [rw] status_details
3028
3506
  # For a Distillation job, the details about the statuses of the
3029
3507
  # sub-tasks of the customization job.
3030
3508
  # @return [Types::StatusDetails]
3031
3509
  #
3510
+ # @!attribute [rw] failure_message
3511
+ # Information about why the job failed.
3512
+ # @return [String]
3513
+ #
3032
3514
  # @!attribute [rw] creation_time
3033
3515
  # Time that the resource was created.
3034
3516
  # @return [Time]
@@ -3101,8 +3583,8 @@ module Aws::Bedrock
3101
3583
  :client_request_token,
3102
3584
  :role_arn,
3103
3585
  :status,
3104
- :failure_message,
3105
3586
  :status_details,
3587
+ :failure_message,
3106
3588
  :creation_time,
3107
3589
  :last_modified_time,
3108
3590
  :end_time,
@@ -3558,6 +4040,24 @@ module Aws::Bedrock
3558
4040
  include Aws::Structure
3559
4041
  end
3560
4042
 
4043
+ # @api private
4044
+ #
4045
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccessRequest AWS API Documentation
4046
+ #
4047
+ class GetUseCaseForModelAccessRequest < Aws::EmptyStructure; end
4048
+
4049
+ # @!attribute [rw] form_data
4050
+ # Get customer profile Response.
4051
+ # @return [String]
4052
+ #
4053
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GetUseCaseForModelAccessResponse AWS API Documentation
4054
+ #
4055
+ class GetUseCaseForModelAccessResponse < Struct.new(
4056
+ :form_data)
4057
+ SENSITIVE = []
4058
+ include Aws::Structure
4059
+ end
4060
+
3561
4061
  # The configuration details for the guardrail.
3562
4062
  #
3563
4063
  # @!attribute [rw] guardrail_id
@@ -3812,6 +4312,60 @@ module Aws::Bedrock
3812
4312
  include Aws::Structure
3813
4313
  end
3814
4314
 
4315
+ # The tier that your guardrail uses for content filters.
4316
+ #
4317
+ # @!attribute [rw] tier_name
4318
+ # The tier that your guardrail uses for content filters. Valid values
4319
+ # include:
4320
+ #
4321
+ # * `CLASSIC` tier – Provides established guardrails functionality
4322
+ # supporting English, French, and Spanish languages.
4323
+ #
4324
+ # * `STANDARD` tier – Provides a more robust solution than the
4325
+ # `CLASSIC` tier and has more comprehensive language support. This
4326
+ # tier requires that your guardrail use [cross-Region inference][1].
4327
+ #
4328
+ #
4329
+ #
4330
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
4331
+ # @return [String]
4332
+ #
4333
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFiltersTier AWS API Documentation
4334
+ #
4335
+ class GuardrailContentFiltersTier < Struct.new(
4336
+ :tier_name)
4337
+ SENSITIVE = [:tier_name]
4338
+ include Aws::Structure
4339
+ end
4340
+
4341
+ # The tier that your guardrail uses for content filters. Consider using
4342
+ # a tier that balances performance, accuracy, and compatibility with
4343
+ # your existing generative AI workflows.
4344
+ #
4345
+ # @!attribute [rw] tier_name
4346
+ # The tier that your guardrail uses for content filters. Valid values
4347
+ # include:
4348
+ #
4349
+ # * `CLASSIC` tier – Provides established guardrails functionality
4350
+ # supporting English, French, and Spanish languages.
4351
+ #
4352
+ # * `STANDARD` tier – Provides a more robust solution than the
4353
+ # `CLASSIC` tier and has more comprehensive language support. This
4354
+ # tier requires that your guardrail use [cross-Region inference][1].
4355
+ #
4356
+ #
4357
+ #
4358
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
4359
+ # @return [String]
4360
+ #
4361
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentFiltersTierConfig AWS API Documentation
4362
+ #
4363
+ class GuardrailContentFiltersTierConfig < Struct.new(
4364
+ :tier_name)
4365
+ SENSITIVE = [:tier_name]
4366
+ include Aws::Structure
4367
+ end
4368
+
3815
4369
  # Contains details about how to handle harmful content.
3816
4370
  #
3817
4371
  # This data type is used in the following API operations:
@@ -3829,10 +4383,15 @@ module Aws::Bedrock
3829
4383
  # apply to prompts and model responses.
3830
4384
  # @return [Array<Types::GuardrailContentFilter>]
3831
4385
  #
4386
+ # @!attribute [rw] tier
4387
+ # The tier that your guardrail uses for content filters.
4388
+ # @return [Types::GuardrailContentFiltersTier]
4389
+ #
3832
4390
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicy AWS API Documentation
3833
4391
  #
3834
4392
  class GuardrailContentPolicy < Struct.new(
3835
- :filters)
4393
+ :filters,
4394
+ :tier)
3836
4395
  SENSITIVE = []
3837
4396
  include Aws::Structure
3838
4397
  end
@@ -3844,10 +4403,15 @@ module Aws::Bedrock
3844
4403
  # apply to prompts and model responses.
3845
4404
  # @return [Array<Types::GuardrailContentFilterConfig>]
3846
4405
  #
4406
+ # @!attribute [rw] tier_config
4407
+ # The tier that your guardrail uses for content filters.
4408
+ # @return [Types::GuardrailContentFiltersTierConfig]
4409
+ #
3847
4410
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailContentPolicyConfig AWS API Documentation
3848
4411
  #
3849
4412
  class GuardrailContentPolicyConfig < Struct.new(
3850
- :filters_config)
4413
+ :filters_config,
4414
+ :tier_config)
3851
4415
  SENSITIVE = []
3852
4416
  include Aws::Structure
3853
4417
  end
@@ -4865,10 +5429,15 @@ module Aws::Bedrock
4865
5429
  # A list of policies related to topics that the guardrail should deny.
4866
5430
  # @return [Array<Types::GuardrailTopic>]
4867
5431
  #
5432
+ # @!attribute [rw] tier
5433
+ # The tier that your guardrail uses for denied topic filters.
5434
+ # @return [Types::GuardrailTopicsTier]
5435
+ #
4868
5436
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicy AWS API Documentation
4869
5437
  #
4870
5438
  class GuardrailTopicPolicy < Struct.new(
4871
- :topics)
5439
+ :topics,
5440
+ :tier)
4872
5441
  SENSITIVE = []
4873
5442
  include Aws::Structure
4874
5443
  end
@@ -4880,14 +5449,73 @@ module Aws::Bedrock
4880
5449
  # A list of policies related to topics that the guardrail should deny.
4881
5450
  # @return [Array<Types::GuardrailTopicConfig>]
4882
5451
  #
5452
+ # @!attribute [rw] tier_config
5453
+ # The tier that your guardrail uses for denied topic filters.
5454
+ # @return [Types::GuardrailTopicsTierConfig]
5455
+ #
4883
5456
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicPolicyConfig AWS API Documentation
4884
5457
  #
4885
5458
  class GuardrailTopicPolicyConfig < Struct.new(
4886
- :topics_config)
5459
+ :topics_config,
5460
+ :tier_config)
4887
5461
  SENSITIVE = []
4888
5462
  include Aws::Structure
4889
5463
  end
4890
5464
 
5465
+ # The tier that your guardrail uses for denied topic filters.
5466
+ #
5467
+ # @!attribute [rw] tier_name
5468
+ # The tier that your guardrail uses for denied topic filters. Valid
5469
+ # values include:
5470
+ #
5471
+ # * `CLASSIC` tier – Provides established guardrails functionality
5472
+ # supporting English, French, and Spanish languages.
5473
+ #
5474
+ # * `STANDARD` tier – Provides a more robust solution than the
5475
+ # `CLASSIC` tier and has more comprehensive language support. This
5476
+ # tier requires that your guardrail use [cross-Region inference][1].
5477
+ #
5478
+ #
5479
+ #
5480
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
5481
+ # @return [String]
5482
+ #
5483
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicsTier AWS API Documentation
5484
+ #
5485
+ class GuardrailTopicsTier < Struct.new(
5486
+ :tier_name)
5487
+ SENSITIVE = [:tier_name]
5488
+ include Aws::Structure
5489
+ end
5490
+
5491
+ # The tier that your guardrail uses for denied topic filters. Consider
5492
+ # using a tier that balances performance, accuracy, and compatibility
5493
+ # with your existing generative AI workflows.
5494
+ #
5495
+ # @!attribute [rw] tier_name
5496
+ # The tier that your guardrail uses for denied topic filters. Valid
5497
+ # values include:
5498
+ #
5499
+ # * `CLASSIC` tier – Provides established guardrails functionality
5500
+ # supporting English, French, and Spanish languages.
5501
+ #
5502
+ # * `STANDARD` tier – Provides a more robust solution than the
5503
+ # `CLASSIC` tier and has more comprehensive language support. This
5504
+ # tier requires that your guardrail use [cross-Region inference][1].
5505
+ #
5506
+ #
5507
+ #
5508
+ # [1]: https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-cross-region.html
5509
+ # @return [String]
5510
+ #
5511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/GuardrailTopicsTierConfig AWS API Documentation
5512
+ #
5513
+ class GuardrailTopicsTierConfig < Struct.new(
5514
+ :tier_name)
5515
+ SENSITIVE = [:tier_name]
5516
+ include Aws::Structure
5517
+ end
5518
+
4891
5519
  # A word configured for the guardrail.
4892
5520
  #
4893
5521
  # @!attribute [rw] text
@@ -5123,6 +5751,32 @@ module Aws::Bedrock
5123
5751
  include Aws::Structure
5124
5752
  end
5125
5753
 
5754
+ # Configuration for implicit filtering in Knowledge Base vector
5755
+ # searches. Implicit filtering allows you to automatically filter search
5756
+ # results based on metadata attributes without requiring explicit filter
5757
+ # expressions in each query.
5758
+ #
5759
+ # @!attribute [rw] metadata_attributes
5760
+ # A list of metadata attribute schemas that define the structure and
5761
+ # properties of metadata fields used for implicit filtering. Each
5762
+ # attribute defines a key, type, and optional description.
5763
+ # @return [Array<Types::MetadataAttributeSchema>]
5764
+ #
5765
+ # @!attribute [rw] model_arn
5766
+ # The Amazon Resource Name (ARN) of the foundation model used for
5767
+ # implicit filtering. This model processes the query to extract
5768
+ # relevant filtering criteria.
5769
+ # @return [String]
5770
+ #
5771
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ImplicitFilterConfiguration AWS API Documentation
5772
+ #
5773
+ class ImplicitFilterConfiguration < Struct.new(
5774
+ :metadata_attributes,
5775
+ :model_arn)
5776
+ SENSITIVE = [:metadata_attributes]
5777
+ include Aws::Structure
5778
+ end
5779
+
5126
5780
  # Information about the imported model.
5127
5781
  #
5128
5782
  # @!attribute [rw] model_arn
@@ -5448,16 +6102,120 @@ module Aws::Bedrock
5448
6102
  # base data sources before returning results.
5449
6103
  # @return [Types::RetrievalFilter]
5450
6104
  #
6105
+ # @!attribute [rw] implicit_filter_configuration
6106
+ # Configuration for implicit filtering in Knowledge Base vector
6107
+ # searches. This allows the system to automatically apply filters
6108
+ # based on the query context without requiring explicit filter
6109
+ # expressions.
6110
+ # @return [Types::ImplicitFilterConfiguration]
6111
+ #
6112
+ # @!attribute [rw] reranking_configuration
6113
+ # Configuration for reranking search results in Knowledge Base vector
6114
+ # searches. Reranking improves search relevance by reordering initial
6115
+ # vector search results using more sophisticated relevance models.
6116
+ # @return [Types::VectorSearchRerankingConfiguration]
6117
+ #
5451
6118
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
5452
6119
  #
5453
6120
  class KnowledgeBaseVectorSearchConfiguration < Struct.new(
5454
6121
  :number_of_results,
5455
6122
  :override_search_type,
5456
- :filter)
6123
+ :filter,
6124
+ :implicit_filter_configuration,
6125
+ :reranking_configuration)
5457
6126
  SENSITIVE = [:filter]
5458
6127
  include Aws::Structure
5459
6128
  end
5460
6129
 
6130
+ # The legal term of the agreement.
6131
+ #
6132
+ # @!attribute [rw] url
6133
+ # URL to the legal term document.
6134
+ # @return [String]
6135
+ #
6136
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/LegalTerm AWS API Documentation
6137
+ #
6138
+ class LegalTerm < Struct.new(
6139
+ :url)
6140
+ SENSITIVE = []
6141
+ include Aws::Structure
6142
+ end
6143
+
6144
+ # @!attribute [rw] created_before
6145
+ # Filters deployments created before the specified date and time.
6146
+ # @return [Time]
6147
+ #
6148
+ # @!attribute [rw] created_after
6149
+ # Filters deployments created after the specified date and time.
6150
+ # @return [Time]
6151
+ #
6152
+ # @!attribute [rw] name_contains
6153
+ # Filters deployments whose names contain the specified string.
6154
+ # @return [String]
6155
+ #
6156
+ # @!attribute [rw] max_results
6157
+ # The maximum number of results to return in a single call.
6158
+ # @return [Integer]
6159
+ #
6160
+ # @!attribute [rw] next_token
6161
+ # The token for the next set of results. Use this token to retrieve
6162
+ # additional results when the response is truncated.
6163
+ # @return [String]
6164
+ #
6165
+ # @!attribute [rw] sort_by
6166
+ # The field to sort the results by. The only supported value is
6167
+ # `CreationTime`.
6168
+ # @return [String]
6169
+ #
6170
+ # @!attribute [rw] sort_order
6171
+ # The sort order for the results. Valid values are `Ascending` and
6172
+ # `Descending`. Default is `Descending`.
6173
+ # @return [String]
6174
+ #
6175
+ # @!attribute [rw] status_equals
6176
+ # Filters deployments by status. Valid values are `CREATING`,
6177
+ # `ACTIVE`, and `FAILED`.
6178
+ # @return [String]
6179
+ #
6180
+ # @!attribute [rw] model_arn_equals
6181
+ # Filters deployments by the Amazon Resource Name (ARN) of the
6182
+ # associated custom model.
6183
+ # @return [String]
6184
+ #
6185
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelDeploymentsRequest AWS API Documentation
6186
+ #
6187
+ class ListCustomModelDeploymentsRequest < Struct.new(
6188
+ :created_before,
6189
+ :created_after,
6190
+ :name_contains,
6191
+ :max_results,
6192
+ :next_token,
6193
+ :sort_by,
6194
+ :sort_order,
6195
+ :status_equals,
6196
+ :model_arn_equals)
6197
+ SENSITIVE = []
6198
+ include Aws::Structure
6199
+ end
6200
+
6201
+ # @!attribute [rw] next_token
6202
+ # The token for the next set of results. This value is null when there
6203
+ # are no more results to return.
6204
+ # @return [String]
6205
+ #
6206
+ # @!attribute [rw] model_deployment_summaries
6207
+ # A list of custom model deployment summaries.
6208
+ # @return [Array<Types::CustomModelDeploymentSummary>]
6209
+ #
6210
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelDeploymentsResponse AWS API Documentation
6211
+ #
6212
+ class ListCustomModelDeploymentsResponse < Struct.new(
6213
+ :next_token,
6214
+ :model_deployment_summaries)
6215
+ SENSITIVE = []
6216
+ include Aws::Structure
6217
+ end
6218
+
5461
6219
  # @!attribute [rw] creation_time_before
5462
6220
  # Return custom models created before the specified time.
5463
6221
  # @return [Time]
@@ -5507,6 +6265,22 @@ module Aws::Bedrock
5507
6265
  # (`true`) or if they were shared with the current account (`false`).
5508
6266
  # @return [Boolean]
5509
6267
  #
6268
+ # @!attribute [rw] model_status
6269
+ # The status of them model to filter results by. Possible values
6270
+ # include:
6271
+ #
6272
+ # * `Creating` - Include only models that are currently being created
6273
+ # and validated.
6274
+ #
6275
+ # * `Active` - Include only models that have been successfully created
6276
+ # and are ready for use.
6277
+ #
6278
+ # * `Failed` - Include only models where the creation process failed.
6279
+ #
6280
+ # If you don't specify a status, the API returns models in all
6281
+ # states.
6282
+ # @return [String]
6283
+ #
5510
6284
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListCustomModelsRequest AWS API Documentation
5511
6285
  #
5512
6286
  class ListCustomModelsRequest < Struct.new(
@@ -5519,7 +6293,8 @@ module Aws::Bedrock
5519
6293
  :next_token,
5520
6294
  :sort_by,
5521
6295
  :sort_order,
5522
- :is_owned)
6296
+ :is_owned,
6297
+ :model_status)
5523
6298
  SENSITIVE = []
5524
6299
  include Aws::Structure
5525
6300
  end
@@ -5621,6 +6396,40 @@ module Aws::Bedrock
5621
6396
  include Aws::Structure
5622
6397
  end
5623
6398
 
6399
+ # @!attribute [rw] model_id
6400
+ # Model Id of the foundation model.
6401
+ # @return [String]
6402
+ #
6403
+ # @!attribute [rw] offer_type
6404
+ # Type of offer associated with the model.
6405
+ # @return [String]
6406
+ #
6407
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffersRequest AWS API Documentation
6408
+ #
6409
+ class ListFoundationModelAgreementOffersRequest < Struct.new(
6410
+ :model_id,
6411
+ :offer_type)
6412
+ SENSITIVE = []
6413
+ include Aws::Structure
6414
+ end
6415
+
6416
+ # @!attribute [rw] model_id
6417
+ # Model Id of the foundation model.
6418
+ # @return [String]
6419
+ #
6420
+ # @!attribute [rw] offers
6421
+ # List of the offers associated with the specified model.
6422
+ # @return [Array<Types::Offer>]
6423
+ #
6424
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ListFoundationModelAgreementOffersResponse AWS API Documentation
6425
+ #
6426
+ class ListFoundationModelAgreementOffersResponse < Struct.new(
6427
+ :model_id,
6428
+ :offers)
6429
+ SENSITIVE = []
6430
+ include Aws::Structure
6431
+ end
6432
+
5624
6433
  # @!attribute [rw] by_provider
5625
6434
  # Return models belonging to the model provider that you specify.
5626
6435
  # @return [String]
@@ -6543,6 +7352,62 @@ module Aws::Bedrock
6543
7352
  include Aws::Structure
6544
7353
  end
6545
7354
 
7355
+ # Defines the schema for a metadata attribute used in Knowledge Base
7356
+ # vector searches. Metadata attributes provide additional context for
7357
+ # documents and can be used for filtering and reranking search results.
7358
+ #
7359
+ # @!attribute [rw] key
7360
+ # The unique identifier for the metadata attribute. This key is used
7361
+ # to reference the attribute in filter expressions and reranking
7362
+ # configurations.
7363
+ # @return [String]
7364
+ #
7365
+ # @!attribute [rw] type
7366
+ # The data type of the metadata attribute. The type determines how the
7367
+ # attribute can be used in filter expressions and reranking.
7368
+ # @return [String]
7369
+ #
7370
+ # @!attribute [rw] description
7371
+ # An optional description of the metadata attribute that provides
7372
+ # additional context about its purpose and usage.
7373
+ # @return [String]
7374
+ #
7375
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/MetadataAttributeSchema AWS API Documentation
7376
+ #
7377
+ class MetadataAttributeSchema < Struct.new(
7378
+ :key,
7379
+ :type,
7380
+ :description)
7381
+ SENSITIVE = []
7382
+ include Aws::Structure
7383
+ end
7384
+
7385
+ # Configuration for how metadata should be used during the reranking
7386
+ # process in Knowledge Base vector searches. This determines which
7387
+ # metadata fields are included or excluded when reordering search
7388
+ # results.
7389
+ #
7390
+ # @!attribute [rw] selection_mode
7391
+ # The mode for selecting which metadata fields to include in the
7392
+ # reranking process. Valid values are ALL (use all available metadata
7393
+ # fields) or SELECTIVE (use only specified fields).
7394
+ # @return [String]
7395
+ #
7396
+ # @!attribute [rw] selective_mode_configuration
7397
+ # Configuration for selective mode, which allows you to explicitly
7398
+ # include or exclude specific metadata fields during reranking. This
7399
+ # is only used when selectionMode is set to SELECTIVE.
7400
+ # @return [Types::RerankingMetadataSelectiveModeConfiguration]
7401
+ #
7402
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/MetadataConfigurationForReranking AWS API Documentation
7403
+ #
7404
+ class MetadataConfigurationForReranking < Struct.new(
7405
+ :selection_mode,
7406
+ :selective_mode_configuration)
7407
+ SENSITIVE = []
7408
+ include Aws::Structure
7409
+ end
7410
+
6546
7411
  # Contains details about each model copy job.
6547
7412
  #
6548
7413
  # This data type is used in the following API operations:
@@ -6638,14 +7503,14 @@ module Aws::Bedrock
6638
7503
  # Status of the customization job.
6639
7504
  # @return [String]
6640
7505
  #
6641
- # @!attribute [rw] last_modified_time
6642
- # Time that the customization job was last modified.
6643
- # @return [Time]
6644
- #
6645
7506
  # @!attribute [rw] status_details
6646
7507
  # Details about the status of the data processing sub-task of the job.
6647
7508
  # @return [Types::StatusDetails]
6648
7509
  #
7510
+ # @!attribute [rw] last_modified_time
7511
+ # Time that the customization job was last modified.
7512
+ # @return [Time]
7513
+ #
6649
7514
  # @!attribute [rw] creation_time
6650
7515
  # Creation time of the custom model.
6651
7516
  # @return [Time]
@@ -6679,8 +7544,8 @@ module Aws::Bedrock
6679
7544
  :base_model_arn,
6680
7545
  :job_name,
6681
7546
  :status,
6682
- :last_modified_time,
6683
7547
  :status_details,
7548
+ :last_modified_time,
6684
7549
  :creation_time,
6685
7550
  :end_time,
6686
7551
  :custom_model_arn,
@@ -6690,14 +7555,14 @@ module Aws::Bedrock
6690
7555
  include Aws::Structure
6691
7556
  end
6692
7557
 
6693
- # Data source for the imported model.
7558
+ # The data source of the model to import.
6694
7559
  #
6695
7560
  # @note ModelDataSource is a union - when making an API calls you must set exactly one of the members.
6696
7561
  #
6697
7562
  # @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
7563
  #
6699
7564
  # @!attribute [rw] s3_data_source
6700
- # The Amazon S3 data source of the imported model.
7565
+ # The Amazon S3 data source of the model to import.
6701
7566
  # @return [Types::S3DataSource]
6702
7567
  #
6703
7568
  # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ModelDataSource AWS API Documentation
@@ -7015,6 +7880,30 @@ module Aws::Bedrock
7015
7880
  include Aws::Structure
7016
7881
  end
7017
7882
 
7883
+ # An offer dictates usage terms for the model.
7884
+ #
7885
+ # @!attribute [rw] offer_id
7886
+ # Offer Id for a model offer.
7887
+ # @return [String]
7888
+ #
7889
+ # @!attribute [rw] offer_token
7890
+ # Offer token.
7891
+ # @return [String]
7892
+ #
7893
+ # @!attribute [rw] term_details
7894
+ # Details about the terms of the offer.
7895
+ # @return [Types::TermDetails]
7896
+ #
7897
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/Offer AWS API Documentation
7898
+ #
7899
+ class Offer < Struct.new(
7900
+ :offer_id,
7901
+ :offer_token,
7902
+ :term_details)
7903
+ SENSITIVE = []
7904
+ include Aws::Structure
7905
+ end
7906
+
7018
7907
  # The configuration details for the model to process the prompt prior to
7019
7908
  # retrieval and response generation.
7020
7909
  #
@@ -7059,6 +7948,20 @@ module Aws::Bedrock
7059
7948
  include Aws::Structure
7060
7949
  end
7061
7950
 
7951
+ # Describes the usage-based pricing term.
7952
+ #
7953
+ # @!attribute [rw] rate_card
7954
+ # Describes a usage price for each dimension.
7955
+ # @return [Array<Types::DimensionalPriceRate>]
7956
+ #
7957
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PricingTerm AWS API Documentation
7958
+ #
7959
+ class PricingTerm < Struct.new(
7960
+ :rate_card)
7961
+ SENSITIVE = []
7962
+ include Aws::Structure
7963
+ end
7964
+
7062
7965
  # Details about a prompt router.
7063
7966
  #
7064
7967
  # @!attribute [rw] prompt_router_name
@@ -7262,6 +8165,22 @@ module Aws::Bedrock
7262
8165
  #
7263
8166
  class PutModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
7264
8167
 
8168
+ # @!attribute [rw] form_data
8169
+ # Put customer profile Request.
8170
+ # @return [String]
8171
+ #
8172
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccessRequest AWS API Documentation
8173
+ #
8174
+ class PutUseCaseForModelAccessRequest < Struct.new(
8175
+ :form_data)
8176
+ SENSITIVE = []
8177
+ include Aws::Structure
8178
+ end
8179
+
8180
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/PutUseCaseForModelAccessResponse AWS API Documentation
8181
+ #
8182
+ class PutUseCaseForModelAccessResponse < Aws::EmptyStructure; end
8183
+
7265
8184
  # The configuration details for transforming the prompt.
7266
8185
  #
7267
8186
  # @!attribute [rw] type
@@ -7455,6 +8374,43 @@ module Aws::Bedrock
7455
8374
  class Unknown < RequestMetadataFilters; end
7456
8375
  end
7457
8376
 
8377
+ # Configuration for selectively including or excluding metadata fields
8378
+ # during the reranking process. This allows you to control which
8379
+ # metadata attributes are considered when reordering search results.
8380
+ #
8381
+ # @note RerankingMetadataSelectiveModeConfiguration is a union - when making an API calls you must set exactly one of the members.
8382
+ #
8383
+ # @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.
8384
+ #
8385
+ # @!attribute [rw] fields_to_include
8386
+ # A list of metadata field names to explicitly include in the
8387
+ # reranking process. Only these fields will be considered when
8388
+ # reordering search results. This parameter cannot be used together
8389
+ # with fieldsToExclude.
8390
+ # @return [Array<Types::FieldForReranking>]
8391
+ #
8392
+ # @!attribute [rw] fields_to_exclude
8393
+ # A list of metadata field names to explicitly exclude from the
8394
+ # reranking process. All metadata fields except these will be
8395
+ # considered when reordering search results. This parameter cannot be
8396
+ # used together with fieldsToInclude.
8397
+ # @return [Array<Types::FieldForReranking>]
8398
+ #
8399
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/RerankingMetadataSelectiveModeConfiguration AWS API Documentation
8400
+ #
8401
+ class RerankingMetadataSelectiveModeConfiguration < Struct.new(
8402
+ :fields_to_include,
8403
+ :fields_to_exclude,
8404
+ :unknown)
8405
+ SENSITIVE = [:fields_to_include, :fields_to_exclude]
8406
+ include Aws::Structure
8407
+ include Aws::Structure::Union
8408
+
8409
+ class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
8410
+ class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
8411
+ class Unknown < RerankingMetadataSelectiveModeConfiguration; end
8412
+ end
8413
+
7458
8414
  # The specified resource Amazon Resource Name (ARN) was not found. Check
7459
8415
  # the Amazon Resource Name (ARN) and try your request again.
7460
8416
  #
@@ -7727,7 +8683,7 @@ module Aws::Bedrock
7727
8683
  include Aws::Structure
7728
8684
  end
7729
8685
 
7730
- # The Amazon S3 data source of the imported job.
8686
+ # The Amazon S3 data source of the model to import.
7731
8687
  #
7732
8688
  # @!attribute [rw] s3_uri
7733
8689
  # The URI of the Amazon S3 data source.
@@ -7908,6 +8864,20 @@ module Aws::Bedrock
7908
8864
  #
7909
8865
  class StopModelInvocationJobResponse < Aws::EmptyStructure; end
7910
8866
 
8867
+ # Describes a support term.
8868
+ #
8869
+ # @!attribute [rw] refund_policy_description
8870
+ # Describes the refund policy.
8871
+ # @return [String]
8872
+ #
8873
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/SupportTerm AWS API Documentation
8874
+ #
8875
+ class SupportTerm < Struct.new(
8876
+ :refund_policy_description)
8877
+ SENSITIVE = []
8878
+ include Aws::Structure
8879
+ end
8880
+
7911
8881
  # Definition of the key/value pair for a tag.
7912
8882
  #
7913
8883
  # @!attribute [rw] key
@@ -7968,6 +8938,35 @@ module Aws::Bedrock
7968
8938
  include Aws::Structure
7969
8939
  end
7970
8940
 
8941
+ # Describes the usage terms of an offer.
8942
+ #
8943
+ # @!attribute [rw] usage_based_pricing_term
8944
+ # Describes the usage-based pricing term.
8945
+ # @return [Types::PricingTerm]
8946
+ #
8947
+ # @!attribute [rw] legal_term
8948
+ # Describes the legal terms.
8949
+ # @return [Types::LegalTerm]
8950
+ #
8951
+ # @!attribute [rw] support_term
8952
+ # Describes the support terms.
8953
+ # @return [Types::SupportTerm]
8954
+ #
8955
+ # @!attribute [rw] validity_term
8956
+ # Describes the validity terms.
8957
+ # @return [Types::ValidityTerm]
8958
+ #
8959
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/TermDetails AWS API Documentation
8960
+ #
8961
+ class TermDetails < Struct.new(
8962
+ :usage_based_pricing_term,
8963
+ :legal_term,
8964
+ :support_term,
8965
+ :validity_term)
8966
+ SENSITIVE = []
8967
+ include Aws::Structure
8968
+ end
8969
+
7971
8970
  # The configuration details for text generation using a language model
7972
8971
  # via the `RetrieveAndGenerate` function.
7973
8972
  #
@@ -8390,6 +9389,104 @@ module Aws::Bedrock
8390
9389
  include Aws::Structure
8391
9390
  end
8392
9391
 
9392
+ # Describes the validity terms.
9393
+ #
9394
+ # @!attribute [rw] agreement_duration
9395
+ # Describes the agreement duration.
9396
+ # @return [String]
9397
+ #
9398
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/ValidityTerm AWS API Documentation
9399
+ #
9400
+ class ValidityTerm < Struct.new(
9401
+ :agreement_duration)
9402
+ SENSITIVE = []
9403
+ include Aws::Structure
9404
+ end
9405
+
9406
+ # Configuration for using Amazon Bedrock foundation models to rerank
9407
+ # Knowledge Base vector search results. This enables more sophisticated
9408
+ # relevance ranking using large language models.
9409
+ #
9410
+ # @!attribute [rw] model_configuration
9411
+ # Configuration for the Amazon Bedrock foundation model used for
9412
+ # reranking. This includes the model ARN and any additional request
9413
+ # fields required by the model.
9414
+ # @return [Types::VectorSearchBedrockRerankingModelConfiguration]
9415
+ #
9416
+ # @!attribute [rw] number_of_reranked_results
9417
+ # The maximum number of results to rerank. This limits how many of the
9418
+ # initial vector search results will be processed by the reranking
9419
+ # model. A smaller number improves performance but may exclude
9420
+ # potentially relevant results.
9421
+ # @return [Integer]
9422
+ #
9423
+ # @!attribute [rw] metadata_configuration
9424
+ # Configuration for how document metadata should be used during the
9425
+ # reranking process. This determines which metadata fields are
9426
+ # included when reordering search results.
9427
+ # @return [Types::MetadataConfigurationForReranking]
9428
+ #
9429
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchBedrockRerankingConfiguration AWS API Documentation
9430
+ #
9431
+ class VectorSearchBedrockRerankingConfiguration < Struct.new(
9432
+ :model_configuration,
9433
+ :number_of_reranked_results,
9434
+ :metadata_configuration)
9435
+ SENSITIVE = []
9436
+ include Aws::Structure
9437
+ end
9438
+
9439
+ # Configuration for the Amazon Bedrock foundation model used for
9440
+ # reranking vector search results. This specifies which model to use and
9441
+ # any additional parameters required by the model.
9442
+ #
9443
+ # @!attribute [rw] model_arn
9444
+ # The Amazon Resource Name (ARN) of the foundation model to use for
9445
+ # reranking. This model processes the query and search results to
9446
+ # determine a more relevant ordering.
9447
+ # @return [String]
9448
+ #
9449
+ # @!attribute [rw] additional_model_request_fields
9450
+ # A list of additional fields to include in the model request during
9451
+ # reranking. These fields provide extra context or configuration
9452
+ # options specific to the selected foundation model.
9453
+ # @return [Hash<String,Hash,Array,String,Numeric,Boolean>]
9454
+ #
9455
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchBedrockRerankingModelConfiguration AWS API Documentation
9456
+ #
9457
+ class VectorSearchBedrockRerankingModelConfiguration < Struct.new(
9458
+ :model_arn,
9459
+ :additional_model_request_fields)
9460
+ SENSITIVE = []
9461
+ include Aws::Structure
9462
+ end
9463
+
9464
+ # Configuration for reranking vector search results to improve
9465
+ # relevance. Reranking applies additional relevance models to reorder
9466
+ # the initial vector search results based on more sophisticated
9467
+ # criteria.
9468
+ #
9469
+ # @!attribute [rw] type
9470
+ # The type of reranking to apply to vector search results. Currently,
9471
+ # the only supported value is BEDROCK, which uses Amazon Bedrock
9472
+ # foundation models for reranking.
9473
+ # @return [String]
9474
+ #
9475
+ # @!attribute [rw] bedrock_reranking_configuration
9476
+ # Configuration for using Amazon Bedrock foundation models to rerank
9477
+ # search results. This is required when the reranking type is set to
9478
+ # BEDROCK.
9479
+ # @return [Types::VectorSearchBedrockRerankingConfiguration]
9480
+ #
9481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/VectorSearchRerankingConfiguration AWS API Documentation
9482
+ #
9483
+ class VectorSearchRerankingConfiguration < Struct.new(
9484
+ :type,
9485
+ :bedrock_reranking_configuration)
9486
+ SENSITIVE = []
9487
+ include Aws::Structure
9488
+ end
9489
+
8393
9490
  # The configuration of a virtual private cloud (VPC). For more
8394
9491
  # information, see [Protect your data using Amazon Virtual Private Cloud
8395
9492
  # and Amazon Web Services PrivateLink][1].