Package software.amazon.awscdk.services.bedrock

Interface CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFlow

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

Contains configurations for the metadata fields to include or exclude when considering reranking.

If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.

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-flow-rerankingmetadataselectivemodeconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty.Builder	builder()
default Object	getFieldsToExclude()	An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
default Object	getFieldsToInclude()	An array of objects, each of which specifies a metadata field to include in consideration when reranking.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFieldsToExclude

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

An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.

See Also:

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

getFieldsToInclude

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

An array of objects, each of which specifies a metadata field to include in consideration when reranking.

The remaining metadata fields are ignored.

See Also:

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

builder

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

Returns:

a CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty.Builder of CfnFlow.RerankingMetadataSelectiveModeConfigurationProperty