software.amazon.awssdk.services.kendra.model

Class ScoreAttributes

java.lang.Object

software.amazon.awssdk.services.kendra.model.ScoreAttributes

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScoreAttributes.Builder,ScoreAttributes>

@Generated(value="software.amazon.awssdk:codegen")
public final class ScoreAttributes
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScoreAttributes.Builder,ScoreAttributes>

Provides a relative ranking that indicates how confident Amazon Kendra is that the response matches the query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScoreAttributes.Builder

Method Summary

Modifier and Type	Method and Description
static ScoreAttributes.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ScoreConfidence	scoreConfidence() A relative ranking for how well the response matches the query.
String	scoreConfidenceAsString() A relative ranking for how well the response matches the query.
List<SdkField<?>>	sdkFields()
static Class<? extends ScoreAttributes.Builder>	serializableBuilderClass()
ScoreAttributes.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

scoreConfidence

public ScoreConfidence scoreConfidence()

A relative ranking for how well the response matches the query.

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

Returns:

A relative ranking for how well the response matches the query.

See Also:

ScoreConfidence

scoreConfidenceAsString

public String scoreConfidenceAsString()

A relative ranking for how well the response matches the query.

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

Returns:

A relative ranking for how well the response matches the query.

See Also:

ScoreConfidence

toBuilder

public ScoreAttributes.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScoreAttributes.Builder,ScoreAttributes>

builder

public static ScoreAttributes.Builder builder()

serializableBuilderClass

public static Class<? extends ScoreAttributes.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo