Interface RerankRequest.Builder

All Superinterfaces:

AwsRequest.Builder, BedrockAgentRuntimeRequest.Builder, Buildable, CopyableBuilder<RerankRequest.Builder,RerankRequest>, SdkBuilder<RerankRequest.Builder,RerankRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RerankRequest

@Mutable
@NotThreadSafe
public static interface RerankRequest.Builder
extends BedrockAgentRuntimeRequest.Builder, SdkPojo, CopyableBuilder<RerankRequest.Builder,RerankRequest>

Method Summary

Modifier and Type	Method	Description
RerankRequest.Builder	nextToken(String nextToken)	If the total number of results was greater than could fit in a response, a token is returned in the nextToken field.
RerankRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
RerankRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
RerankRequest.Builder	queries(Collection<RerankQuery> queries)	An array of objects, each of which contains information about a query to submit to the reranker model.
RerankRequest.Builder	queries(Consumer<RerankQuery.Builder>... queries)	An array of objects, each of which contains information about a query to submit to the reranker model.
RerankRequest.Builder	queries(RerankQuery... queries)	An array of objects, each of which contains information about a query to submit to the reranker model.
default RerankRequest.Builder	rerankingConfiguration(Consumer<RerankingConfiguration.Builder> rerankingConfiguration)	Contains configurations for reranking.
RerankRequest.Builder	rerankingConfiguration(RerankingConfiguration rerankingConfiguration)	Contains configurations for reranking.
RerankRequest.Builder	sources(Collection<RerankSource> sources)	An array of objects, each of which contains information about the sources to rerank.
RerankRequest.Builder	sources(Consumer<RerankSource.Builder>... sources)	An array of objects, each of which contains information about the sources to rerank.
RerankRequest.Builder	sources(RerankSource... sources)	An array of objects, each of which contains information about the sources to rerank.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.BedrockAgentRuntimeRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

queries

RerankRequest.Builder queries(Collection<RerankQuery> queries)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

queries

RerankRequest.Builder queries(RerankQuery... queries)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

queries

RerankRequest.Builder queries(Consumer<RerankQuery.Builder>... queries)

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

This is a convenience method that creates an instance of the RerankQuery.Builder avoiding the need to create one manually via RerankQuery.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to queries(List<RerankQuery>).

Parameters:

queries - a consumer that will call methods on RerankQuery.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• queries(java.util.Collection<RerankQuery>)

sources

RerankRequest.Builder sources(Collection<RerankSource> sources)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sources

RerankRequest.Builder sources(RerankSource... sources)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sources

RerankRequest.Builder sources(Consumer<RerankSource.Builder>... sources)

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

This is a convenience method that creates an instance of the RerankSource.Builder avoiding the need to create one manually via RerankSource.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sources(List<RerankSource>).

Parameters:

sources - a consumer that will call methods on RerankSource.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• sources(java.util.Collection<RerankSource>)

rerankingConfiguration

RerankRequest.Builder rerankingConfiguration(RerankingConfiguration rerankingConfiguration)

Contains configurations for reranking.

Parameters:

rerankingConfiguration - Contains configurations for reranking.

Returns:

Returns a reference to this object so that method calls can be chained together.

rerankingConfiguration

default RerankRequest.Builder rerankingConfiguration(Consumer<RerankingConfiguration.Builder> rerankingConfiguration)

Contains configurations for reranking.

This is a convenience method that creates an instance of the RerankingConfiguration.Builder avoiding the need to create one manually via RerankingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to rerankingConfiguration(RerankingConfiguration).

Parameters:

rerankingConfiguration - a consumer that will call methods on RerankingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• rerankingConfiguration(RerankingConfiguration)

nextToken

RerankRequest.Builder nextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

RerankRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

RerankRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.