Package software.amazon.awssdk.services.bedrockagentruntime.model

Class RerankResult

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RerankResult

All Implemented Interfaces:

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

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

Contains information about a document that was reranked.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RerankResult.Builder

Method Summary

Modifier and Type	Method	Description
static RerankResult.Builder	builder()
RerankDocument	document()	Contains information about the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	index()	The ranking of the document.
Float	relevanceScore()	The relevance score of the document.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RerankResult.Builder>	serializableBuilderClass()
RerankResult.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

document

public final RerankDocument document()

Contains information about the document.

Returns:

Contains information about the document.

index

public final Integer index()

The ranking of the document. The lower a number, the higher the document is ranked.

Returns:

The ranking of the document. The lower a number, the higher the document is ranked.

relevanceScore

public final Float relevanceScore()

The relevance score of the document.

Returns:

The relevance score of the document.

toBuilder

public RerankResult.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RerankResult.Builder,RerankResult>

builder

public static RerankResult.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo