Class: AWSCDK::Bedrock::CfnFlow::VectorSearchBedrockRerankingModelConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnFlow::VectorSearchBedrockRerankingModelConfigurationProperty

Defined in:

bedrock/cfn_flow.rb

Overview

Configuration for the Amazon Bedrock foundation model used for reranking vector search results.

This specifies which model to use and any additional parameters required by the model.

See Also:

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

Instance Attribute Summary

• #additional_model_request_fields ⇒ Object^? readonly

  A list of additional fields to include in the model request during reranking.

• #model_arn ⇒ String readonly

  The Amazon Resource Name (ARN) of the foundation model to use for reranking.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(model_arn:, additional_model_request_fields: nil) ⇒ VectorSearchBedrockRerankingModelConfigurationProperty constructor

  A new instance of VectorSearchBedrockRerankingModelConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(model_arn:, additional_model_request_fields: nil) ⇒ VectorSearchBedrockRerankingModelConfigurationProperty

Returns a new instance of VectorSearchBedrockRerankingModelConfigurationProperty.

Parameters:

• model_arn (String) —

  The Amazon Resource Name (ARN) of the foundation model to use for reranking.

• additional_model_request_fields (Object, nil) (defaults to: nil) —

  A list of additional fields to include in the model request during reranking.

# File 'bedrock/cfn_flow.rb', line 2841

def initialize(model_arn:, additional_model_request_fields: nil)
  @model_arn = model_arn
  Jsii::Type.check_type(@model_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "modelArn")
  @additional_model_request_fields = additional_model_request_fields
  Jsii::Type.check_type(@additional_model_request_fields, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "additionalModelRequestFields") unless @additional_model_request_fields.nil?
end

Instance Attribute Details

#additional_model_request_fields ⇒ Object^? (readonly)

A list of additional fields to include in the model request during reranking.

These fields provide extra context or configuration options specific to the selected foundation model.

Returns:

• (Object, nil)

See Also:

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

# File 'bedrock/cfn_flow.rb', line 2861

def additional_model_request_fields
  @additional_model_request_fields
end

#model_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the foundation model to use for reranking.

This model processes the query and search results to determine a more relevant ordering.

Returns:

• (String)

See Also:

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

# File 'bedrock/cfn_flow.rb', line 2854

def model_arn
  @model_arn
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_flow.rb', line 2863

def self.jsii_properties
  {
    :model_arn => "modelArn",
    :additional_model_request_fields => "additionalModelRequestFields",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_flow.rb', line 2870

def to_jsii
  result = {}
  result.merge!({
    "modelArn" => @model_arn,
    "additionalModelRequestFields" => @additional_model_request_fields,
  })
  result.compact
end