Interface RescoreRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RescoreRequest.Builder,RescoreRequest>, KendraRankingRequest.Builder, SdkBuilder<RescoreRequest.Builder,RescoreRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RescoreRequest
@Mutable @NotThreadSafe public static interface RescoreRequest.Builder extends KendraRankingRequest.Builder, SdkPojo, CopyableBuilder<RescoreRequest.Builder,RescoreRequest>

  • Method Details

    • 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<Document>).

      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:

    • overrideConfiguration

      RescoreRequest.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

      RescoreRequest.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.