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

Class VectorSearchRerankingConfiguration

java.lang.Object

software.amazon.awssdk.services.bedrock.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>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VectorSearchRerankingConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
VectorSearchBedrockRerankingConfiguration	bedrockRerankingConfiguration()	Configuration for using Amazon Bedrock foundation models to rerank search results.
static VectorSearchRerankingConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends VectorSearchRerankingConfiguration.Builder>	serializableBuilderClass()
VectorSearchRerankingConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VectorSearchRerankingConfigurationType	type()	The type of reranking to apply to vector search results.
String	typeAsString()	The type of reranking to apply to vector search results.

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

type

public final VectorSearchRerankingConfigurationType type()

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.

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:

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:

VectorSearchRerankingConfigurationType

typeAsString

public final String typeAsString()

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.

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:

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:

VectorSearchRerankingConfigurationType

bedrockRerankingConfiguration

public final VectorSearchBedrockRerankingConfiguration bedrockRerankingConfiguration()

Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.

Returns:

Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.

toBuilder

public VectorSearchRerankingConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VectorSearchRerankingConfiguration.Builder,VectorSearchRerankingConfiguration>

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)

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