Class CfnFlow.MetadataConfigurationForRerankingProperty

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

Inheritance

object

CfnFlow.MetadataConfigurationForRerankingProperty

Implements

CfnFlow.IMetadataConfigurationForRerankingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Bedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFlow.MetadataConfigurationForRerankingProperty : CfnFlow.IMetadataConfigurationForRerankingProperty

Syntax (vb)

Public Class CfnFlow.MetadataConfigurationForRerankingProperty Implements CfnFlow.IMetadataConfigurationForRerankingProperty

Remarks

This determines which metadata fields are included or excluded when reordering search results.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock;

             var metadataConfigurationForRerankingProperty = new MetadataConfigurationForRerankingProperty {
                 SelectionMode = "selectionMode",

                 // the properties below are optional
                 SelectiveModeConfiguration = new RerankingMetadataSelectiveModeConfigurationProperty {
                     FieldsToExclude = new [] { new FieldForRerankingProperty {
                         FieldName = "fieldName"
                     } },
                     FieldsToInclude = new [] { new FieldForRerankingProperty {
                         FieldName = "fieldName"
                     } }
                 }
             };

Synopsis

Constructors

MetadataConfigurationForRerankingProperty()

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

Properties

SelectionMode	The mode for selecting which metadata fields to include in the reranking process.
SelectiveModeConfiguration	Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking.

Constructors

MetadataConfigurationForRerankingProperty()

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

public MetadataConfigurationForRerankingProperty()

Remarks

This determines which metadata fields are included or excluded when reordering search results.

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock;

             var metadataConfigurationForRerankingProperty = new MetadataConfigurationForRerankingProperty {
                 SelectionMode = "selectionMode",

                 // the properties below are optional
                 SelectiveModeConfiguration = new RerankingMetadataSelectiveModeConfigurationProperty {
                     FieldsToExclude = new [] { new FieldForRerankingProperty {
                         FieldName = "fieldName"
                     } },
                     FieldsToInclude = new [] { new FieldForRerankingProperty {
                         FieldName = "fieldName"
                     } }
                 }
             };

Properties

SelectionMode

The mode for selecting which metadata fields to include in the reranking process.

public string SelectionMode { get; set; }

Property Value

string

Remarks

Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).

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

SelectiveModeConfiguration

Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking.

public object? SelectiveModeConfiguration { get; set; }

Property Value

object

Remarks

This is only used when selectionMode is set to SELECTIVE.

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

Type union: either IResolvable or CfnFlow.IRerankingMetadataSelectiveModeConfigurationProperty

Implements

CfnFlow.IMetadataConfigurationForRerankingProperty