Class VectorSearchRerankingConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.VectorSearchRerankingConfiguration

All Implemented Interfaces:

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

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

Specifies how retrieved results from a knowledge base are reranked to improve relevance.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VectorSearchRerankingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
final VectorSearchBedrockRerankingConfiguration	bedrockRerankingConfiguration()	Specifies the configuration for using an Amazon Bedrock reranker model to rerank retrieved results.
static VectorSearchRerankingConfiguration.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends VectorSearchRerankingConfiguration.Builder>	serializableBuilderClass()
VectorSearchRerankingConfiguration.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.
final VectorSearchRerankingConfigurationType	type()	Specifies the type of reranking model to use.
final String	typeAsString()	Specifies the type of reranking model to use.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

type

public final VectorSearchRerankingConfigurationType type()

Specifies the type of reranking model to use. Currently, the only supported value is BEDROCK_RERANKING_MODEL.

If the service returns an enum value that is not available in the current SDK version, type will return VectorSearchRerankingConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies the type of reranking model to use. Currently, the only supported value is BEDROCK_RERANKING_MODEL.

See Also:

• VectorSearchRerankingConfigurationType

typeAsString

public final String typeAsString()

Specifies the type of reranking model to use. Currently, the only supported value is BEDROCK_RERANKING_MODEL.

If the service returns an enum value that is not available in the current SDK version, type will return VectorSearchRerankingConfigurationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies the type of reranking model to use. Currently, the only supported value is BEDROCK_RERANKING_MODEL.

See Also:

• VectorSearchRerankingConfigurationType

bedrockRerankingConfiguration

public final VectorSearchBedrockRerankingConfiguration bedrockRerankingConfiguration()

Specifies the configuration for using an Amazon Bedrock reranker model to rerank retrieved results.

Returns:

Specifies the configuration for using an Amazon Bedrock reranker model to rerank retrieved results.

toBuilder

public VectorSearchRerankingConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<VectorSearchRerankingConfiguration.Builder,VectorSearchRerankingConfiguration>

Returns:

a builder for type T

builder

public static VectorSearchRerankingConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends VectorSearchRerankingConfiguration.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.