Package software.amazon.awssdk.services.kendraranking.model

Class Document

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

Information about a document from a search service such as OpenSearch (self managed). Amazon Kendra Intelligent Ranking uses this information to rank and score on.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the document from the search service.

      Returns:
      The identifier of the document from the search service.

    • groupId

      public final String groupId()

      The optional group identifier of the document from the search service. Documents with the same group identifier are grouped together and processed as one document within the service.

      Returns:
      The optional group identifier of the document from the search service. Documents with the same group identifier are grouped together and processed as one document within the service.

    • title

      public final String title()

      The title of the search service's document.

      Returns:
      The title of the search service's document.

    • body

      public final String body()

      The body text of the search service's document.

      Returns:
      The body text of the search service's document.

    • hasTokenizedTitle

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

    • tokenizedTitle

      public final List<String> tokenizedTitle()

      The title of the search service's document represented as a list of tokens or words. You must choose to provide Title or TokenizedTitle. You cannot provide both.

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

      Returns:
      The title of the search service's document represented as a list of tokens or words. You must choose to provide Title or TokenizedTitle. You cannot provide both.

    • hasTokenizedBody

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

    • tokenizedBody

      public final List<String> tokenizedBody()

      The body text of the search service's document represented as a list of tokens or words. You must choose to provide Body or TokenizedBody. You cannot provide both.

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

      Returns:
      The body text of the search service's document represented as a list of tokens or words. You must choose to provide Body or TokenizedBody. You cannot provide both.

    • originalScore

      public final Float originalScore()

      The original document score or rank from the search service. Amazon Kendra Intelligent Ranking gives the document a new score or rank based on its intelligent search algorithms.

      Returns:
      The original document score or rank from the search service. Amazon Kendra Intelligent Ranking gives the document a new score or rank based on its intelligent search algorithms.

    • toBuilder

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

    • builder

      public static Document.Builder builder()

    • serializableBuilderClass

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