Package software.amazon.awscdk.services.bedrock

Interface CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFlowVersion

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

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

This enables more sophisticated relevance ranking using large language models.

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;
 VectorSearchBedrockRerankingConfigurationProperty vectorSearchBedrockRerankingConfigurationProperty = VectorSearchBedrockRerankingConfigurationProperty.builder()
         .modelConfiguration(VectorSearchBedrockRerankingModelConfigurationProperty.builder()
                 .modelArn("modelArn")
                 // the properties below are optional
                 .additionalModelRequestFields(additionalModelRequestFields)
                 .build())
         // the properties below are optional
         .metadataConfiguration(MetadataConfigurationForRerankingProperty.builder()
                 .selectionMode("selectionMode")
                 // the properties below are optional
                 .selectiveModeConfiguration(RerankingMetadataSelectiveModeConfigurationProperty.builder()
                         .fieldsToExclude(List.of(FieldForRerankingProperty.builder()
                                 .fieldName("fieldName")
                                 .build()))
                         .fieldsToInclude(List.of(FieldForRerankingProperty.builder()
                                 .fieldName("fieldName")
                                 .build()))
                         .build())
                 .build())
         .numberOfRerankedResults(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty.Builder	builder()
default Object	getMetadataConfiguration()	Configuration for how document metadata should be used during the reranking process.
Object	getModelConfiguration()	Configuration for the Amazon Bedrock foundation model used for reranking.
default Number	getNumberOfRerankedResults()	The maximum number of results to rerank.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getModelConfiguration

@Stability(Stable)
@NotNull
Object getModelConfiguration()

Configuration for the Amazon Bedrock foundation model used for reranking.

This includes the model ARN and any additional request fields required by the model.

Returns union: either IResolvable or CfnFlowVersion.VectorSearchBedrockRerankingModelConfigurationProperty

See Also:

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

getMetadataConfiguration

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

Configuration for how document metadata should be used during the reranking process.

This determines which metadata fields are included when reordering search results.

Returns union: either IResolvable or CfnFlowVersion.MetadataConfigurationForRerankingProperty

See Also:

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

getNumberOfRerankedResults

@Stability(Stable)
@Nullable
default Number getNumberOfRerankedResults()

The maximum number of results to rerank.

This limits how many of the initial vector search results will be processed by the reranking model. A smaller number improves performance but may exclude potentially relevant results.

See Also:

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

builder

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

Returns:

a CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty.Builder of CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty