Class: AWSCDK::Bedrock::CfnFlow::FieldForRerankingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock/cfn_flow.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:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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.



774
775
776
777
 
# File 'bedrock/cfn_flow.rb', line 774

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:



783
784
785
 
# File 'bedrock/cfn_flow.rb', line 783

def field_name
  @field_name
end

Class Method Details

.jsii_properties ⇒ Object 



785
786
787
788
789
 
# File 'bedrock/cfn_flow.rb', line 785

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

Instance Method Details

#to_jsii ⇒ Object 



791
792
793
794
795
796
797
 
# File 'bedrock/cfn_flow.rb', line 791

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