software.amazon.awssdk.services.kendra.model

Interface DocumentRelevanceConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DocumentRelevanceConfiguration.Builder,DocumentRelevanceConfiguration>, SdkBuilder<DocumentRelevanceConfiguration.Builder,DocumentRelevanceConfiguration>, SdkPojo

Enclosing class:

DocumentRelevanceConfiguration

public static interface DocumentRelevanceConfiguration.Builder
extends SdkPojo, CopyableBuilder<DocumentRelevanceConfiguration.Builder,DocumentRelevanceConfiguration>

Method Summary

Modifier and Type	Method and Description
DocumentRelevanceConfiguration.Builder	name(String name) The name of the index field.
default DocumentRelevanceConfiguration.Builder	relevance(Consumer<Relevance.Builder> relevance) Provides information for tuning the relevance of a field in a search.
DocumentRelevanceConfiguration.Builder	relevance(Relevance relevance) Provides information for tuning the relevance of a field in a search.

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

name

DocumentRelevanceConfiguration.Builder name(String name)

The name of the index field.

Parameters:

name - The name of the index field.

Returns:

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

relevance

DocumentRelevanceConfiguration.Builder relevance(Relevance relevance)

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

Parameters:

relevance - Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

Returns:

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

relevance

default DocumentRelevanceConfiguration.Builder relevance(Consumer<Relevance.Builder> relevance)

Provides information for tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.

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

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

Parameters:

relevance - a consumer that will call methods on Relevance.Builder

Returns:

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

See Also:

relevance(Relevance)