Class RelevanceFeedback

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

Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback API to provide relevance information.

See Also:

  • Method Details

    • resultId

      public final String resultId()

      The identifier of the search result that the user provided relevance feedback for.

      Returns:
      The identifier of the search result that the user provided relevance feedback for.

    • relevanceValue

      public final RelevanceType relevanceValue()

      Whether the document was relevant or not relevant to the search.

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

      Returns:
      Whether the document was relevant or not relevant to the search.
      See Also:

    • relevanceValueAsString

      public final String relevanceValueAsString()

      Whether the document was relevant or not relevant to the search.

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

      Returns:
      Whether the document was relevant or not relevant to the search.
      See Also:

    • toBuilder

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

    • builder

      public static RelevanceFeedback.Builder builder()

    • serializableBuilderClass

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