Class VectorSearchRerankingConfiguration

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

Configuration for reranking vector search results to improve relevance. Reranking applies additional relevance models to reorder the initial vector search results based on more sophisticated criteria.

See Also:

  • Method Details

    • type

      public final VectorSearchRerankingConfigurationType type()

      The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.

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

      Returns:
      The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.

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

      Returns:
      The type of reranking to apply to vector search results. Currently, the only supported value is BEDROCK, which uses Amazon Bedrock foundation models for reranking.
      See Also:

    • bedrockRerankingConfiguration

      public final VectorSearchBedrockRerankingConfiguration bedrockRerankingConfiguration()

      Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.

      Returns:
      Configuration for using Amazon Bedrock foundation models to rerank search results. This is required when the reranking type is set to BEDROCK.

    • toBuilder

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

    • builder

      public static VectorSearchRerankingConfiguration.Builder builder()

    • serializableBuilderClass

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