Package software.amazon.awssdk.services.bedrock.model

Class VectorSearchBedrockRerankingConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrock.model.VectorSearchBedrockRerankingConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VectorSearchBedrockRerankingConfiguration.Builder,VectorSearchBedrockRerankingConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class VectorSearchBedrockRerankingConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VectorSearchBedrockRerankingConfiguration.Builder,VectorSearchBedrockRerankingConfiguration>

Configuration for using Amazon Bedrock foundation models to rerank Knowledge Base vector search results. This enables more sophisticated relevance ranking using large language models.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VectorSearchBedrockRerankingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static VectorSearchBedrockRerankingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MetadataConfigurationForReranking	metadataConfiguration()	Configuration for how document metadata should be used during the reranking process.
VectorSearchBedrockRerankingModelConfiguration	modelConfiguration()	Configuration for the Amazon Bedrock foundation model used for reranking.
Integer	numberOfRerankedResults()	The maximum number of results to rerank.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VectorSearchBedrockRerankingConfiguration.Builder>	serializableBuilderClass()
VectorSearchBedrockRerankingConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

modelConfiguration

public final VectorSearchBedrockRerankingModelConfiguration modelConfiguration()

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:

Configuration for the Amazon Bedrock foundation model used for reranking. This includes the model ARN and any additional request fields required by the model.

numberOfRerankedResults

public final Integer numberOfRerankedResults()

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.

Returns:

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.

metadataConfiguration

public final MetadataConfigurationForReranking metadataConfiguration()

Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.

Returns:

Configuration for how document metadata should be used during the reranking process. This determines which metadata fields are included when reordering search results.

toBuilder

public VectorSearchBedrockRerankingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VectorSearchBedrockRerankingConfiguration.Builder,VectorSearchBedrockRerankingConfiguration>

builder

public static VectorSearchBedrockRerankingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends VectorSearchBedrockRerankingConfiguration.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo