Package software.amazon.awssdk.services.kendra.model

Class QueryResultItem

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

A single query result.

A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier for the query result item id (Id) and the query result item document id ( DocumentId) combined. The value of this field changes with every request, even when you have the same documents.

      Returns:
      The unique identifier for the query result item id (Id) and the query result item document id (DocumentId) combined. The value of this field changes with every request, even when you have the same documents.

    • type

      public final QueryResultType type()

      The type of document within the response. For example, a response could include a question-answer that's relevant to the query.

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

      Returns:
      The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of document within the response. For example, a response could include a question-answer that's relevant to the query.

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

      Returns:
      The type of document within the response. For example, a response could include a question-answer that's relevant to the query.
      See Also:

    • format

      public final QueryResultFormat format()

      If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.

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

      Returns:
      If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.
      See Also:

    • formatAsString

      public final String formatAsString()

      If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.

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

      Returns:
      If the Type of document within the response is ANSWER, then it is either a TABLE answer or TEXT answer. If it's a table answer, a table excerpt is returned in TableExcerpt. If it's a text answer, a text excerpt is returned in DocumentExcerpt.
      See Also:

    • hasAdditionalAttributes

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

    • additionalAttributes

      public final List<AdditionalResultAttribute> additionalAttributes()

      One or more additional fields/attributes associated with the query result.

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

      Returns:
      One or more additional fields/attributes associated with the query result.

    • documentId

      public final String documentId()

      The identifier for the document.

      Returns:
      The identifier for the document.

    • documentTitle

      public final TextWithHighlights documentTitle()

      The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

      Returns:
      The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.

    • documentExcerpt

      public final TextWithHighlights documentExcerpt()

      An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

      Returns:
      An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.

    • 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()

      Indicates the confidence level of Amazon Kendra providing a relevant result for the query. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

      The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result is relevant to the query.

      Returns:
      Indicates the confidence level of Amazon Kendra providing a relevant result for the query. Each result is placed into a bin that indicates the confidence, VERY_HIGH, HIGH, MEDIUM and LOW. You can use the score to determine if a response meets the confidence needed for your application.

      The field is only set to LOW when the Type field is set to DOCUMENT and Amazon Kendra is not confident that the result is relevant to the query.

    • feedbackToken

      public final String feedbackToken()

      A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

      Returns:
      A token that identifies a particular result from a particular query. Use this token to provide click-through feedback for the result. For more information, see Submitting feedback.

    • tableExcerpt

      public final TableExcerpt tableExcerpt()

      An excerpt from a table within a document.

      Returns:
      An excerpt from a table within a document.

    • collapsedResultDetail

      public final CollapsedResultDetail collapsedResultDetail()

      Provides details about a collapsed group of search results.

      Returns:
      Provides details about a collapsed group of search results.

    • toBuilder

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

    • builder

      public static QueryResultItem.Builder builder()

    • serializableBuilderClass

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