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

Class RerankRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest

software.amazon.awssdk.services.bedrockagentruntime.model.RerankRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RerankRequest.Builder,RerankRequest>

@Generated("software.amazon.awssdk:codegen")
public final class RerankRequest
extends BedrockAgentRuntimeRequest
implements ToCopyableBuilder<RerankRequest.Builder,RerankRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RerankRequest.Builder

Method Summary

Modifier and Type	Method	Description
static RerankRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasQueries()	For responses, this returns true if the service returned a value for the Queries property.
boolean	hasSources()	For responses, this returns true if the service returned a value for the Sources property.
String	nextToken()	If the total number of results was greater than could fit in a response, a token is returned in the nextToken field.
List<RerankQuery>	queries()	An array of objects, each of which contains information about a query to submit to the reranker model.
RerankingConfiguration	rerankingConfiguration()	Contains configurations for reranking.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RerankRequest.Builder>	serializableBuilderClass()
List<RerankSource>	sources()	An array of objects, each of which contains information about the sources to rerank.
RerankRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

nextToken

public final String nextToken()

If the total number of results was greater than could fit in a response, a token is returned in the nextToken field. You can enter that token in this field to return the next batch of results.

Returns:

If the total number of results was greater than could fit in a response, a token is returned in the nextToken field. You can enter that token in this field to return the next batch of results.

hasQueries

public final boolean hasQueries()

For responses, this returns true if the service returned a value for the Queries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

queries

public final List<RerankQuery> queries()

An array of objects, each of which contains information about a query to submit to the reranker model.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueries() method.

Returns:

An array of objects, each of which contains information about a query to submit to the reranker model.

rerankingConfiguration

public final RerankingConfiguration rerankingConfiguration()

Contains configurations for reranking.

Returns:

Contains configurations for reranking.

hasSources

public final boolean hasSources()

For responses, this returns true if the service returned a value for the Sources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

sources

public final List<RerankSource> sources()

An array of objects, each of which contains information about the sources to rerank.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSources() method.

Returns:

An array of objects, each of which contains information about the sources to rerank.

toBuilder

public RerankRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RerankRequest.Builder,RerankRequest>

Specified by:

toBuilder in class BedrockAgentRuntimeRequest

builder

public static RerankRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

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