Class: AWSCDK::Bedrock::CfnFlowVersion::FieldForRerankingProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnFlowVersion::FieldForRerankingProperty

Defined in:

bedrock/cfn_flow_version.rb

Overview

Specifies a field to be used during the reranking process in a Knowledge Base vector search.

This structure identifies metadata fields that should be considered when reordering search results to improve relevance.

See Also:

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

Instance Attribute Summary

• #field_name ⇒ String readonly

  The name of the metadata field to be used during the reranking process.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_name:) ⇒ FieldForRerankingProperty constructor

  A new instance of FieldForRerankingProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_name:) ⇒ FieldForRerankingProperty

Returns a new instance of FieldForRerankingProperty.

Parameters:

• field_name (String) —

  The name of the metadata field to be used during the reranking process.

# File 'bedrock/cfn_flow_version.rb', line 647

def initialize(field_name:)
  @field_name = field_name
  Jsii::Type.check_type(@field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldName")
end

Instance Attribute Details

#field_name ⇒ String (readonly)

The name of the metadata field to be used during the reranking process.

Returns:

• (String)

See Also:

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

# File 'bedrock/cfn_flow_version.rb', line 656

def field_name
  @field_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_flow_version.rb', line 658

def self.jsii_properties
  {
    :field_name => "fieldName",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_flow_version.rb', line 664

def to_jsii
  result = {}
  result.merge!({
    "fieldName" => @field_name,
  })
  result.compact
end