Class: AWSCDK::Bedrock::CfnFlowVersion::VectorSearchRerankingConfigurationProperty

Inherits:

Jsii::Struct

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

Defined in:

bedrock/cfn_flow_version.rb

Overview

Configuration for reranking vector search results to improve relevance.

Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.

See Also:

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

Instance Attribute Summary

• #bedrock_reranking_configuration ⇒ AWSCDK::IResolvable, ... readonly

  Configuration for using Amazon Bedrock foundation models to rerank search results.

• #type ⇒ String readonly

  The type of reranking to apply to vector search results.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(type:, bedrock_reranking_configuration: nil) ⇒ VectorSearchRerankingConfigurationProperty constructor

  A new instance of VectorSearchRerankingConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type:, bedrock_reranking_configuration: nil) ⇒ VectorSearchRerankingConfigurationProperty

Returns a new instance of VectorSearchRerankingConfigurationProperty.

Parameters:

• type (String) —

  The type of reranking to apply to vector search results.

• bedrock_reranking_configuration (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnFlowVersion::VectorSearchBedrockRerankingConfigurationProperty, nil) (defaults to: nil) —

  Configuration for using Amazon Bedrock foundation models to rerank search results.

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

def initialize(type:, bedrock_reranking_configuration: nil)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @bedrock_reranking_configuration = bedrock_reranking_configuration.is_a?(Hash) ? ::AWSCDK::Bedrock::CfnFlowVersion::VectorSearchBedrockRerankingConfigurationProperty.new(**bedrock_reranking_configuration.transform_keys(&:to_sym)) : bedrock_reranking_configuration
  Jsii::Type.check_type(@bedrock_reranking_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrLkNmbkZsb3dWZXJzaW9uLlZlY3RvclNlYXJjaEJlZHJvY2tSZXJhbmtpbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "bedrockRerankingConfiguration") unless @bedrock_reranking_configuration.nil?
end

Instance Attribute Details

#bedrock_reranking_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration for using Amazon Bedrock foundation models to rerank search results.

This is required when the reranking type is set to BEDROCK.

Returns:

• (AWSCDK::IResolvable, AWSCDK::Bedrock::CfnFlowVersion::VectorSearchBedrockRerankingConfigurationProperty, nil)

See Also:

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

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

def bedrock_reranking_configuration
  @bedrock_reranking_configuration
end

#type ⇒ String (readonly)

The type of reranking to apply to vector search results.

Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.

Returns:

• (String)

See Also:

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

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

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :type => "type",
    :bedrock_reranking_configuration => "bedrockRerankingConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "bedrockRerankingConfiguration" => @bedrock_reranking_configuration,
  })
  result.compact
end