Skip to content
v2.273.0

VectorSearchRerankingConfigurationProperty Struct ​

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.

Example ​

ts
// 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 vectorSearchRerankingConfigurationProperty: bedrock.CfnFlowVersion.VectorSearchRerankingConfigurationProperty = {
  type: 'type',

  // the properties below are optional
  bedrockRerankingConfiguration: {
    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 ​

bedrockRerankingConfigurationIResolvable | CfnFlowVersion.VectorSearchBedrockRerankingConfigurationPropertybedrock_reranking_configurationtyping.Union[IResolvable, VectorSearchBedrockRerankingConfigurationProperty]bedrockRerankingConfigurationIResolvableBedrockRerankingConfigurationIResolvableBedrockRerankingConfigurationinterface{}#
Configuration for using Amazon Bedrock foundation models to rerank search results.

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

typestringtypestrtypeStringTypestringType*stringrequired#
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.