interface VectorSearchBedrockRerankingConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.aws_bedrock.CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnFlowVersion_VectorSearchBedrockRerankingConfigurationProperty`
Java	`software.amazon.awscdk.services.bedrock.CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty`
Python	`aws_cdk.aws_bedrock.CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_bedrock` » `CfnFlowVersion` » `VectorSearchBedrockRerankingConfigurationProperty`

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 { aws_bedrock as bedrock } from 'aws-cdk-lib';

declare const additionalModelRequestFields: any;
const vectorSearchBedrockRerankingConfigurationProperty: bedrock.CfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty = {
  modelConfiguration: {
    modelArn: 'modelArn',

    // the properties below are optional
    additionalModelRequestFields: additionalModelRequestFields,
  },

  // the properties below are optional
  metadataConfiguration: {
    selectionMode: 'selectionMode',

    // the properties below are optional
    selectiveModeConfiguration: {
      fieldsToExclude: [{
        fieldName: 'fieldName',
      }],
      fieldsToInclude: [{
        fieldName: 'fieldName',
      }],
    },
  },
  numberOfRerankedResults: 123,
};

Properties

Name	Type	Description
modelConfiguration	`IResolvable` `\|` `VectorSearchBedrockRerankingModelConfigurationProperty`	Configuration for the Amazon Bedrock foundation model used for reranking.
metadataConfiguration?	`IResolvable` `\|` `MetadataConfigurationForRerankingProperty`	Configuration for how document metadata should be used during the reranking process.
numberOfRerankedResults?	`number`	The maximum number of results to rerank.

modelConfiguration

Type: IResolvable | VectorSearchBedrockRerankingModelConfigurationProperty

Configuration for the Amazon Bedrock foundation model used for reranking.

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

metadataConfiguration?

Type: IResolvable | MetadataConfigurationForRerankingProperty (optional)

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

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

numberOfRerankedResults?

Type: number (optional)

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.