Package software.amazon.awscdk.services.bedrock

Interface CfnFlowVersion.MetadataConfigurationForRerankingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowVersion.MetadataConfigurationForRerankingProperty.Jsii$Proxy

Enclosing class:

CfnFlowVersion

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

Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches.

This determines which metadata fields are included or excluded 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.*;
 MetadataConfigurationForRerankingProperty metadataConfigurationForRerankingProperty = MetadataConfigurationForRerankingProperty.builder()
         .selectionMode("selectionMode")
         // the properties below are optional
         .selectiveModeConfiguration(RerankingMetadataSelectiveModeConfigurationProperty.builder()
                 .fieldsToExclude(List.of(FieldForRerankingProperty.builder()
                         .fieldName("fieldName")
                         .build()))
                 .fieldsToInclude(List.of(FieldForRerankingProperty.builder()
                         .fieldName("fieldName")
                         .build()))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlowVersion.MetadataConfigurationForRerankingProperty.Builder	builder()
String	getSelectionMode()	The mode for selecting which metadata fields to include in the reranking process.
default Object	getSelectiveModeConfiguration()	Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSelectionMode

@Stability(Stable)
@NotNull
String getSelectionMode()

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).

See Also:

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

getSelectiveModeConfiguration

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

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.

See Also:

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

builder

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

Returns:

a CfnFlowVersion.MetadataConfigurationForRerankingProperty.Builder of CfnFlowVersion.MetadataConfigurationForRerankingProperty