Package software.amazon.awssdk.services.bedrockagentruntime.model

Class MetadataConfigurationForReranking

java.lang.Object

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

Contains configurations for the metadata to use in reranking.

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()	Specifies whether to consider all metadata when reranking, or only the metadata that you select.
String	selectionModeAsString()	Specifies whether to consider all metadata when reranking, or only the metadata that you select.
RerankingMetadataSelectiveModeConfiguration	selectiveModeConfiguration()	Contains configurations for the metadata fields to include or exclude when considering 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()

Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.

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:

Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.

See Also:

RerankingMetadataSelectionMode

selectionModeAsString

public final String selectionModeAsString()

Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.

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:

Specifies whether to consider all metadata when reranking, or only the metadata that you select. If you specify SELECTIVE, include the selectiveModeConfiguration field.

See Also:

RerankingMetadataSelectionMode

selectiveModeConfiguration

public final RerankingMetadataSelectiveModeConfiguration selectiveModeConfiguration()

Contains configurations for the metadata fields to include or exclude when considering reranking.

Returns:

Contains configurations for the metadata fields to include or exclude when considering reranking.

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