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

Class MetadataConfigurationForReranking

java.lang.Object

software.amazon.awssdk.services.bedrock.model.MetadataConfigurationForReranking

All Implemented Interfaces:

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

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

Configuration for how metadata should be used during the reranking process in Knowledge Base vector searches. This determines which metadata fields are included or excluded when reordering search results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetadataConfigurationForReranking.Builder

Method Summary

Modifier and Type	Method	Description
static MetadataConfigurationForReranking.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()
RerankingMetadataSelectionMode	selectionMode()	The mode for selecting which metadata fields to include in the reranking process.
String	selectionModeAsString()	The mode for selecting which metadata fields to include in the reranking process.
RerankingMetadataSelectiveModeConfiguration	selectiveModeConfiguration()	Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking.
static Class<? extends MetadataConfigurationForReranking.Builder>	serializableBuilderClass()
MetadataConfigurationForReranking.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

selectionMode

public final RerankingMetadataSelectionMode selectionMode()

The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).

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

Returns:

The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).

See Also:

RerankingMetadataSelectionMode

selectionModeAsString

public final String selectionModeAsString()

The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).

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

Returns:

The mode for selecting which metadata fields to include in the reranking process. Valid values are ALL (use all available metadata fields) or SELECTIVE (use only specified fields).

See Also:

RerankingMetadataSelectionMode

selectiveModeConfiguration

public final RerankingMetadataSelectiveModeConfiguration selectiveModeConfiguration()

Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.

Returns:

Configuration for selective mode, which allows you to explicitly include or exclude specific metadata fields during reranking. This is only used when selectionMode is set to SELECTIVE.

toBuilder

public MetadataConfigurationForReranking.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MetadataConfigurationForReranking.Builder,MetadataConfigurationForReranking>

builder

public static MetadataConfigurationForReranking.Builder builder()

serializableBuilderClass

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