Class RetrieveResultItem

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

A single retrieved relevant passage result.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the relevant passage result.

      Returns:
      The identifier of the relevant passage result.

    • documentId

      public final String documentId()

      The identifier of the document.

      Returns:
      The identifier of the document.

    • documentTitle

      public final String documentTitle()

      The title of the document.

      Returns:
      The title of the document.

    • content

      public final String content()

      The contents of the relevant passage.

      Returns:
      The contents of the relevant passage.

    • documentURI

      public final String documentURI()

      The URI of the original location of the document.

      Returns:
      The URI of the original location of the document.

    • hasDocumentAttributes

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

    • documentAttributes

      public final List<DocumentAttribute> documentAttributes()

      An array of document fields/attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

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

      Returns:
      An array of document fields/attributes assigned to a document in the search results. For example, the document author (_author) or the source URI (_source_uri) of the document.

    • scoreAttributes

      public final ScoreAttributes scoreAttributes()

      The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

      Returns:
      The confidence score bucket for a retrieved passage result. The confidence bucket provides a relative ranking that indicates how confident Amazon Kendra is that the response is relevant to the query.

    • toBuilder

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

    • builder

      public static RetrieveResultItem.Builder builder()

    • serializableBuilderClass

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