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

Class RerankDocument

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RerankDocument

All Implemented Interfaces:

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

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

Contains information about a document to rerank. Choose the type to define and include the field that corresponds to the type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RerankDocument.Builder

Method Summary

Modifier and Type	Method	Description
static RerankDocument.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Document	jsonDocument()	Contains a JSON document to rerank.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RerankDocument.Builder>	serializableBuilderClass()
RerankTextDocument	textDocument()	Contains information about a text document to rerank.
RerankDocument.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RerankDocumentType	type()	The type of document to rerank.
String	typeAsString()	The type of document to rerank.

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

jsonDocument

public final Document jsonDocument()

Contains a JSON document to rerank.

Returns:

Contains a JSON document to rerank.

textDocument

public final RerankTextDocument textDocument()

Contains information about a text document to rerank.

Returns:

Contains information about a text document to rerank.

type

public final RerankDocumentType type()

The type of document to rerank.

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

Returns:

The type of document to rerank.

See Also:

RerankDocumentType

typeAsString

public final String typeAsString()

The type of document to rerank.

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

Returns:

The type of document to rerank.

See Also:

RerankDocumentType

toBuilder

public RerankDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RerankDocument.Builder,RerankDocument>

builder

public static RerankDocument.Builder builder()

serializableBuilderClass

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