Package software.amazon.awscdk.services.bedrock

Interface CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFlowVersion

@Stability(Stable)
public static interface CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for selectively including or excluding metadata fields during the reranking process.

This allows you to control which metadata attributes are considered when reordering search results.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 RerankingMetadataSelectiveModeConfigurationProperty rerankingMetadataSelectiveModeConfigurationProperty = RerankingMetadataSelectiveModeConfigurationProperty.builder()
         .fieldsToExclude(List.of(FieldForRerankingProperty.builder()
                 .fieldName("fieldName")
                 .build()))
         .fieldsToInclude(List.of(FieldForRerankingProperty.builder()
                 .fieldName("fieldName")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty.Builder	A builder for CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty
static final class	CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty.Jsii$Proxy	An implementation for CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty.Builder	builder()
default Object	getFieldsToExclude()	A list of metadata field names to explicitly exclude from the reranking process.
default Object	getFieldsToInclude()	A list of metadata field names to explicitly include in the reranking process.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFieldsToExclude

@Stability(Stable)
@Nullable
default Object getFieldsToExclude()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoexclude

getFieldsToInclude

@Stability(Stable)
@Nullable
default Object getFieldsToInclude()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration.html#cfn-bedrock-flowversion-rerankingmetadataselectivemodeconfiguration-fieldstoinclude

builder

@Stability(Stable)
static CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty.Builder builder()

Returns:

a CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty.Builder of CfnFlowVersion.RerankingMetadataSelectiveModeConfigurationProperty