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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RelevanceFeedback.Builder

Method Summary

Modifier and Type	Method	Description
static RelevanceFeedback.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RelevanceType	relevanceValue()	Whether the document was relevant or not relevant to the search.
String	relevanceValueAsString()	Whether the document was relevant or not relevant to the search.
String	resultId()	The identifier of the search result that the user provided relevance feedback for.
List<SdkField<?>>	sdkFields()
static Class<? extends RelevanceFeedback.Builder>	serializableBuilderClass()
RelevanceFeedback.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

RelevanceType

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:

RelevanceType

toBuilder

public RelevanceFeedback.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RelevanceFeedback.Builder,RelevanceFeedback>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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