Interface RerankResponse.Builder

All Superinterfaces:

AwsResponse.Builder, BedrockAgentRuntimeResponse.Builder, Buildable, CopyableBuilder<RerankResponse.Builder,RerankResponse>, SdkBuilder<RerankResponse.Builder,RerankResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

RerankResponse

@Mutable
@NotThreadSafe
public static interface RerankResponse.Builder
extends BedrockAgentRuntimeResponse.Builder, SdkPojo, CopyableBuilder<RerankResponse.Builder,RerankResponse>

Method Summary

Modifier and Type	Method	Description
RerankResponse.Builder	nextToken(String nextToken)	If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.
RerankResponse.Builder	results(Collection<RerankResult> results)	An array of objects, each of which contains information about the results of reranking.
RerankResponse.Builder	results(Consumer<RerankResult.Builder>... results)	An array of objects, each of which contains information about the results of reranking.
RerankResponse.Builder	results(RerankResult... results)	An array of objects, each of which contains information about the results of reranking.

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

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

results

RerankResponse.Builder results(Collection<RerankResult> results)

An array of objects, each of which contains information about the results of reranking.

Parameters:

results - An array of objects, each of which contains information about the results of reranking.

Returns:

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

results

RerankResponse.Builder results(RerankResult... results)

An array of objects, each of which contains information about the results of reranking.

Parameters:

results - An array of objects, each of which contains information about the results of reranking.

Returns:

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

results

RerankResponse.Builder results(Consumer<RerankResult.Builder>... results)

An array of objects, each of which contains information about the results of reranking.

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

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

Parameters:

results - a consumer that will call methods on RerankResult.Builder

Returns:

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

See Also:

• results(java.util.Collection<RerankResult>)

nextToken

RerankResponse.Builder nextToken(String nextToken)

If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.

Parameters:

nextToken - If the total number of results is greater than can fit in the response, use this token in the nextToken field when making another request to return the next batch of results.

Returns:

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