software.amazon.awssdk.services.kendraranking.model

Interface RescoreRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<RescoreRequest.Builder,RescoreRequest>, KendraRankingRequest.Builder, SdkBuilder<RescoreRequest.Builder,RescoreRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

RescoreRequest

public static interface RescoreRequest.Builder
extends KendraRankingRequest.Builder, SdkPojo, CopyableBuilder<RescoreRequest.Builder,RescoreRequest>

Method Summary

Modifier and Type	Method and Description
RescoreRequest.Builder	documents(Collection<Document> documents) The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
RescoreRequest.Builder	documents(Consumer<Document.Builder>... documents) The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
RescoreRequest.Builder	documents(Document... documents) The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.
RescoreRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
RescoreRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
RescoreRequest.Builder	rescoreExecutionPlanId(String rescoreExecutionPlanId) The identifier of the rescore execution plan.
RescoreRequest.Builder	searchQuery(String searchQuery) The input query from the search service.

Methods inherited from interface software.amazon.awssdk.services.kendraranking.model.KendraRankingRequest.Builder

build

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

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

rescoreExecutionPlanId

RescoreRequest.Builder rescoreExecutionPlanId(String rescoreExecutionPlanId)

The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Parameters:

rescoreExecutionPlanId - The identifier of the rescore execution plan. A rescore execution plan is an Amazon Kendra Intelligent Ranking resource used for provisioning the Rescore API.

Returns:

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

searchQuery

RescoreRequest.Builder searchQuery(String searchQuery)

The input query from the search service.

Parameters:

searchQuery - The input query from the search service.

Returns:

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

documents

RescoreRequest.Builder documents(Collection<Document> documents)

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Parameters:

documents - The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Returns:

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

documents

RescoreRequest.Builder documents(Document... documents)

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Parameters:

documents - The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

Returns:

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

documents

RescoreRequest.Builder documents(Consumer<Document.Builder>... documents)

The list of documents for Amazon Kendra Intelligent Ranking to rescore or rank on.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #documents(List).

Parameters:

documents - a consumer that will call methods on Document.Builder

Returns:

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

See Also:

#documents(java.util.Collection)

overrideConfiguration

RescoreRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder