aws-sdk-bedrock 1.51.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrock/client.rb +281 -1
- data/lib/aws-sdk-bedrock/client_api.rb +247 -1
- data/lib/aws-sdk-bedrock/types.rb +551 -1
- data/lib/aws-sdk-bedrock.rb +1 -1
- data/sig/client.rbs +136 -0
- data/sig/types.rbs +169 -0
- metadata +1 -1
@@ -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.
|
@@ -456,6 +475,35 @@ module Aws::Bedrock
|
|
456
475
|
include Aws::Structure
|
457
476
|
end
|
458
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
|
+
|
459
507
|
# @!attribute [rw] name
|
460
508
|
# The name to give the guardrail.
|
461
509
|
# @return [String]
|
@@ -1511,6 +1559,22 @@ module Aws::Bedrock
|
|
1511
1559
|
#
|
1512
1560
|
class DeleteCustomModelResponse < Aws::EmptyStructure; end
|
1513
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
|
+
|
1514
1578
|
# @!attribute [rw] guardrail_identifier
|
1515
1579
|
# The unique identifier of the guardrail. This can be an ID or the
|
1516
1580
|
# ARN.
|
@@ -1642,6 +1706,35 @@ module Aws::Bedrock
|
|
1642
1706
|
#
|
1643
1707
|
class DeregisterMarketplaceModelEndpointResponse < Aws::EmptyStructure; end
|
1644
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
|
+
|
1645
1738
|
# Settings for distilling a foundation model into a smaller and more
|
1646
1739
|
# efficient model.
|
1647
1740
|
#
|
@@ -2294,6 +2387,24 @@ module Aws::Bedrock
|
|
2294
2387
|
include Aws::Structure
|
2295
2388
|
end
|
2296
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
|
+
|
2297
2408
|
# Specifies the name of the metadata attribute/field to apply filters.
|
2298
2409
|
# You must match the name of the attribute/field in your data
|
2299
2410
|
# source/document metadata.
|
@@ -2708,6 +2819,50 @@ module Aws::Bedrock
|
|
2708
2819
|
include Aws::Structure
|
2709
2820
|
end
|
2710
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
|
+
|
2711
2866
|
# @!attribute [rw] model_identifier
|
2712
2867
|
# The model identifier.
|
2713
2868
|
# @return [String]
|
@@ -3687,6 +3842,24 @@ module Aws::Bedrock
|
|
3687
3842
|
include Aws::Structure
|
3688
3843
|
end
|
3689
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
|
+
|
3690
3863
|
# The configuration details for the guardrail.
|
3691
3864
|
#
|
3692
3865
|
# @!attribute [rw] guardrail_id
|
@@ -5380,6 +5553,32 @@ module Aws::Bedrock
|
|
5380
5553
|
include Aws::Structure
|
5381
5554
|
end
|
5382
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
|
+
|
5383
5582
|
# Information about the imported model.
|
5384
5583
|
#
|
5385
5584
|
# @!attribute [rw] model_arn
|
@@ -5705,16 +5904,45 @@ module Aws::Bedrock
|
|
5705
5904
|
# base data sources before returning results.
|
5706
5905
|
# @return [Types::RetrievalFilter]
|
5707
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
|
+
#
|
5708
5920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
|
5709
5921
|
#
|
5710
5922
|
class KnowledgeBaseVectorSearchConfiguration < Struct.new(
|
5711
5923
|
:number_of_results,
|
5712
5924
|
:override_search_type,
|
5713
|
-
:filter
|
5925
|
+
:filter,
|
5926
|
+
:implicit_filter_configuration,
|
5927
|
+
:reranking_configuration)
|
5714
5928
|
SENSITIVE = [:filter]
|
5715
5929
|
include Aws::Structure
|
5716
5930
|
end
|
5717
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
|
+
|
5718
5946
|
# @!attribute [rw] creation_time_before
|
5719
5947
|
# Return custom models created before the specified time.
|
5720
5948
|
# @return [Time]
|
@@ -5895,6 +6123,40 @@ module Aws::Bedrock
|
|
5895
6123
|
include Aws::Structure
|
5896
6124
|
end
|
5897
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
|
+
|
5898
6160
|
# @!attribute [rw] by_provider
|
5899
6161
|
# Return models belonging to the model provider that you specify.
|
5900
6162
|
# @return [String]
|
@@ -6817,6 +7079,62 @@ module Aws::Bedrock
|
|
6817
7079
|
include Aws::Structure
|
6818
7080
|
end
|
6819
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
|
+
|
6820
7138
|
# Contains details about each model copy job.
|
6821
7139
|
#
|
6822
7140
|
# This data type is used in the following API operations:
|
@@ -7289,6 +7607,30 @@ module Aws::Bedrock
|
|
7289
7607
|
include Aws::Structure
|
7290
7608
|
end
|
7291
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
|
+
|
7292
7634
|
# The configuration details for the model to process the prompt prior to
|
7293
7635
|
# retrieval and response generation.
|
7294
7636
|
#
|
@@ -7333,6 +7675,20 @@ module Aws::Bedrock
|
|
7333
7675
|
include Aws::Structure
|
7334
7676
|
end
|
7335
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
|
+
|
7336
7692
|
# Details about a prompt router.
|
7337
7693
|
#
|
7338
7694
|
# @!attribute [rw] prompt_router_name
|
@@ -7536,6 +7892,22 @@ module Aws::Bedrock
|
|
7536
7892
|
#
|
7537
7893
|
class PutModelInvocationLoggingConfigurationResponse < Aws::EmptyStructure; end
|
7538
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
|
+
|
7539
7911
|
# The configuration details for transforming the prompt.
|
7540
7912
|
#
|
7541
7913
|
# @!attribute [rw] type
|
@@ -7729,6 +8101,43 @@ module Aws::Bedrock
|
|
7729
8101
|
class Unknown < RequestMetadataFilters; end
|
7730
8102
|
end
|
7731
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
|
+
|
7732
8141
|
# The specified resource Amazon Resource Name (ARN) was not found. Check
|
7733
8142
|
# the Amazon Resource Name (ARN) and try your request again.
|
7734
8143
|
#
|
@@ -8182,6 +8591,20 @@ module Aws::Bedrock
|
|
8182
8591
|
#
|
8183
8592
|
class StopModelInvocationJobResponse < Aws::EmptyStructure; end
|
8184
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
|
+
|
8185
8608
|
# Definition of the key/value pair for a tag.
|
8186
8609
|
#
|
8187
8610
|
# @!attribute [rw] key
|
@@ -8242,6 +8665,35 @@ module Aws::Bedrock
|
|
8242
8665
|
include Aws::Structure
|
8243
8666
|
end
|
8244
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
|
+
|
8245
8697
|
# The configuration details for text generation using a language model
|
8246
8698
|
# via the `RetrieveAndGenerate` function.
|
8247
8699
|
#
|
@@ -8664,6 +9116,104 @@ module Aws::Bedrock
|
|
8664
9116
|
include Aws::Structure
|
8665
9117
|
end
|
8666
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
|
+
|
8667
9217
|
# The configuration of a virtual private cloud (VPC). For more
|
8668
9218
|
# information, see [Protect your data using Amazon Virtual Private Cloud
|
8669
9219
|
# and Amazon Web Services PrivateLink][1].
|