Class RelevanceFeedback
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic RelevanceFeedback.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final RelevanceType
Whether the document was relevant or not relevant to the search.final String
Whether the document was relevant or not relevant to the search.final String
resultId()
The identifier of the search result that the user provided relevance feedback for.static Class
<? extends RelevanceFeedback.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnRelevanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrelevanceValueAsString()
.- Returns:
- Whether the document was relevant or not relevant to the search.
- See Also:
-
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 returnRelevanceType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrelevanceValueAsString()
.- Returns:
- Whether the document was relevant or not relevant to the search.
- See Also:
-
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 interfaceToCopyableBuilder<RelevanceFeedback.Builder,
RelevanceFeedback> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-