Package software.amazon.awssdk.services.bedrockagent.model

Class VectorSearchBedrockRerankingModelConfiguration

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

Configures the Amazon Bedrock model used for reranking retrieved results.

See Also:

  • Method Details

    • modelArn

      public final String modelArn()

      The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.

      Returns:
      The Amazon Resource Name (ARN) of the Amazon Bedrock reranker model.

    • hasAdditionalModelRequestFields

      public final boolean hasAdditionalModelRequestFields()
      For responses, this returns true if the service returned a value for the AdditionalModelRequestFields 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.

    • additionalModelRequestFields

      public final Map<String,Document> additionalModelRequestFields()

      Specifies additional model-specific request parameters as key-value pairs that are included in the request to the Amazon Bedrock reranker model.

      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 hasAdditionalModelRequestFields() method.

      Returns:
      Specifies additional model-specific request parameters as key-value pairs that are included in the request to the Amazon Bedrock reranker model.

    • toBuilder

      public VectorSearchBedrockRerankingModelConfiguration.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<VectorSearchBedrockRerankingModelConfiguration.Builder,VectorSearchBedrockRerankingModelConfiguration>

    • builder

      public static VectorSearchBedrockRerankingModelConfiguration.Builder builder()

    • serializableBuilderClass

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