aws-cdk-lib 2.206.0__py3-none-any.whl → 2.207.0__py3-none-any.whl
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.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +96 -15
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.206.0.jsii.tgz → aws-cdk-lib@2.207.0.jsii.tgz} +0 -0
- aws_cdk/aws_aiops/__init__.py +66 -76
- aws_cdk/aws_autoscaling/__init__.py +20 -0
- aws_cdk/aws_bedrock/__init__.py +126 -70
- aws_cdk/aws_certificatemanager/__init__.py +3 -3
- aws_cdk/aws_cleanrooms/__init__.py +6 -2
- aws_cdk/aws_cloudformation/__init__.py +28 -15
- aws_cdk/aws_cloudwatch/__init__.py +574 -33
- aws_cdk/aws_datasync/__init__.py +14 -15
- aws_cdk/aws_ec2/__init__.py +6 -2
- aws_cdk/aws_ecs/__init__.py +67 -18
- aws_cdk/aws_iotsitewise/__init__.py +13 -9
- aws_cdk/aws_kms/__init__.py +19 -17
- aws_cdk/aws_logs/__init__.py +4725 -763
- aws_cdk/aws_mediapackagev2/__init__.py +69 -48
- aws_cdk/aws_opsworkscm/__init__.py +2 -4
- aws_cdk/aws_rds/__init__.py +150 -17
- aws_cdk/aws_s3/__init__.py +9 -6
- aws_cdk/aws_sagemaker/__init__.py +3 -3
- aws_cdk/aws_ssm/__init__.py +58 -33
- aws_cdk/aws_transfer/__init__.py +21 -11
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/RECORD +29 -29
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.206.0.dist-info → aws_cdk_lib-2.207.0.dist-info}/top_level.txt +0 -0
|
@@ -19496,6 +19496,7 @@ class AutoScalingGroup(
|
|
|
19496
19496
|
launch_template: typing.Optional[_ILaunchTemplate_f32c0fd7] = None,
|
|
19497
19497
|
machine_image: typing.Optional[_IMachineImage_0e8bd50b] = None,
|
|
19498
19498
|
max_healthy_percentage: typing.Optional[jsii.Number] = None,
|
|
19499
|
+
migrate_to_launch_template: typing.Optional[builtins.bool] = None,
|
|
19499
19500
|
min_healthy_percentage: typing.Optional[jsii.Number] = None,
|
|
19500
19501
|
mixed_instances_policy: typing.Optional[typing.Union[MixedInstancesPolicy, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
19501
19502
|
require_imdsv2: typing.Optional[builtins.bool] = None,
|
|
@@ -19541,6 +19542,7 @@ class AutoScalingGroup(
|
|
|
19541
19542
|
:param launch_template: Launch template to use. Launch configuration related settings and MixedInstancesPolicy must not be specified when a launch template is specified. Default: - Do not provide any launch template
|
|
19542
19543
|
:param machine_image: AMI to launch. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified Default: - Do not provide any machine image
|
|
19543
19544
|
:param max_healthy_percentage: Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 0 to 100. After it's set, both ``minHealthyPercentage`` and ``maxHealthyPercentage`` to -1 will clear the previously set value. Both or neither of ``minHealthyPercentage`` and ``maxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. Default: - No instance maintenance policy.
|
|
19545
|
+
:param migrate_to_launch_template: Whether safety guardrail should be enforced when migrating to the launch template. Default: false
|
|
19544
19546
|
:param min_healthy_percentage: Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. After it's set, both ``minHealthyPercentage`` and ``maxHealthyPercentage`` to -1 will clear the previously set value. Both or neither of ``minHealthyPercentage`` and ``maxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. Default: - No instance maintenance policy.
|
|
19545
19547
|
:param mixed_instances_policy: Mixed Instances Policy to use. Launch configuration related settings and Launch Template must not be specified when a MixedInstancesPolicy is specified. Default: - Do not provide any MixedInstancesPolicy
|
|
19546
19548
|
:param require_imdsv2: Whether IMDSv2 should be required on launched instances. Default: false
|
|
@@ -19588,6 +19590,7 @@ class AutoScalingGroup(
|
|
|
19588
19590
|
launch_template=launch_template,
|
|
19589
19591
|
machine_image=machine_image,
|
|
19590
19592
|
max_healthy_percentage=max_healthy_percentage,
|
|
19593
|
+
migrate_to_launch_template=migrate_to_launch_template,
|
|
19591
19594
|
min_healthy_percentage=min_healthy_percentage,
|
|
19592
19595
|
mixed_instances_policy=mixed_instances_policy,
|
|
19593
19596
|
require_imdsv2=require_imdsv2,
|
|
@@ -20230,6 +20233,7 @@ class AutoScalingGroup(
|
|
|
20230
20233
|
"launch_template": "launchTemplate",
|
|
20231
20234
|
"machine_image": "machineImage",
|
|
20232
20235
|
"max_healthy_percentage": "maxHealthyPercentage",
|
|
20236
|
+
"migrate_to_launch_template": "migrateToLaunchTemplate",
|
|
20233
20237
|
"min_healthy_percentage": "minHealthyPercentage",
|
|
20234
20238
|
"mixed_instances_policy": "mixedInstancesPolicy",
|
|
20235
20239
|
"require_imdsv2": "requireImdsv2",
|
|
@@ -20277,6 +20281,7 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
20277
20281
|
launch_template: typing.Optional[_ILaunchTemplate_f32c0fd7] = None,
|
|
20278
20282
|
machine_image: typing.Optional[_IMachineImage_0e8bd50b] = None,
|
|
20279
20283
|
max_healthy_percentage: typing.Optional[jsii.Number] = None,
|
|
20284
|
+
migrate_to_launch_template: typing.Optional[builtins.bool] = None,
|
|
20280
20285
|
min_healthy_percentage: typing.Optional[jsii.Number] = None,
|
|
20281
20286
|
mixed_instances_policy: typing.Optional[typing.Union[MixedInstancesPolicy, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
20282
20287
|
require_imdsv2: typing.Optional[builtins.bool] = None,
|
|
@@ -20321,6 +20326,7 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
20321
20326
|
:param launch_template: Launch template to use. Launch configuration related settings and MixedInstancesPolicy must not be specified when a launch template is specified. Default: - Do not provide any launch template
|
|
20322
20327
|
:param machine_image: AMI to launch. ``launchTemplate`` and ``mixedInstancesPolicy`` must not be specified when this property is specified Default: - Do not provide any machine image
|
|
20323
20328
|
:param max_healthy_percentage: Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 0 to 100. After it's set, both ``minHealthyPercentage`` and ``maxHealthyPercentage`` to -1 will clear the previously set value. Both or neither of ``minHealthyPercentage`` and ``maxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. Default: - No instance maintenance policy.
|
|
20329
|
+
:param migrate_to_launch_template: Whether safety guardrail should be enforced when migrating to the launch template. Default: false
|
|
20324
20330
|
:param min_healthy_percentage: Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. After it's set, both ``minHealthyPercentage`` and ``maxHealthyPercentage`` to -1 will clear the previously set value. Both or neither of ``minHealthyPercentage`` and ``maxHealthyPercentage`` must be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. Default: - No instance maintenance policy.
|
|
20325
20331
|
:param mixed_instances_policy: Mixed Instances Policy to use. Launch configuration related settings and Launch Template must not be specified when a MixedInstancesPolicy is specified. Default: - Do not provide any MixedInstancesPolicy
|
|
20326
20332
|
:param require_imdsv2: Whether IMDSv2 should be required on launched instances. Default: false
|
|
@@ -20386,6 +20392,7 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
20386
20392
|
check_type(argname="argument launch_template", value=launch_template, expected_type=type_hints["launch_template"])
|
|
20387
20393
|
check_type(argname="argument machine_image", value=machine_image, expected_type=type_hints["machine_image"])
|
|
20388
20394
|
check_type(argname="argument max_healthy_percentage", value=max_healthy_percentage, expected_type=type_hints["max_healthy_percentage"])
|
|
20395
|
+
check_type(argname="argument migrate_to_launch_template", value=migrate_to_launch_template, expected_type=type_hints["migrate_to_launch_template"])
|
|
20389
20396
|
check_type(argname="argument min_healthy_percentage", value=min_healthy_percentage, expected_type=type_hints["min_healthy_percentage"])
|
|
20390
20397
|
check_type(argname="argument mixed_instances_policy", value=mixed_instances_policy, expected_type=type_hints["mixed_instances_policy"])
|
|
20391
20398
|
check_type(argname="argument require_imdsv2", value=require_imdsv2, expected_type=type_hints["require_imdsv2"])
|
|
@@ -20463,6 +20470,8 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
20463
20470
|
self._values["machine_image"] = machine_image
|
|
20464
20471
|
if max_healthy_percentage is not None:
|
|
20465
20472
|
self._values["max_healthy_percentage"] = max_healthy_percentage
|
|
20473
|
+
if migrate_to_launch_template is not None:
|
|
20474
|
+
self._values["migrate_to_launch_template"] = migrate_to_launch_template
|
|
20466
20475
|
if min_healthy_percentage is not None:
|
|
20467
20476
|
self._values["min_healthy_percentage"] = min_healthy_percentage
|
|
20468
20477
|
if mixed_instances_policy is not None:
|
|
@@ -20957,6 +20966,15 @@ class AutoScalingGroupProps(CommonAutoScalingGroupProps):
|
|
|
20957
20966
|
result = self._values.get("max_healthy_percentage")
|
|
20958
20967
|
return typing.cast(typing.Optional[jsii.Number], result)
|
|
20959
20968
|
|
|
20969
|
+
@builtins.property
|
|
20970
|
+
def migrate_to_launch_template(self) -> typing.Optional[builtins.bool]:
|
|
20971
|
+
'''Whether safety guardrail should be enforced when migrating to the launch template.
|
|
20972
|
+
|
|
20973
|
+
:default: false
|
|
20974
|
+
'''
|
|
20975
|
+
result = self._values.get("migrate_to_launch_template")
|
|
20976
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
|
20977
|
+
|
|
20960
20978
|
@builtins.property
|
|
20961
20979
|
def min_healthy_percentage(self) -> typing.Optional[jsii.Number]:
|
|
20962
20980
|
'''Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group.
|
|
@@ -23458,6 +23476,7 @@ def _typecheckingstub__82981fc74407321badee3133fda3bd0a016f4ab7634f761219c1c808c
|
|
|
23458
23476
|
launch_template: typing.Optional[_ILaunchTemplate_f32c0fd7] = None,
|
|
23459
23477
|
machine_image: typing.Optional[_IMachineImage_0e8bd50b] = None,
|
|
23460
23478
|
max_healthy_percentage: typing.Optional[jsii.Number] = None,
|
|
23479
|
+
migrate_to_launch_template: typing.Optional[builtins.bool] = None,
|
|
23461
23480
|
min_healthy_percentage: typing.Optional[jsii.Number] = None,
|
|
23462
23481
|
mixed_instances_policy: typing.Optional[typing.Union[MixedInstancesPolicy, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
23463
23482
|
require_imdsv2: typing.Optional[builtins.bool] = None,
|
|
@@ -23708,6 +23727,7 @@ def _typecheckingstub__186ff14d58334848486a7ecd802c6b72a1b76f272f25349712b95361e
|
|
|
23708
23727
|
launch_template: typing.Optional[_ILaunchTemplate_f32c0fd7] = None,
|
|
23709
23728
|
machine_image: typing.Optional[_IMachineImage_0e8bd50b] = None,
|
|
23710
23729
|
max_healthy_percentage: typing.Optional[jsii.Number] = None,
|
|
23730
|
+
migrate_to_launch_template: typing.Optional[builtins.bool] = None,
|
|
23711
23731
|
min_healthy_percentage: typing.Optional[jsii.Number] = None,
|
|
23712
23732
|
mixed_instances_policy: typing.Optional[typing.Union[MixedInstancesPolicy, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
23713
23733
|
require_imdsv2: typing.Optional[builtins.bool] = None,
|
aws_cdk/aws_bedrock/__init__.py
CHANGED
|
@@ -12743,9 +12743,11 @@ class CfnFlow(
|
|
|
12743
12743
|
)
|
|
12744
12744
|
class FieldForRerankingProperty:
|
|
12745
12745
|
def __init__(self, *, field_name: builtins.str) -> None:
|
|
12746
|
-
'''
|
|
12746
|
+
'''Specifies a field to be used during the reranking process in a Knowledge Base vector search.
|
|
12747
12747
|
|
|
12748
|
-
|
|
12748
|
+
This structure identifies metadata fields that should be considered when reordering search results to improve relevance.
|
|
12749
|
+
|
|
12750
|
+
:param field_name: The name of the metadata field to be used during the reranking process.
|
|
12749
12751
|
|
|
12750
12752
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-fieldforreranking.html
|
|
12751
12753
|
:exampleMetadata: fixture=_generated
|
|
@@ -12769,7 +12771,7 @@ class CfnFlow(
|
|
|
12769
12771
|
|
|
12770
12772
|
@builtins.property
|
|
12771
12773
|
def field_name(self) -> builtins.str:
|
|
12772
|
-
'''The name of
|
|
12774
|
+
'''The name of the metadata field to be used during the reranking process.
|
|
12773
12775
|
|
|
12774
12776
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-fieldforreranking.html#cfn-bedrock-flow-fieldforreranking-fieldname
|
|
12775
12777
|
'''
|
|
@@ -15652,10 +15654,12 @@ class CfnFlow(
|
|
|
15652
15654
|
selection_mode: builtins.str,
|
|
15653
15655
|
selective_mode_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
15654
15656
|
) -> None:
|
|
15655
|
-
'''
|
|
15657
|
+
'''Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches.
|
|
15658
|
+
|
|
15659
|
+
This determines which metadata fields are included or excluded when reordering search results.
|
|
15656
15660
|
|
|
15657
|
-
:param selection_mode:
|
|
15658
|
-
:param selective_mode_configuration:
|
|
15661
|
+
:param selection_mode: The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
|
|
15662
|
+
:param selective_mode_configuration: Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.
|
|
15659
15663
|
|
|
15660
15664
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html
|
|
15661
15665
|
:exampleMetadata: fixture=_generated
|
|
@@ -15692,9 +15696,9 @@ class CfnFlow(
|
|
|
15692
15696
|
|
|
15693
15697
|
@builtins.property
|
|
15694
15698
|
def selection_mode(self) -> builtins.str:
|
|
15695
|
-
'''
|
|
15699
|
+
'''The mode for selecting which metadata fields to include in the reranking process.
|
|
15696
15700
|
|
|
15697
|
-
|
|
15701
|
+
Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
|
|
15698
15702
|
|
|
15699
15703
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html#cfn-bedrock-flow-metadataconfigurationforreranking-selectionmode
|
|
15700
15704
|
'''
|
|
@@ -15706,7 +15710,9 @@ class CfnFlow(
|
|
|
15706
15710
|
def selective_mode_configuration(
|
|
15707
15711
|
self,
|
|
15708
15712
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty"]]:
|
|
15709
|
-
'''
|
|
15713
|
+
'''Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking.
|
|
15714
|
+
|
|
15715
|
+
This is only used when selectionMode is set to SELECTIVE.
|
|
15710
15716
|
|
|
15711
15717
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-metadataconfigurationforreranking.html#cfn-bedrock-flow-metadataconfigurationforreranking-selectivemodeconfiguration
|
|
15712
15718
|
'''
|
|
@@ -16472,12 +16478,12 @@ class CfnFlow(
|
|
|
16472
16478
|
fields_to_exclude: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.FieldForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
16473
16479
|
fields_to_include: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.FieldForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
16474
16480
|
) -> None:
|
|
16475
|
-
'''
|
|
16481
|
+
'''Configuration for selectively including or excluding metadata fields during the reranking process.
|
|
16476
16482
|
|
|
16477
|
-
|
|
16483
|
+
This allows you to control which metadata attributes are considered when reordering search results.
|
|
16478
16484
|
|
|
16479
|
-
:param fields_to_exclude:
|
|
16480
|
-
:param fields_to_include:
|
|
16485
|
+
:param fields_to_exclude: A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
|
|
16486
|
+
:param fields_to_include: A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
|
|
16481
16487
|
|
|
16482
16488
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html
|
|
16483
16489
|
:exampleMetadata: fixture=_generated
|
|
@@ -16511,7 +16517,9 @@ class CfnFlow(
|
|
|
16511
16517
|
def fields_to_exclude(
|
|
16512
16518
|
self,
|
|
16513
16519
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFlow.FieldForRerankingProperty"]]]]:
|
|
16514
|
-
'''
|
|
16520
|
+
'''A list of metadata field names to explicitly exclude from the reranking process.
|
|
16521
|
+
|
|
16522
|
+
All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
|
|
16515
16523
|
|
|
16516
16524
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoexclude
|
|
16517
16525
|
'''
|
|
@@ -16522,9 +16530,9 @@ class CfnFlow(
|
|
|
16522
16530
|
def fields_to_include(
|
|
16523
16531
|
self,
|
|
16524
16532
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFlow.FieldForRerankingProperty"]]]]:
|
|
16525
|
-
'''
|
|
16533
|
+
'''A list of metadata field names to explicitly include in the reranking process.
|
|
16526
16534
|
|
|
16527
|
-
|
|
16535
|
+
Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
|
|
16528
16536
|
|
|
16529
16537
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flow-rerankingmetadataselectivemodeconfiguration-fieldstoinclude
|
|
16530
16538
|
'''
|
|
@@ -17076,11 +17084,13 @@ class CfnFlow(
|
|
|
17076
17084
|
metadata_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.MetadataConfigurationForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
17077
17085
|
number_of_reranked_results: typing.Optional[jsii.Number] = None,
|
|
17078
17086
|
) -> None:
|
|
17079
|
-
'''
|
|
17087
|
+
'''Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results.
|
|
17080
17088
|
|
|
17081
|
-
|
|
17082
|
-
|
|
17083
|
-
:param
|
|
17089
|
+
This enables more sophisticated relevance ranking using large language models.
|
|
17090
|
+
|
|
17091
|
+
:param model_configuration: Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.
|
|
17092
|
+
:param metadata_configuration: Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.
|
|
17093
|
+
:param number_of_reranked_results: The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
|
|
17084
17094
|
|
|
17085
17095
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html
|
|
17086
17096
|
:exampleMetadata: fixture=_generated
|
|
@@ -17135,7 +17145,9 @@ class CfnFlow(
|
|
|
17135
17145
|
def model_configuration(
|
|
17136
17146
|
self,
|
|
17137
17147
|
) -> typing.Union[_IResolvable_da3f097b, "CfnFlow.VectorSearchBedrockRerankingModelConfigurationProperty"]:
|
|
17138
|
-
'''
|
|
17148
|
+
'''Configuration for the Amazon Bedrock foundation model used for reranking.
|
|
17149
|
+
|
|
17150
|
+
This includes the model ARN and any additional request fields required by the model.
|
|
17139
17151
|
|
|
17140
17152
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-modelconfiguration
|
|
17141
17153
|
'''
|
|
@@ -17147,7 +17159,9 @@ class CfnFlow(
|
|
|
17147
17159
|
def metadata_configuration(
|
|
17148
17160
|
self,
|
|
17149
17161
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlow.MetadataConfigurationForRerankingProperty"]]:
|
|
17150
|
-
'''
|
|
17162
|
+
'''Configuration for how document metadata should be used during the reranking process.
|
|
17163
|
+
|
|
17164
|
+
This determines which metadata fields are included when reordering search results.
|
|
17151
17165
|
|
|
17152
17166
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-metadataconfiguration
|
|
17153
17167
|
'''
|
|
@@ -17156,7 +17170,9 @@ class CfnFlow(
|
|
|
17156
17170
|
|
|
17157
17171
|
@builtins.property
|
|
17158
17172
|
def number_of_reranked_results(self) -> typing.Optional[jsii.Number]:
|
|
17159
|
-
'''The number of results to
|
|
17173
|
+
'''The maximum number of results to rerank.
|
|
17174
|
+
|
|
17175
|
+
This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
|
|
17160
17176
|
|
|
17161
17177
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults
|
|
17162
17178
|
'''
|
|
@@ -17189,10 +17205,12 @@ class CfnFlow(
|
|
|
17189
17205
|
model_arn: builtins.str,
|
|
17190
17206
|
additional_model_request_fields: typing.Any = None,
|
|
17191
17207
|
) -> None:
|
|
17192
|
-
'''
|
|
17208
|
+
'''Configuration for the Amazon Bedrock foundation model used for reranking vector search results.
|
|
17209
|
+
|
|
17210
|
+
This specifies which model to use and any additional parameters required by the model.
|
|
17193
17211
|
|
|
17194
|
-
:param model_arn: The ARN of the
|
|
17195
|
-
:param additional_model_request_fields: A
|
|
17212
|
+
:param model_arn: The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.
|
|
17213
|
+
:param additional_model_request_fields: A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.
|
|
17196
17214
|
|
|
17197
17215
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html
|
|
17198
17216
|
:exampleMetadata: fixture=_generated
|
|
@@ -17224,7 +17242,9 @@ class CfnFlow(
|
|
|
17224
17242
|
|
|
17225
17243
|
@builtins.property
|
|
17226
17244
|
def model_arn(self) -> builtins.str:
|
|
17227
|
-
'''The ARN of the
|
|
17245
|
+
'''The Amazon Resource Name (ARN) of the foundation model to use for reranking.
|
|
17246
|
+
|
|
17247
|
+
This model processes the query and search results to determine a more relevant ordering.
|
|
17228
17248
|
|
|
17229
17249
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-modelarn
|
|
17230
17250
|
'''
|
|
@@ -17234,7 +17254,9 @@ class CfnFlow(
|
|
|
17234
17254
|
|
|
17235
17255
|
@builtins.property
|
|
17236
17256
|
def additional_model_request_fields(self) -> typing.Any:
|
|
17237
|
-
'''A
|
|
17257
|
+
'''A list of additional fields to include in the model request during reranking.
|
|
17258
|
+
|
|
17259
|
+
These fields provide extra context or configuration options specific to the selected foundation model.
|
|
17238
17260
|
|
|
17239
17261
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flow-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields
|
|
17240
17262
|
'''
|
|
@@ -17267,10 +17289,12 @@ class CfnFlow(
|
|
|
17267
17289
|
type: builtins.str,
|
|
17268
17290
|
bedrock_reranking_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlow.VectorSearchBedrockRerankingConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
17269
17291
|
) -> None:
|
|
17270
|
-
'''
|
|
17292
|
+
'''Configuration for reranking vector search results to improve relevance.
|
|
17271
17293
|
|
|
17272
|
-
|
|
17273
|
-
|
|
17294
|
+
Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.
|
|
17295
|
+
|
|
17296
|
+
:param type: The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
|
|
17297
|
+
:param bedrock_reranking_configuration: Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.
|
|
17274
17298
|
|
|
17275
17299
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html
|
|
17276
17300
|
:exampleMetadata: fixture=_generated
|
|
@@ -17325,7 +17349,9 @@ class CfnFlow(
|
|
|
17325
17349
|
|
|
17326
17350
|
@builtins.property
|
|
17327
17351
|
def type(self) -> builtins.str:
|
|
17328
|
-
'''The type of
|
|
17352
|
+
'''The type of reranking to apply to vector search results.
|
|
17353
|
+
|
|
17354
|
+
Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
|
|
17329
17355
|
|
|
17330
17356
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchrerankingconfiguration-type
|
|
17331
17357
|
'''
|
|
@@ -17337,7 +17363,9 @@ class CfnFlow(
|
|
|
17337
17363
|
def bedrock_reranking_configuration(
|
|
17338
17364
|
self,
|
|
17339
17365
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlow.VectorSearchBedrockRerankingConfigurationProperty"]]:
|
|
17340
|
-
'''
|
|
17366
|
+
'''Configuration for using Amazon Bedrock foundation models to rerank search results.
|
|
17367
|
+
|
|
17368
|
+
This is required when the reranking type is set to BEDROCK.
|
|
17341
17369
|
|
|
17342
17370
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration
|
|
17343
17371
|
'''
|
|
@@ -18662,9 +18690,11 @@ class CfnFlowVersion(
|
|
|
18662
18690
|
)
|
|
18663
18691
|
class FieldForRerankingProperty:
|
|
18664
18692
|
def __init__(self, *, field_name: builtins.str) -> None:
|
|
18665
|
-
'''
|
|
18693
|
+
'''Specifies a field to be used during the reranking process in a Knowledge Base vector search.
|
|
18666
18694
|
|
|
18667
|
-
|
|
18695
|
+
This structure identifies metadata fields that should be considered when reordering search results to improve relevance.
|
|
18696
|
+
|
|
18697
|
+
:param field_name: The name of the metadata field to be used during the reranking process.
|
|
18668
18698
|
|
|
18669
18699
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-fieldforreranking.html
|
|
18670
18700
|
:exampleMetadata: fixture=_generated
|
|
@@ -18688,7 +18718,7 @@ class CfnFlowVersion(
|
|
|
18688
18718
|
|
|
18689
18719
|
@builtins.property
|
|
18690
18720
|
def field_name(self) -> builtins.str:
|
|
18691
|
-
'''The name of
|
|
18721
|
+
'''The name of the metadata field to be used during the reranking process.
|
|
18692
18722
|
|
|
18693
18723
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-fieldforreranking.html#cfn-bedrock-flowversion-fieldforreranking-fieldname
|
|
18694
18724
|
'''
|
|
@@ -21476,10 +21506,12 @@ class CfnFlowVersion(
|
|
|
21476
21506
|
selection_mode: builtins.str,
|
|
21477
21507
|
selective_mode_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
21478
21508
|
) -> None:
|
|
21479
|
-
'''
|
|
21509
|
+
'''Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches.
|
|
21510
|
+
|
|
21511
|
+
This determines which metadata fields are included or excluded when reordering search results.
|
|
21480
21512
|
|
|
21481
|
-
:param selection_mode:
|
|
21482
|
-
:param selective_mode_configuration:
|
|
21513
|
+
:param selection_mode: The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
|
|
21514
|
+
:param selective_mode_configuration: Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.
|
|
21483
21515
|
|
|
21484
21516
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html
|
|
21485
21517
|
:exampleMetadata: fixture=_generated
|
|
@@ -21516,9 +21548,9 @@ class CfnFlowVersion(
|
|
|
21516
21548
|
|
|
21517
21549
|
@builtins.property
|
|
21518
21550
|
def selection_mode(self) -> builtins.str:
|
|
21519
|
-
'''
|
|
21551
|
+
'''The mode for selecting which metadata fields to include in the reranking process.
|
|
21520
21552
|
|
|
21521
|
-
|
|
21553
|
+
Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).
|
|
21522
21554
|
|
|
21523
21555
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectionmode
|
|
21524
21556
|
'''
|
|
@@ -21530,7 +21562,9 @@ class CfnFlowVersion(
|
|
|
21530
21562
|
def selective_mode_configuration(
|
|
21531
21563
|
self,
|
|
21532
21564
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty"]]:
|
|
21533
|
-
'''
|
|
21565
|
+
'''Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking.
|
|
21566
|
+
|
|
21567
|
+
This is only used when selectionMode is set to SELECTIVE.
|
|
21534
21568
|
|
|
21535
21569
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-metadataconfigurationforreranking.html#cfn-bedrock-flowversion-metadataconfigurationforreranking-selectivemodeconfiguration
|
|
21536
21570
|
'''
|
|
@@ -22296,12 +22330,12 @@ class CfnFlowVersion(
|
|
|
22296
22330
|
fields_to_exclude: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.FieldForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
22297
22331
|
fields_to_include: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Sequence[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.FieldForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]]]] = None,
|
|
22298
22332
|
) -> None:
|
|
22299
|
-
'''
|
|
22333
|
+
'''Configuration for selectively including or excluding metadata fields during the reranking process.
|
|
22300
22334
|
|
|
22301
|
-
|
|
22335
|
+
This allows you to control which metadata attributes are considered when reordering search results.
|
|
22302
22336
|
|
|
22303
|
-
:param fields_to_exclude:
|
|
22304
|
-
:param fields_to_include:
|
|
22337
|
+
:param fields_to_exclude: A list of metadata field names to explicitly exclude from the reranking process. All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
|
|
22338
|
+
:param fields_to_include: A list of metadata field names to explicitly include in the reranking process. Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
|
|
22305
22339
|
|
|
22306
22340
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html
|
|
22307
22341
|
:exampleMetadata: fixture=_generated
|
|
@@ -22335,7 +22369,9 @@ class CfnFlowVersion(
|
|
|
22335
22369
|
def fields_to_exclude(
|
|
22336
22370
|
self,
|
|
22337
22371
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.FieldForRerankingProperty"]]]]:
|
|
22338
|
-
'''
|
|
22372
|
+
'''A list of metadata field names to explicitly exclude from the reranking process.
|
|
22373
|
+
|
|
22374
|
+
All metadata fields except these will be considered when reordering search results. This parameter cannot be used together with fieldsToInclude.
|
|
22339
22375
|
|
|
22340
22376
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoexclude
|
|
22341
22377
|
'''
|
|
@@ -22346,9 +22382,9 @@ class CfnFlowVersion(
|
|
|
22346
22382
|
def fields_to_include(
|
|
22347
22383
|
self,
|
|
22348
22384
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.FieldForRerankingProperty"]]]]:
|
|
22349
|
-
'''
|
|
22385
|
+
'''A list of metadata field names to explicitly include in the reranking process.
|
|
22350
22386
|
|
|
22351
|
-
|
|
22387
|
+
Only these fields will be considered when reordering search results. This parameter cannot be used together with fieldsToExclude.
|
|
22352
22388
|
|
|
22353
22389
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoinclude
|
|
22354
22390
|
'''
|
|
@@ -22812,11 +22848,13 @@ class CfnFlowVersion(
|
|
|
22812
22848
|
metadata_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.MetadataConfigurationForRerankingProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
22813
22849
|
number_of_reranked_results: typing.Optional[jsii.Number] = None,
|
|
22814
22850
|
) -> None:
|
|
22815
|
-
'''
|
|
22851
|
+
'''Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results.
|
|
22816
22852
|
|
|
22817
|
-
|
|
22818
|
-
|
|
22819
|
-
:param
|
|
22853
|
+
This enables more sophisticated relevance ranking using large language models.
|
|
22854
|
+
|
|
22855
|
+
:param model_configuration: Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.
|
|
22856
|
+
:param metadata_configuration: Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.
|
|
22857
|
+
:param number_of_reranked_results: The maximum number of results to rerank. This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
|
|
22820
22858
|
|
|
22821
22859
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html
|
|
22822
22860
|
:exampleMetadata: fixture=_generated
|
|
@@ -22871,7 +22909,9 @@ class CfnFlowVersion(
|
|
|
22871
22909
|
def model_configuration(
|
|
22872
22910
|
self,
|
|
22873
22911
|
) -> typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty"]:
|
|
22874
|
-
'''
|
|
22912
|
+
'''Configuration for the Amazon Bedrock foundation model used for reranking.
|
|
22913
|
+
|
|
22914
|
+
This includes the model ARN and any additional request fields required by the model.
|
|
22875
22915
|
|
|
22876
22916
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-modelconfiguration
|
|
22877
22917
|
'''
|
|
@@ -22883,7 +22923,9 @@ class CfnFlowVersion(
|
|
|
22883
22923
|
def metadata_configuration(
|
|
22884
22924
|
self,
|
|
22885
22925
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.MetadataConfigurationForRerankingProperty"]]:
|
|
22886
|
-
'''
|
|
22926
|
+
'''Configuration for how document metadata should be used during the reranking process.
|
|
22927
|
+
|
|
22928
|
+
This determines which metadata fields are included when reordering search results.
|
|
22887
22929
|
|
|
22888
22930
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-metadataconfiguration
|
|
22889
22931
|
'''
|
|
@@ -22892,7 +22934,9 @@ class CfnFlowVersion(
|
|
|
22892
22934
|
|
|
22893
22935
|
@builtins.property
|
|
22894
22936
|
def number_of_reranked_results(self) -> typing.Optional[jsii.Number]:
|
|
22895
|
-
'''The number of results to
|
|
22937
|
+
'''The maximum number of results to rerank.
|
|
22938
|
+
|
|
22939
|
+
This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.
|
|
22896
22940
|
|
|
22897
22941
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingconfiguration-numberofrerankedresults
|
|
22898
22942
|
'''
|
|
@@ -22925,10 +22969,12 @@ class CfnFlowVersion(
|
|
|
22925
22969
|
model_arn: builtins.str,
|
|
22926
22970
|
additional_model_request_fields: typing.Any = None,
|
|
22927
22971
|
) -> None:
|
|
22928
|
-
'''
|
|
22972
|
+
'''Configuration for the Amazon Bedrock foundation model used for reranking vector search results.
|
|
22973
|
+
|
|
22974
|
+
This specifies which model to use and any additional parameters required by the model.
|
|
22929
22975
|
|
|
22930
|
-
:param model_arn: The ARN of the
|
|
22931
|
-
:param additional_model_request_fields: A
|
|
22976
|
+
:param model_arn: The Amazon Resource Name (ARN) of the foundation model to use for reranking. This model processes the query and search results to determine a more relevant ordering.
|
|
22977
|
+
:param additional_model_request_fields: A list of additional fields to include in the model request during reranking. These fields provide extra context or configuration options specific to the selected foundation model.
|
|
22932
22978
|
|
|
22933
22979
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html
|
|
22934
22980
|
:exampleMetadata: fixture=_generated
|
|
@@ -22960,7 +23006,9 @@ class CfnFlowVersion(
|
|
|
22960
23006
|
|
|
22961
23007
|
@builtins.property
|
|
22962
23008
|
def model_arn(self) -> builtins.str:
|
|
22963
|
-
'''The ARN of the
|
|
23009
|
+
'''The Amazon Resource Name (ARN) of the foundation model to use for reranking.
|
|
23010
|
+
|
|
23011
|
+
This model processes the query and search results to determine a more relevant ordering.
|
|
22964
23012
|
|
|
22965
23013
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-modelarn
|
|
22966
23014
|
'''
|
|
@@ -22970,7 +23018,9 @@ class CfnFlowVersion(
|
|
|
22970
23018
|
|
|
22971
23019
|
@builtins.property
|
|
22972
23020
|
def additional_model_request_fields(self) -> typing.Any:
|
|
22973
|
-
'''A
|
|
23021
|
+
'''A list of additional fields to include in the model request during reranking.
|
|
23022
|
+
|
|
23023
|
+
These fields provide extra context or configuration options specific to the selected foundation model.
|
|
22974
23024
|
|
|
22975
23025
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration.html#cfn-bedrock-flowversion-vectorsearchbedrockrerankingmodelconfiguration-additionalmodelrequestfields
|
|
22976
23026
|
'''
|
|
@@ -23003,10 +23053,12 @@ class CfnFlowVersion(
|
|
|
23003
23053
|
type: builtins.str,
|
|
23004
23054
|
bedrock_reranking_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
23005
23055
|
) -> None:
|
|
23006
|
-
'''
|
|
23056
|
+
'''Configuration for reranking vector search results to improve relevance.
|
|
23007
23057
|
|
|
23008
|
-
|
|
23009
|
-
|
|
23058
|
+
Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.
|
|
23059
|
+
|
|
23060
|
+
:param type: The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
|
|
23061
|
+
:param bedrock_reranking_configuration: Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.
|
|
23010
23062
|
|
|
23011
23063
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html
|
|
23012
23064
|
:exampleMetadata: fixture=_generated
|
|
@@ -23061,7 +23113,9 @@ class CfnFlowVersion(
|
|
|
23061
23113
|
|
|
23062
23114
|
@builtins.property
|
|
23063
23115
|
def type(self) -> builtins.str:
|
|
23064
|
-
'''The type of
|
|
23116
|
+
'''The type of reranking to apply to vector search results.
|
|
23117
|
+
|
|
23118
|
+
Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
|
|
23065
23119
|
|
|
23066
23120
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-type
|
|
23067
23121
|
'''
|
|
@@ -23073,7 +23127,9 @@ class CfnFlowVersion(
|
|
|
23073
23127
|
def bedrock_reranking_configuration(
|
|
23074
23128
|
self,
|
|
23075
23129
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty"]]:
|
|
23076
|
-
'''
|
|
23130
|
+
'''Configuration for using Amazon Bedrock foundation models to rerank search results.
|
|
23131
|
+
|
|
23132
|
+
This is required when the reranking type is set to BEDROCK.
|
|
23077
23133
|
|
|
23078
23134
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-vectorsearchrerankingconfiguration.html#cfn-bedrock-flowversion-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration
|
|
23079
23135
|
'''
|
|
@@ -32797,7 +32853,7 @@ class CfnPrompt(
|
|
|
32797
32853
|
|
|
32798
32854
|
:param any: The model must request at least one tool (no text is generated).
|
|
32799
32855
|
:param auto: (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
|
|
32800
|
-
:param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
|
|
32856
|
+
:param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.
|
|
32801
32857
|
|
|
32802
32858
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html
|
|
32803
32859
|
:exampleMetadata: fixture=_generated
|
|
@@ -32858,7 +32914,7 @@ class CfnPrompt(
|
|
|
32858
32914
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPrompt.SpecificToolChoiceProperty"]]:
|
|
32859
32915
|
'''The Model must request the specified tool.
|
|
32860
32916
|
|
|
32861
|
-
Only supported by Anthropic Claude 3 models.
|
|
32917
|
+
Only supported by Anthropic Claude 3 and Amazon Nova models.
|
|
32862
32918
|
|
|
32863
32919
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-toolchoice.html#cfn-bedrock-prompt-toolchoice-tool
|
|
32864
32920
|
'''
|
|
@@ -35119,7 +35175,7 @@ class CfnPromptVersion(
|
|
|
35119
35175
|
|
|
35120
35176
|
:param any: The model must request at least one tool (no text is generated).
|
|
35121
35177
|
:param auto: (Default). The Model automatically decides if a tool should be called or whether to generate text instead.
|
|
35122
|
-
:param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 models.
|
|
35178
|
+
:param tool: The Model must request the specified tool. Only supported by Anthropic Claude 3 and Amazon Nova models.
|
|
35123
35179
|
|
|
35124
35180
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html
|
|
35125
35181
|
:exampleMetadata: fixture=_generated
|
|
@@ -35180,7 +35236,7 @@ class CfnPromptVersion(
|
|
|
35180
35236
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnPromptVersion.SpecificToolChoiceProperty"]]:
|
|
35181
35237
|
'''The Model must request the specified tool.
|
|
35182
35238
|
|
|
35183
|
-
Only supported by Anthropic Claude 3 models.
|
|
35239
|
+
Only supported by Anthropic Claude 3 and Amazon Nova models.
|
|
35184
35240
|
|
|
35185
35241
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-toolchoice.html#cfn-bedrock-promptversion-toolchoice-tool
|
|
35186
35242
|
'''
|