2.233.0

interface VectorSearchRerankingConfigurationProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnFlowPropsMixin.VectorSearchRerankingConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnFlowPropsMixin_VectorSearchRerankingConfigurationProperty
Javasoftware.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnFlowPropsMixin.VectorSearchRerankingConfigurationProperty
Pythonaws_cdk.mixins_preview.aws_bedrock.mixins.CfnFlowPropsMixin.VectorSearchRerankingConfigurationProperty
TypeScript @aws-cdk/mixins-preview » aws_bedrock » mixins » CfnFlowPropsMixin » VectorSearchRerankingConfigurationProperty

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';

declare const additionalModelRequestFields: any;
const vectorSearchRerankingConfigurationProperty: bedrock_mixins.CfnFlowPropsMixin.VectorSearchRerankingConfigurationProperty = {
  bedrockRerankingConfiguration: {
    metadataConfiguration: {
      selectionMode: 'selectionMode',
      selectiveModeConfiguration: {
        fieldsToExclude: [{
          fieldName: 'fieldName',
        }],
        fieldsToInclude: [{
          fieldName: 'fieldName',
        }],
      },
    },
    modelConfiguration: {
      additionalModelRequestFields: additionalModelRequestFields,
      modelArn: 'modelArn',
    },
    numberOfRerankedResults: 123,
  },
  type: 'type',
};

Properties

NameTypeDescription
bedrockRerankingConfiguration?IResolvable | VectorSearchBedrockRerankingConfigurationPropertyConfiguration for using Amazon Bedrock foundation models to rerank search results.
type?stringThe type of reranking to apply to vector search results.

bedrockRerankingConfiguration?

Type: IResolvable | VectorSearchBedrockRerankingConfigurationProperty (optional)

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchrerankingconfiguration-bedrockrerankingconfiguration

type?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-flow-vectorsearchrerankingconfiguration.html#cfn-bedrock-flow-vectorsearchrerankingconfiguration-type

← PreviousNext →