Class RerankDocument

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

Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.

See Also:

  • Method Details

    • jsonDocument

      public final Document jsonDocument()

      Contains a JSON document to rerank.

      Returns:
      Contains a JSON document to rerank.

    • textDocument

      public final RerankTextDocument textDocument()

      Contains information about a text document to rerank.

      Returns:
      Contains information about a text document to rerank.

    • type

      public final RerankDocumentType type()

      The type of document to rerank.

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

      Returns:
      The type of document to rerank.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of document to rerank.

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

      Returns:
      The type of document to rerank.
      See Also:

    • toBuilder

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

    • builder

      public static RerankDocument.Builder builder()

    • serializableBuilderClass

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