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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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<MetadataConfigurationForReranking.Builder,MetadataConfigurationForReranking>
      Returns:
      a builder for type T

    • 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)
      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.