Class NumberAttributeBoostingConfiguration

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.NumberAttributeBoostingConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<NumberAttributeBoostingConfiguration.Builder,NumberAttributeBoostingConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class NumberAttributeBoostingConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<NumberAttributeBoostingConfiguration.Builder,NumberAttributeBoostingConfiguration>

Provides information on boosting NUMBER type document attributes.

In the current boosting implementation, boosting focuses primarily on DATE attributes for recency and STRING attributes for source prioritization. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.

For more information on how boosting document attributes work in Amazon Q Business, see Boosting using document attributes.

See Also:

  • Method Details

    • boostingLevel

      public final DocumentAttributeBoostingLevel boostingLevel()

      Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.

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

      Returns:
      Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
      See Also:

    • boostingLevelAsString

      public final String boostingLevelAsString()

      Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.

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

      Returns:
      Specifies the priority of boosted document attributes in relation to other boosted attributes. This parameter determines how strongly the attribute influences document ranking in search results. NUMBER attributes can serve as additional boosting factors when needed, but are not supported when using NativeIndexConfiguration version 2.
      See Also:

    • boostingType

      public final NumberAttributeBoostingType boostingType()

      Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).

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

      Returns:
      Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).
      See Also:

    • boostingTypeAsString

      public final String boostingTypeAsString()

      Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).

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

      Returns:
      Specifies whether higher or lower numeric values should be prioritized when boosting. Valid values are ASCENDING (higher numbers are more important) and DESCENDING (lower numbers are more important).
      See Also:

    • toBuilder

      public NumberAttributeBoostingConfiguration.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<NumberAttributeBoostingConfiguration.Builder,NumberAttributeBoostingConfiguration>
      Returns:
      a builder for type T

    • builder

      public static NumberAttributeBoostingConfiguration.Builder builder()

    • serializableBuilderClass

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