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

Class RerankQuery

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.RerankQuery

All Implemented Interfaces:

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

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

Contains information about a query to submit to the reranker model.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RerankQuery.Builder

Method Summary

Modifier and Type	Method	Description
static RerankQuery.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RerankQuery.Builder>	serializableBuilderClass()
RerankTextDocument	textQuery()	Contains information about a text query.
RerankQuery.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RerankQueryContentType	type()	The type of the query.
String	typeAsString()	The type of the query.

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

textQuery

public final RerankTextDocument textQuery()

Contains information about a text query.

Returns:

Contains information about a text query.

type

public final RerankQueryContentType type()

The type of the query.

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

Returns:

The type of the query.

See Also:

RerankQueryContentType

typeAsString

public final String typeAsString()

The type of the query.

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

Returns:

The type of the query.

See Also:

RerankQueryContentType

toBuilder

public RerankQuery.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RerankQuery.Builder,RerankQuery>

builder

public static RerankQuery.Builder builder()

serializableBuilderClass

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