Package software.amazon.awssdk.services.kendraranking.model

Class RescoreResultItem

java.lang.Object

software.amazon.awssdk.services.kendraranking.model.RescoreResultItem

All Implemented Interfaces:

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

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

A result item for a document with a new relevancy score.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RescoreResultItem.Builder

Method Summary

Modifier and Type	Method	Description
static RescoreResultItem.Builder	builder()
String	documentId()	The identifier of the document from the search service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Float	score()	The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the result.
List<SdkField<?>>	sdkFields()
static Class<? extends RescoreResultItem.Builder>	serializableBuilderClass()
RescoreResultItem.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

documentId

public final String documentId()

The identifier of the document from the search service.

Returns:

The identifier of the document from the search service.

score

public final Float score()

The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the result.

Returns:

The relevancy score or rank that Amazon Kendra Intelligent Ranking gives to the result.

toBuilder

public RescoreResultItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RescoreResultItem.Builder,RescoreResultItem>

builder

public static RescoreResultItem.Builder builder()

serializableBuilderClass

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