aws-sdk-bedrock 1.52.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-bedrock/client.rb +105 -1
- data/lib/aws-sdk-bedrock/client_api.rb +62 -1
- data/lib/aws-sdk-bedrock/types.rb +237 -1
- data/lib/aws-sdk-bedrock.rb +1 -1
- data/sig/client.rbs +72 -0
- data/sig/types.rbs +59 -0
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: d949463ffa3761ba4c843b884658ce2833c3f0ceaaeeb4d99a952bb15a866635
|
4
|
+
data.tar.gz: 795c2cc017319a18581c041f81db7f4ba041bd1345071baebd022aa2c58fac0d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: cd4c231fd4c2b626085a79708ab2d16e2b08c55f805c8fef2383be0b6926492a5d6d8a0657bb1a5b65ccf199c913321ccc0567ec48263317f0ff457f0a908257
|
7
|
+
data.tar.gz: '0875fe8ddbd14c58019cc256e67369ef0d7584c72a587c85e3f4ea5a50bf912bc309189ec1f85ec0f3de5ad4ef038f3b7ffecfdcceee7cca78a16692e791791c'
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.53.0
|
@@ -944,6 +944,44 @@ module Aws::Bedrock
|
|
944
944
|
# },
|
945
945
|
# ],
|
946
946
|
# },
|
947
|
+
# implicit_filter_configuration: {
|
948
|
+
# metadata_attributes: [ # required
|
949
|
+
# {
|
950
|
+
# key: "MetadataAttributeSchemaKeyString", # required
|
951
|
+
# type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
|
952
|
+
# description: "MetadataAttributeSchemaDescriptionString", # required
|
953
|
+
# },
|
954
|
+
# ],
|
955
|
+
# model_arn: "BedrockModelArn", # required
|
956
|
+
# },
|
957
|
+
# reranking_configuration: {
|
958
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
959
|
+
# bedrock_reranking_configuration: {
|
960
|
+
# model_configuration: { # required
|
961
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
962
|
+
# additional_model_request_fields: {
|
963
|
+
# "AdditionalModelRequestFieldsKey" => {
|
964
|
+
# },
|
965
|
+
# },
|
966
|
+
# },
|
967
|
+
# number_of_reranked_results: 1,
|
968
|
+
# metadata_configuration: {
|
969
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
970
|
+
# selective_mode_configuration: {
|
971
|
+
# fields_to_include: [
|
972
|
+
# {
|
973
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
974
|
+
# },
|
975
|
+
# ],
|
976
|
+
# fields_to_exclude: [
|
977
|
+
# {
|
978
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
979
|
+
# },
|
980
|
+
# ],
|
981
|
+
# },
|
982
|
+
# },
|
983
|
+
# },
|
984
|
+
# },
|
947
985
|
# },
|
948
986
|
# },
|
949
987
|
# },
|
@@ -1023,6 +1061,44 @@ module Aws::Bedrock
|
|
1023
1061
|
# },
|
1024
1062
|
# ],
|
1025
1063
|
# },
|
1064
|
+
# implicit_filter_configuration: {
|
1065
|
+
# metadata_attributes: [ # required
|
1066
|
+
# {
|
1067
|
+
# key: "MetadataAttributeSchemaKeyString", # required
|
1068
|
+
# type: "STRING", # required, accepts STRING, NUMBER, BOOLEAN, STRING_LIST
|
1069
|
+
# description: "MetadataAttributeSchemaDescriptionString", # required
|
1070
|
+
# },
|
1071
|
+
# ],
|
1072
|
+
# model_arn: "BedrockModelArn", # required
|
1073
|
+
# },
|
1074
|
+
# reranking_configuration: {
|
1075
|
+
# type: "BEDROCK_RERANKING_MODEL", # required, accepts BEDROCK_RERANKING_MODEL
|
1076
|
+
# bedrock_reranking_configuration: {
|
1077
|
+
# model_configuration: { # required
|
1078
|
+
# model_arn: "BedrockRerankingModelArn", # required
|
1079
|
+
# additional_model_request_fields: {
|
1080
|
+
# "AdditionalModelRequestFieldsKey" => {
|
1081
|
+
# },
|
1082
|
+
# },
|
1083
|
+
# },
|
1084
|
+
# number_of_reranked_results: 1,
|
1085
|
+
# metadata_configuration: {
|
1086
|
+
# selection_mode: "SELECTIVE", # required, accepts SELECTIVE, ALL
|
1087
|
+
# selective_mode_configuration: {
|
1088
|
+
# fields_to_include: [
|
1089
|
+
# {
|
1090
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
1091
|
+
# },
|
1092
|
+
# ],
|
1093
|
+
# fields_to_exclude: [
|
1094
|
+
# {
|
1095
|
+
# field_name: "FieldForRerankingFieldNameString", # required
|
1096
|
+
# },
|
1097
|
+
# ],
|
1098
|
+
# },
|
1099
|
+
# },
|
1100
|
+
# },
|
1101
|
+
# },
|
1026
1102
|
# },
|
1027
1103
|
# },
|
1028
1104
|
# generation_configuration: {
|
@@ -2705,6 +2781,20 @@ module Aws::Bedrock
|
|
2705
2781
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.filter.and_all[0] #=> Types::RetrievalFilter
|
2706
2782
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.filter.or_all #=> Array
|
2707
2783
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.filter.or_all[0] #=> Types::RetrievalFilter
|
2784
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes #=> Array
|
2785
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].key #=> String
|
2786
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].type #=> String, one of "STRING", "NUMBER", "BOOLEAN", "STRING_LIST"
|
2787
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].description #=> String
|
2788
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.implicit_filter_configuration.model_arn #=> String
|
2789
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.type #=> String, one of "BEDROCK_RERANKING_MODEL"
|
2790
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.model_configuration.model_arn #=> String
|
2791
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.model_configuration.additional_model_request_fields #=> Hash
|
2792
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.number_of_reranked_results #=> Integer
|
2793
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selection_mode #=> String, one of "SELECTIVE", "ALL"
|
2794
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_include #=> Array
|
2795
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_include[0].field_name #=> String
|
2796
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_exclude #=> Array
|
2797
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_config.knowledge_base_retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_exclude[0].field_name #=> String
|
2708
2798
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.type #=> String, one of "KNOWLEDGE_BASE", "EXTERNAL_SOURCES"
|
2709
2799
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.knowledge_base_id #=> String
|
2710
2800
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.model_arn #=> String
|
@@ -2725,6 +2815,20 @@ module Aws::Bedrock
|
|
2725
2815
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.filter.and_all[0] #=> Types::RetrievalFilter
|
2726
2816
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.filter.or_all #=> Array
|
2727
2817
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.filter.or_all[0] #=> Types::RetrievalFilter
|
2818
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes #=> Array
|
2819
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].key #=> String
|
2820
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].type #=> String, one of "STRING", "NUMBER", "BOOLEAN", "STRING_LIST"
|
2821
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.metadata_attributes[0].description #=> String
|
2822
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.implicit_filter_configuration.model_arn #=> String
|
2823
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.type #=> String, one of "BEDROCK_RERANKING_MODEL"
|
2824
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.model_configuration.model_arn #=> String
|
2825
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.model_configuration.additional_model_request_fields #=> Hash
|
2826
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.number_of_reranked_results #=> Integer
|
2827
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selection_mode #=> String, one of "SELECTIVE", "ALL"
|
2828
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_include #=> Array
|
2829
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_include[0].field_name #=> String
|
2830
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_exclude #=> Array
|
2831
|
+
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.retrieval_configuration.vector_search_configuration.reranking_configuration.bedrock_reranking_configuration.metadata_configuration.selective_mode_configuration.fields_to_exclude[0].field_name #=> String
|
2728
2832
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.generation_configuration.prompt_template.text_prompt_template #=> String
|
2729
2833
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.generation_configuration.guardrail_configuration.guardrail_id #=> String
|
2730
2834
|
# resp.inference_config.rag_configs[0].knowledge_base_config.retrieve_and_generate_config.knowledge_base_configuration.generation_configuration.guardrail_configuration.guardrail_version #=> String
|
@@ -5355,7 +5459,7 @@ module Aws::Bedrock
|
|
5355
5459
|
tracer: tracer
|
5356
5460
|
)
|
5357
5461
|
context[:gem_name] = 'aws-sdk-bedrock'
|
5358
|
-
context[:gem_version] = '1.
|
5462
|
+
context[:gem_version] = '1.53.0'
|
5359
5463
|
Seahorse::Client::Request.new(handlers, context)
|
5360
5464
|
end
|
5361
5465
|
|
@@ -25,6 +25,7 @@ module Aws::Bedrock
|
|
25
25
|
AgreementStatus = Shapes::StringShape.new(name: 'AgreementStatus')
|
26
26
|
ApplicationType = Shapes::StringShape.new(name: 'ApplicationType')
|
27
27
|
Arn = Shapes::StringShape.new(name: 'Arn')
|
28
|
+
AttributeType = Shapes::StringShape.new(name: 'AttributeType')
|
28
29
|
AuthorizationStatus = Shapes::StringShape.new(name: 'AuthorizationStatus')
|
29
30
|
AutomatedEvaluationConfig = Shapes::StructureShape.new(name: 'AutomatedEvaluationConfig')
|
30
31
|
AutomatedEvaluationCustomMetricConfig = Shapes::StructureShape.new(name: 'AutomatedEvaluationCustomMetricConfig')
|
@@ -41,6 +42,7 @@ module Aws::Bedrock
|
|
41
42
|
BedrockEvaluatorModels = Shapes::ListShape.new(name: 'BedrockEvaluatorModels')
|
42
43
|
BedrockModelArn = Shapes::StringShape.new(name: 'BedrockModelArn')
|
43
44
|
BedrockModelId = Shapes::StringShape.new(name: 'BedrockModelId')
|
45
|
+
BedrockRerankingModelArn = Shapes::StringShape.new(name: 'BedrockRerankingModelArn')
|
44
46
|
Boolean = Shapes::BooleanShape.new(name: 'Boolean')
|
45
47
|
BrandedName = Shapes::StringShape.new(name: 'BrandedName')
|
46
48
|
BucketName = Shapes::StringShape.new(name: 'BucketName')
|
@@ -166,6 +168,9 @@ module Aws::Bedrock
|
|
166
168
|
ExternalSources = Shapes::ListShape.new(name: 'ExternalSources')
|
167
169
|
ExternalSourcesGenerationConfiguration = Shapes::StructureShape.new(name: 'ExternalSourcesGenerationConfiguration')
|
168
170
|
ExternalSourcesRetrieveAndGenerateConfiguration = Shapes::StructureShape.new(name: 'ExternalSourcesRetrieveAndGenerateConfiguration')
|
171
|
+
FieldForReranking = Shapes::StructureShape.new(name: 'FieldForReranking')
|
172
|
+
FieldForRerankingFieldNameString = Shapes::StringShape.new(name: 'FieldForRerankingFieldNameString')
|
173
|
+
FieldsForReranking = Shapes::ListShape.new(name: 'FieldsForReranking')
|
169
174
|
FilterAttribute = Shapes::StructureShape.new(name: 'FilterAttribute')
|
170
175
|
FilterKey = Shapes::StringShape.new(name: 'FilterKey')
|
171
176
|
FilterValue = Shapes::DocumentShape.new(name: 'FilterValue', document: true)
|
@@ -312,6 +317,7 @@ module Aws::Bedrock
|
|
312
317
|
HumanWorkflowConfig = Shapes::StructureShape.new(name: 'HumanWorkflowConfig')
|
313
318
|
IdempotencyToken = Shapes::StringShape.new(name: 'IdempotencyToken')
|
314
319
|
Identifier = Shapes::StringShape.new(name: 'Identifier')
|
320
|
+
ImplicitFilterConfiguration = Shapes::StructureShape.new(name: 'ImplicitFilterConfiguration')
|
315
321
|
ImportedModelArn = Shapes::StringShape.new(name: 'ImportedModelArn')
|
316
322
|
ImportedModelIdentifier = Shapes::StringShape.new(name: 'ImportedModelIdentifier')
|
317
323
|
ImportedModelName = Shapes::StringShape.new(name: 'ImportedModelName')
|
@@ -390,6 +396,11 @@ module Aws::Bedrock
|
|
390
396
|
MaxResults = Shapes::IntegerShape.new(name: 'MaxResults')
|
391
397
|
MaxTokens = Shapes::IntegerShape.new(name: 'MaxTokens')
|
392
398
|
Message = Shapes::StringShape.new(name: 'Message')
|
399
|
+
MetadataAttributeSchema = Shapes::StructureShape.new(name: 'MetadataAttributeSchema')
|
400
|
+
MetadataAttributeSchemaDescriptionString = Shapes::StringShape.new(name: 'MetadataAttributeSchemaDescriptionString')
|
401
|
+
MetadataAttributeSchemaKeyString = Shapes::StringShape.new(name: 'MetadataAttributeSchemaKeyString')
|
402
|
+
MetadataAttributeSchemaList = Shapes::ListShape.new(name: 'MetadataAttributeSchemaList')
|
403
|
+
MetadataConfigurationForReranking = Shapes::StructureShape.new(name: 'MetadataConfigurationForReranking')
|
393
404
|
MetricFloat = Shapes::FloatShape.new(name: 'MetricFloat')
|
394
405
|
MetricName = Shapes::StringShape.new(name: 'MetricName')
|
395
406
|
ModelArchitecture = Shapes::StringShape.new(name: 'ModelArchitecture')
|
@@ -487,6 +498,8 @@ module Aws::Bedrock
|
|
487
498
|
RequestMetadataMap = Shapes::MapShape.new(name: 'RequestMetadataMap')
|
488
499
|
RequestMetadataMapKeyString = Shapes::StringShape.new(name: 'RequestMetadataMapKeyString')
|
489
500
|
RequestMetadataMapValueString = Shapes::StringShape.new(name: 'RequestMetadataMapValueString')
|
501
|
+
RerankingMetadataSelectionMode = Shapes::StringShape.new(name: 'RerankingMetadataSelectionMode')
|
502
|
+
RerankingMetadataSelectiveModeConfiguration = Shapes::UnionShape.new(name: 'RerankingMetadataSelectiveModeConfiguration')
|
490
503
|
ResourceNotFoundException = Shapes::StructureShape.new(name: 'ResourceNotFoundException')
|
491
504
|
RetrievalFilter = Shapes::UnionShape.new(name: 'RetrievalFilter')
|
492
505
|
RetrievalFilterList = Shapes::ListShape.new(name: 'RetrievalFilterList')
|
@@ -562,6 +575,11 @@ module Aws::Bedrock
|
|
562
575
|
ValidatorMetric = Shapes::StructureShape.new(name: 'ValidatorMetric')
|
563
576
|
Validators = Shapes::ListShape.new(name: 'Validators')
|
564
577
|
ValidityTerm = Shapes::StructureShape.new(name: 'ValidityTerm')
|
578
|
+
VectorSearchBedrockRerankingConfiguration = Shapes::StructureShape.new(name: 'VectorSearchBedrockRerankingConfiguration')
|
579
|
+
VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger = Shapes::IntegerShape.new(name: 'VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger')
|
580
|
+
VectorSearchBedrockRerankingModelConfiguration = Shapes::StructureShape.new(name: 'VectorSearchBedrockRerankingModelConfiguration')
|
581
|
+
VectorSearchRerankingConfiguration = Shapes::StructureShape.new(name: 'VectorSearchRerankingConfiguration')
|
582
|
+
VectorSearchRerankingConfigurationType = Shapes::StringShape.new(name: 'VectorSearchRerankingConfigurationType')
|
565
583
|
VpcConfig = Shapes::StructureShape.new(name: 'VpcConfig')
|
566
584
|
kBS3Uri = Shapes::StringShape.new(name: 'kBS3Uri')
|
567
585
|
|
@@ -1039,6 +1057,11 @@ module Aws::Bedrock
|
|
1039
1057
|
ExternalSourcesRetrieveAndGenerateConfiguration.add_member(:generation_configuration, Shapes::ShapeRef.new(shape: ExternalSourcesGenerationConfiguration, location_name: "generationConfiguration"))
|
1040
1058
|
ExternalSourcesRetrieveAndGenerateConfiguration.struct_class = Types::ExternalSourcesRetrieveAndGenerateConfiguration
|
1041
1059
|
|
1060
|
+
FieldForReranking.add_member(:field_name, Shapes::ShapeRef.new(shape: FieldForRerankingFieldNameString, required: true, location_name: "fieldName"))
|
1061
|
+
FieldForReranking.struct_class = Types::FieldForReranking
|
1062
|
+
|
1063
|
+
FieldsForReranking.member = Shapes::ShapeRef.new(shape: FieldForReranking)
|
1064
|
+
|
1042
1065
|
FilterAttribute.add_member(:key, Shapes::ShapeRef.new(shape: FilterKey, required: true, location_name: "key"))
|
1043
1066
|
FilterAttribute.add_member(:value, Shapes::ShapeRef.new(shape: FilterValue, required: true, location_name: "value"))
|
1044
1067
|
FilterAttribute.struct_class = Types::FilterAttribute
|
@@ -1564,6 +1587,10 @@ module Aws::Bedrock
|
|
1564
1587
|
HumanWorkflowConfig.add_member(:instructions, Shapes::ShapeRef.new(shape: HumanTaskInstructions, location_name: "instructions"))
|
1565
1588
|
HumanWorkflowConfig.struct_class = Types::HumanWorkflowConfig
|
1566
1589
|
|
1590
|
+
ImplicitFilterConfiguration.add_member(:metadata_attributes, Shapes::ShapeRef.new(shape: MetadataAttributeSchemaList, required: true, location_name: "metadataAttributes"))
|
1591
|
+
ImplicitFilterConfiguration.add_member(:model_arn, Shapes::ShapeRef.new(shape: BedrockModelArn, required: true, location_name: "modelArn"))
|
1592
|
+
ImplicitFilterConfiguration.struct_class = Types::ImplicitFilterConfiguration
|
1593
|
+
|
1567
1594
|
ImportedModelSummary.add_member(:model_arn, Shapes::ShapeRef.new(shape: ImportedModelArn, required: true, location_name: "modelArn"))
|
1568
1595
|
ImportedModelSummary.add_member(:model_name, Shapes::ShapeRef.new(shape: ImportedModelName, required: true, location_name: "modelName"))
|
1569
1596
|
ImportedModelSummary.add_member(:creation_time, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "creationTime"))
|
@@ -1637,6 +1664,8 @@ module Aws::Bedrock
|
|
1637
1664
|
KnowledgeBaseVectorSearchConfiguration.add_member(:number_of_results, Shapes::ShapeRef.new(shape: KnowledgeBaseVectorSearchConfigurationNumberOfResultsInteger, location_name: "numberOfResults"))
|
1638
1665
|
KnowledgeBaseVectorSearchConfiguration.add_member(:override_search_type, Shapes::ShapeRef.new(shape: SearchType, location_name: "overrideSearchType"))
|
1639
1666
|
KnowledgeBaseVectorSearchConfiguration.add_member(:filter, Shapes::ShapeRef.new(shape: RetrievalFilter, location_name: "filter"))
|
1667
|
+
KnowledgeBaseVectorSearchConfiguration.add_member(:implicit_filter_configuration, Shapes::ShapeRef.new(shape: ImplicitFilterConfiguration, location_name: "implicitFilterConfiguration"))
|
1668
|
+
KnowledgeBaseVectorSearchConfiguration.add_member(:reranking_configuration, Shapes::ShapeRef.new(shape: VectorSearchRerankingConfiguration, location_name: "rerankingConfiguration"))
|
1640
1669
|
KnowledgeBaseVectorSearchConfiguration.struct_class = Types::KnowledgeBaseVectorSearchConfiguration
|
1641
1670
|
|
1642
1671
|
LegalTerm.add_member(:url, Shapes::ShapeRef.new(shape: String, location_name: "url"))
|
@@ -1848,6 +1877,17 @@ module Aws::Bedrock
|
|
1848
1877
|
MarketplaceModelEndpointSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, required: true, location_name: "updatedAt"))
|
1849
1878
|
MarketplaceModelEndpointSummary.struct_class = Types::MarketplaceModelEndpointSummary
|
1850
1879
|
|
1880
|
+
MetadataAttributeSchema.add_member(:key, Shapes::ShapeRef.new(shape: MetadataAttributeSchemaKeyString, required: true, location_name: "key"))
|
1881
|
+
MetadataAttributeSchema.add_member(:type, Shapes::ShapeRef.new(shape: AttributeType, required: true, location_name: "type"))
|
1882
|
+
MetadataAttributeSchema.add_member(:description, Shapes::ShapeRef.new(shape: MetadataAttributeSchemaDescriptionString, required: true, location_name: "description"))
|
1883
|
+
MetadataAttributeSchema.struct_class = Types::MetadataAttributeSchema
|
1884
|
+
|
1885
|
+
MetadataAttributeSchemaList.member = Shapes::ShapeRef.new(shape: MetadataAttributeSchema)
|
1886
|
+
|
1887
|
+
MetadataConfigurationForReranking.add_member(:selection_mode, Shapes::ShapeRef.new(shape: RerankingMetadataSelectionMode, required: true, location_name: "selectionMode"))
|
1888
|
+
MetadataConfigurationForReranking.add_member(:selective_mode_configuration, Shapes::ShapeRef.new(shape: RerankingMetadataSelectiveModeConfiguration, location_name: "selectiveModeConfiguration"))
|
1889
|
+
MetadataConfigurationForReranking.struct_class = Types::MetadataConfigurationForReranking
|
1890
|
+
|
1851
1891
|
ModelCopyJobSummaries.member = Shapes::ShapeRef.new(shape: ModelCopyJobSummary)
|
1852
1892
|
|
1853
1893
|
ModelCopyJobSummary.add_member(:job_arn, Shapes::ShapeRef.new(shape: ModelCopyJobArn, required: true, location_name: "jobArn"))
|
@@ -2070,6 +2110,14 @@ module Aws::Bedrock
|
|
2070
2110
|
RequestMetadataMap.key = Shapes::ShapeRef.new(shape: RequestMetadataMapKeyString)
|
2071
2111
|
RequestMetadataMap.value = Shapes::ShapeRef.new(shape: RequestMetadataMapValueString)
|
2072
2112
|
|
2113
|
+
RerankingMetadataSelectiveModeConfiguration.add_member(:fields_to_include, Shapes::ShapeRef.new(shape: FieldsForReranking, location_name: "fieldsToInclude"))
|
2114
|
+
RerankingMetadataSelectiveModeConfiguration.add_member(:fields_to_exclude, Shapes::ShapeRef.new(shape: FieldsForReranking, location_name: "fieldsToExclude"))
|
2115
|
+
RerankingMetadataSelectiveModeConfiguration.add_member(:unknown, Shapes::ShapeRef.new(shape: nil, location_name: 'unknown'))
|
2116
|
+
RerankingMetadataSelectiveModeConfiguration.add_member_subclass(:fields_to_include, Types::RerankingMetadataSelectiveModeConfiguration::FieldsToInclude)
|
2117
|
+
RerankingMetadataSelectiveModeConfiguration.add_member_subclass(:fields_to_exclude, Types::RerankingMetadataSelectiveModeConfiguration::FieldsToExclude)
|
2118
|
+
RerankingMetadataSelectiveModeConfiguration.add_member_subclass(:unknown, Types::RerankingMetadataSelectiveModeConfiguration::Unknown)
|
2119
|
+
RerankingMetadataSelectiveModeConfiguration.struct_class = Types::RerankingMetadataSelectiveModeConfiguration
|
2120
|
+
|
2073
2121
|
ResourceNotFoundException.add_member(:message, Shapes::ShapeRef.new(shape: NonBlankString, location_name: "message"))
|
2074
2122
|
ResourceNotFoundException.struct_class = Types::ResourceNotFoundException
|
2075
2123
|
|
@@ -2281,6 +2329,19 @@ module Aws::Bedrock
|
|
2281
2329
|
ValidityTerm.add_member(:agreement_duration, Shapes::ShapeRef.new(shape: String, location_name: "agreementDuration"))
|
2282
2330
|
ValidityTerm.struct_class = Types::ValidityTerm
|
2283
2331
|
|
2332
|
+
VectorSearchBedrockRerankingConfiguration.add_member(:model_configuration, Shapes::ShapeRef.new(shape: VectorSearchBedrockRerankingModelConfiguration, required: true, location_name: "modelConfiguration"))
|
2333
|
+
VectorSearchBedrockRerankingConfiguration.add_member(:number_of_reranked_results, Shapes::ShapeRef.new(shape: VectorSearchBedrockRerankingConfigurationNumberOfRerankedResultsInteger, location_name: "numberOfRerankedResults"))
|
2334
|
+
VectorSearchBedrockRerankingConfiguration.add_member(:metadata_configuration, Shapes::ShapeRef.new(shape: MetadataConfigurationForReranking, location_name: "metadataConfiguration"))
|
2335
|
+
VectorSearchBedrockRerankingConfiguration.struct_class = Types::VectorSearchBedrockRerankingConfiguration
|
2336
|
+
|
2337
|
+
VectorSearchBedrockRerankingModelConfiguration.add_member(:model_arn, Shapes::ShapeRef.new(shape: BedrockRerankingModelArn, required: true, location_name: "modelArn"))
|
2338
|
+
VectorSearchBedrockRerankingModelConfiguration.add_member(:additional_model_request_fields, Shapes::ShapeRef.new(shape: AdditionalModelRequestFields, location_name: "additionalModelRequestFields"))
|
2339
|
+
VectorSearchBedrockRerankingModelConfiguration.struct_class = Types::VectorSearchBedrockRerankingModelConfiguration
|
2340
|
+
|
2341
|
+
VectorSearchRerankingConfiguration.add_member(:type, Shapes::ShapeRef.new(shape: VectorSearchRerankingConfigurationType, required: true, location_name: "type"))
|
2342
|
+
VectorSearchRerankingConfiguration.add_member(:bedrock_reranking_configuration, Shapes::ShapeRef.new(shape: VectorSearchBedrockRerankingConfiguration, location_name: "bedrockRerankingConfiguration"))
|
2343
|
+
VectorSearchRerankingConfiguration.struct_class = Types::VectorSearchRerankingConfiguration
|
2344
|
+
|
2284
2345
|
VpcConfig.add_member(:subnet_ids, Shapes::ShapeRef.new(shape: SubnetIds, required: true, location_name: "subnetIds"))
|
2285
2346
|
VpcConfig.add_member(:security_group_ids, Shapes::ShapeRef.new(shape: SecurityGroupIds, required: true, location_name: "securityGroupIds"))
|
2286
2347
|
VpcConfig.struct_class = Types::VpcConfig
|
@@ -2293,7 +2354,7 @@ module Aws::Bedrock
|
|
2293
2354
|
|
2294
2355
|
api.metadata = {
|
2295
2356
|
"apiVersion" => "2023-04-20",
|
2296
|
-
"auth" => ["aws.auth#sigv4"],
|
2357
|
+
"auth" => ["aws.auth#sigv4", "smithy.api#httpBearerAuth"],
|
2297
2358
|
"endpointPrefix" => "bedrock",
|
2298
2359
|
"protocol" => "rest-json",
|
2299
2360
|
"protocols" => ["rest-json"],
|
@@ -2387,6 +2387,24 @@ module Aws::Bedrock
|
|
2387
2387
|
include Aws::Structure
|
2388
2388
|
end
|
2389
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
|
+
|
2390
2408
|
# Specifies the name of the metadata attribute/field to apply filters.
|
2391
2409
|
# You must match the name of the attribute/field in your data
|
2392
2410
|
# source/document metadata.
|
@@ -5535,6 +5553,32 @@ module Aws::Bedrock
|
|
5535
5553
|
include Aws::Structure
|
5536
5554
|
end
|
5537
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
|
+
|
5538
5582
|
# Information about the imported model.
|
5539
5583
|
#
|
5540
5584
|
# @!attribute [rw] model_arn
|
@@ -5860,12 +5904,27 @@ module Aws::Bedrock
|
|
5860
5904
|
# base data sources before returning results.
|
5861
5905
|
# @return [Types::RetrievalFilter]
|
5862
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
|
+
#
|
5863
5920
|
# @see http://docs.aws.amazon.com/goto/WebAPI/bedrock-2023-04-20/KnowledgeBaseVectorSearchConfiguration AWS API Documentation
|
5864
5921
|
#
|
5865
5922
|
class KnowledgeBaseVectorSearchConfiguration < Struct.new(
|
5866
5923
|
:number_of_results,
|
5867
5924
|
:override_search_type,
|
5868
|
-
:filter
|
5925
|
+
:filter,
|
5926
|
+
:implicit_filter_configuration,
|
5927
|
+
:reranking_configuration)
|
5869
5928
|
SENSITIVE = [:filter]
|
5870
5929
|
include Aws::Structure
|
5871
5930
|
end
|
@@ -7020,6 +7079,62 @@ module Aws::Bedrock
|
|
7020
7079
|
include Aws::Structure
|
7021
7080
|
end
|
7022
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
|
+
|
7023
7138
|
# Contains details about each model copy job.
|
7024
7139
|
#
|
7025
7140
|
# This data type is used in the following API operations:
|
@@ -7986,6 +8101,43 @@ module Aws::Bedrock
|
|
7986
8101
|
class Unknown < RequestMetadataFilters; end
|
7987
8102
|
end
|
7988
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
|
+
|
7989
8141
|
# The specified resource Amazon Resource Name (ARN) was not found. Check
|
7990
8142
|
# the Amazon Resource Name (ARN) and try your request again.
|
7991
8143
|
#
|
@@ -8978,6 +9130,90 @@ module Aws::Bedrock
|
|
8978
9130
|
include Aws::Structure
|
8979
9131
|
end
|
8980
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
|
+
|
8981
9217
|
# The configuration of a virtual private cloud (VPC). For more
|
8982
9218
|
# information, see [Protect your data using Amazon Virtual Private Cloud
|
8983
9219
|
# and Amazon Web Services PrivateLink][1].
|
data/lib/aws-sdk-bedrock.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -290,6 +290,42 @@ module Aws
|
|
290
290
|
or_all: Array[
|
291
291
|
untyped,
|
292
292
|
]?
|
293
|
+
}?,
|
294
|
+
implicit_filter_configuration: {
|
295
|
+
metadata_attributes: Array[
|
296
|
+
{
|
297
|
+
key: ::String,
|
298
|
+
type: ("STRING" | "NUMBER" | "BOOLEAN" | "STRING_LIST"),
|
299
|
+
description: ::String
|
300
|
+
},
|
301
|
+
],
|
302
|
+
model_arn: ::String
|
303
|
+
}?,
|
304
|
+
reranking_configuration: {
|
305
|
+
type: ("BEDROCK_RERANKING_MODEL"),
|
306
|
+
bedrock_reranking_configuration: {
|
307
|
+
model_configuration: {
|
308
|
+
model_arn: ::String,
|
309
|
+
additional_model_request_fields: Hash[::String, {
|
310
|
+
}]?
|
311
|
+
},
|
312
|
+
number_of_reranked_results: ::Integer?,
|
313
|
+
metadata_configuration: {
|
314
|
+
selection_mode: ("SELECTIVE" | "ALL"),
|
315
|
+
selective_mode_configuration: {
|
316
|
+
fields_to_include: Array[
|
317
|
+
{
|
318
|
+
field_name: ::String
|
319
|
+
},
|
320
|
+
]?,
|
321
|
+
fields_to_exclude: Array[
|
322
|
+
{
|
323
|
+
field_name: ::String
|
324
|
+
},
|
325
|
+
]?
|
326
|
+
}?
|
327
|
+
}?
|
328
|
+
}?
|
293
329
|
}?
|
294
330
|
}
|
295
331
|
}
|
@@ -365,6 +401,42 @@ module Aws
|
|
365
401
|
or_all: Array[
|
366
402
|
untyped,
|
367
403
|
]?
|
404
|
+
}?,
|
405
|
+
implicit_filter_configuration: {
|
406
|
+
metadata_attributes: Array[
|
407
|
+
{
|
408
|
+
key: ::String,
|
409
|
+
type: ("STRING" | "NUMBER" | "BOOLEAN" | "STRING_LIST"),
|
410
|
+
description: ::String
|
411
|
+
},
|
412
|
+
],
|
413
|
+
model_arn: ::String
|
414
|
+
}?,
|
415
|
+
reranking_configuration: {
|
416
|
+
type: ("BEDROCK_RERANKING_MODEL"),
|
417
|
+
bedrock_reranking_configuration: {
|
418
|
+
model_configuration: {
|
419
|
+
model_arn: ::String,
|
420
|
+
additional_model_request_fields: Hash[::String, {
|
421
|
+
}]?
|
422
|
+
},
|
423
|
+
number_of_reranked_results: ::Integer?,
|
424
|
+
metadata_configuration: {
|
425
|
+
selection_mode: ("SELECTIVE" | "ALL"),
|
426
|
+
selective_mode_configuration: {
|
427
|
+
fields_to_include: Array[
|
428
|
+
{
|
429
|
+
field_name: ::String
|
430
|
+
},
|
431
|
+
]?,
|
432
|
+
fields_to_exclude: Array[
|
433
|
+
{
|
434
|
+
field_name: ::String
|
435
|
+
},
|
436
|
+
]?
|
437
|
+
}?
|
438
|
+
}?
|
439
|
+
}?
|
368
440
|
}?
|
369
441
|
}
|
370
442
|
}?,
|
data/sig/types.rbs
CHANGED
@@ -639,6 +639,11 @@ module Aws::Bedrock
|
|
639
639
|
SENSITIVE: []
|
640
640
|
end
|
641
641
|
|
642
|
+
class FieldForReranking
|
643
|
+
attr_accessor field_name: ::String
|
644
|
+
SENSITIVE: []
|
645
|
+
end
|
646
|
+
|
642
647
|
class FilterAttribute
|
643
648
|
attr_accessor key: ::String
|
644
649
|
attr_accessor value: untyped
|
@@ -1264,6 +1269,12 @@ module Aws::Bedrock
|
|
1264
1269
|
SENSITIVE: [:instructions]
|
1265
1270
|
end
|
1266
1271
|
|
1272
|
+
class ImplicitFilterConfiguration
|
1273
|
+
attr_accessor metadata_attributes: ::Array[Types::MetadataAttributeSchema]
|
1274
|
+
attr_accessor model_arn: ::String
|
1275
|
+
SENSITIVE: []
|
1276
|
+
end
|
1277
|
+
|
1267
1278
|
class ImportedModelSummary
|
1268
1279
|
attr_accessor model_arn: ::String
|
1269
1280
|
attr_accessor model_name: ::String
|
@@ -1362,6 +1373,8 @@ module Aws::Bedrock
|
|
1362
1373
|
attr_accessor number_of_results: ::Integer
|
1363
1374
|
attr_accessor override_search_type: ("HYBRID" | "SEMANTIC")
|
1364
1375
|
attr_accessor filter: Types::RetrievalFilter
|
1376
|
+
attr_accessor implicit_filter_configuration: Types::ImplicitFilterConfiguration
|
1377
|
+
attr_accessor reranking_configuration: Types::VectorSearchRerankingConfiguration
|
1365
1378
|
SENSITIVE: [:filter]
|
1366
1379
|
end
|
1367
1380
|
|
@@ -1640,6 +1653,19 @@ module Aws::Bedrock
|
|
1640
1653
|
SENSITIVE: []
|
1641
1654
|
end
|
1642
1655
|
|
1656
|
+
class MetadataAttributeSchema
|
1657
|
+
attr_accessor key: ::String
|
1658
|
+
attr_accessor type: ("STRING" | "NUMBER" | "BOOLEAN" | "STRING_LIST")
|
1659
|
+
attr_accessor description: ::String
|
1660
|
+
SENSITIVE: []
|
1661
|
+
end
|
1662
|
+
|
1663
|
+
class MetadataConfigurationForReranking
|
1664
|
+
attr_accessor selection_mode: ("SELECTIVE" | "ALL")
|
1665
|
+
attr_accessor selective_mode_configuration: Types::RerankingMetadataSelectiveModeConfiguration
|
1666
|
+
SENSITIVE: []
|
1667
|
+
end
|
1668
|
+
|
1643
1669
|
class ModelCopyJobSummary
|
1644
1670
|
attr_accessor job_arn: ::String
|
1645
1671
|
attr_accessor status: ("InProgress" | "Completed" | "Failed")
|
@@ -1907,6 +1933,20 @@ module Aws::Bedrock
|
|
1907
1933
|
end
|
1908
1934
|
end
|
1909
1935
|
|
1936
|
+
class RerankingMetadataSelectiveModeConfiguration
|
1937
|
+
attr_accessor fields_to_include: ::Array[Types::FieldForReranking]
|
1938
|
+
attr_accessor fields_to_exclude: ::Array[Types::FieldForReranking]
|
1939
|
+
attr_accessor unknown: untyped
|
1940
|
+
SENSITIVE: [:fields_to_include, :fields_to_exclude]
|
1941
|
+
|
1942
|
+
class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration
|
1943
|
+
end
|
1944
|
+
class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration
|
1945
|
+
end
|
1946
|
+
class Unknown < RerankingMetadataSelectiveModeConfiguration
|
1947
|
+
end
|
1948
|
+
end
|
1949
|
+
|
1910
1950
|
class ResourceNotFoundException
|
1911
1951
|
attr_accessor message: ::String
|
1912
1952
|
SENSITIVE: []
|
@@ -2201,6 +2241,25 @@ module Aws::Bedrock
|
|
2201
2241
|
SENSITIVE: []
|
2202
2242
|
end
|
2203
2243
|
|
2244
|
+
class VectorSearchBedrockRerankingConfiguration
|
2245
|
+
attr_accessor model_configuration: Types::VectorSearchBedrockRerankingModelConfiguration
|
2246
|
+
attr_accessor number_of_reranked_results: ::Integer
|
2247
|
+
attr_accessor metadata_configuration: Types::MetadataConfigurationForReranking
|
2248
|
+
SENSITIVE: []
|
2249
|
+
end
|
2250
|
+
|
2251
|
+
class VectorSearchBedrockRerankingModelConfiguration
|
2252
|
+
attr_accessor model_arn: ::String
|
2253
|
+
attr_accessor additional_model_request_fields: ::Hash[::String, untyped]
|
2254
|
+
SENSITIVE: []
|
2255
|
+
end
|
2256
|
+
|
2257
|
+
class VectorSearchRerankingConfiguration
|
2258
|
+
attr_accessor type: ("BEDROCK_RERANKING_MODEL")
|
2259
|
+
attr_accessor bedrock_reranking_configuration: Types::VectorSearchBedrockRerankingConfiguration
|
2260
|
+
SENSITIVE: []
|
2261
|
+
end
|
2262
|
+
|
2204
2263
|
class VpcConfig
|
2205
2264
|
attr_accessor subnet_ids: ::Array[::String]
|
2206
2265
|
attr_accessor security_group_ids: ::Array[::String]
|