Package software.amazon.awscdk.services.bedrock

Interface CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFlowVersion

@Stability(Stable)
public static interface CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 Object additionalModelRequestFields;
 VectorSearchBedrockRerankingModelConfigurationProperty vectorSearchBedrockRerankingModelConfigurationProperty = VectorSearchBedrockRerankingModelConfigurationProperty.builder()
         .modelArn("modelArn")
         // the properties below are optional
         .additionalModelRequestFields(additionalModelRequestFields)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty.Builder	A builder for CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty
static final class	CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty.Jsii$Proxy	An implementation for CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty.Builder	builder()
default Object	getAdditionalModelRequestFields()	A list of additional fields to include in the model request during reranking.
String	getModelArn()	The Amazon Resource Name (ARN) of the foundation model to use for reranking.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getModelArn

@Stability(Stable)
@NotNull
String getModelArn()

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.

See Also:

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

getAdditionalModelRequestFields

@Stability(Stable)
@Nullable
default Object getAdditionalModelRequestFields()

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.

See Also:

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

builder

@Stability(Stable)
static CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty.Builder builder()

Returns:

a CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty.Builder of CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty