Interface CfnFlowVersion.VectorSearchRerankingConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnFlowVersion.VectorSearchRerankingConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnFlowVersion
@Stability(Stable)
public static interface CfnFlowVersion.VectorSearchRerankingConfigurationProperty
extends software.amazon.jsii.JsiiSerializable
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:
// 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;
VectorSearchRerankingConfigurationProperty vectorSearchRerankingConfigurationProperty = VectorSearchRerankingConfigurationProperty.builder()
.type("type")
// the properties below are optional
.bedrockRerankingConfiguration(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())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic final classAn implementation forCfnFlowVersion.VectorSearchRerankingConfigurationProperty -
Method Summary
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getType
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:
-
getBedrockRerankingConfiguration
Configuration for using Amazon Bedrock foundation models to rerank search results.This is required when the reranking type is set to BEDROCK.
Returns union: either
IResolvableorCfnFlowVersion.VectorSearchBedrockRerankingConfigurationProperty- See Also:
-
builder
@Stability(Stable) static CfnFlowVersion.VectorSearchRerankingConfigurationProperty.Builder builder()
-