Class NativeIndexConfiguration

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

Configuration information for an Amazon Q Business index.

See Also:

  • Method Details

    • indexId

      public final String indexId()

      The identifier for the Amazon Q Business index.

      Returns:
      The identifier for the Amazon Q Business index.

    • version

      public final Long version()

      A read-only field that specifies the version of the NativeIndexConfiguration.

      Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of NativeIndexConfiguration, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:

      • Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting

      • Version 2 supports a single String field with an ordered list of up to 5 values

      • Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels

      • Version 2 allows specifying prioritization between Date and String fields

      • Version 2 maintains backward compatibility with existing configurations

      Returns:
      A read-only field that specifies the version of the NativeIndexConfiguration.

      Amazon Q Business introduces enhanced document retrieval capabilities in version 2 of NativeIndexConfiguration, focusing on streamlined metadata boosting that prioritizes recency and source relevance to deliver more accurate responses to your queries. Version 2 has the following differences from version 1:

      • Version 2 supports a single Date field (created_at OR last_updated_at) for recency boosting

      • Version 2 supports a single String field with an ordered list of up to 5 values

      • Version 2 introduces number-based boost levels (ONE, TWO) alongside the text-based levels

      • Version 2 allows specifying prioritization between Date and String fields

      • Version 2 maintains backward compatibility with existing configurations

    • hasBoostingOverride

      public final boolean hasBoostingOverride()
      For responses, this returns true if the service returned a value for the BoostingOverride property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • boostingOverride

      public final Map<String,DocumentAttributeBoostingConfiguration> boostingOverride()

      Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBoostingOverride() method.

      Returns:
      Overrides the default boosts applied by Amazon Q Business to supported document attribute data types.

    • toBuilder

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

    • builder

      public static NativeIndexConfiguration.Builder builder()

    • serializableBuilderClass

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