com.amazonaws.services.kendra.model

Class RelevanceFeedback

java.lang.Object

com.amazonaws.services.kendra.model.RelevanceFeedback

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RelevanceFeedback
extends Object
implements Serializable, Cloneable, StructuredPojo

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RelevanceFeedback()

Method Summary

Modifier and Type	Method and Description
RelevanceFeedback	clone()
boolean	equals(Object obj)
String	getRelevanceValue() Whether the document was relevant or not relevant to the search.
String	getResultId() The identifier of the search result that the user provided relevance feedback for.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setRelevanceValue(String relevanceValue) Whether the document was relevant or not relevant to the search.
void	setResultId(String resultId) The identifier of the search result that the user provided relevance feedback for.
String	toString() Returns a string representation of this object.
RelevanceFeedback	withRelevanceValue(RelevanceType relevanceValue) Whether the document was relevant or not relevant to the search.
RelevanceFeedback	withRelevanceValue(String relevanceValue) Whether the document was relevant or not relevant to the search.
RelevanceFeedback	withResultId(String resultId) The identifier of the search result that the user provided relevance feedback for.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RelevanceFeedback

public RelevanceFeedback()

Method Detail

setResultId

public void setResultId(String resultId)

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

Parameters:

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

getResultId

public String getResultId()

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.

withResultId

public RelevanceFeedback withResultId(String resultId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setRelevanceValue

public void setRelevanceValue(String relevanceValue)

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

Parameters:

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

See Also:

RelevanceType

getRelevanceValue

public String getRelevanceValue()

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

Returns:

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

See Also:

RelevanceType

withRelevanceValue

public RelevanceFeedback withRelevanceValue(String relevanceValue)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RelevanceType

withRelevanceValue

public RelevanceFeedback withRelevanceValue(RelevanceType relevanceValue)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RelevanceType

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RelevanceFeedback clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.