Interface ManagedSearchConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ManagedSearchConfiguration

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

Method Summary

Modifier and Type	Method	Description
default ManagedSearchConfiguration.Builder	filter(Consumer<RetrievalFilter.Builder> filter)	Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.
ManagedSearchConfiguration.Builder	filter(RetrievalFilter filter)	Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.
ManagedSearchConfiguration.Builder	numberOfResults(Integer numberOfResults)	The number of results to retrieve.
default ManagedSearchConfiguration.Builder	rerankingConfiguration(Consumer<ManagedSearchRerankingConfiguration.Builder> rerankingConfiguration)	Contains configurations for reranking the results retrieved from the managed search.
ManagedSearchConfiguration.Builder	rerankingConfiguration(ManagedSearchRerankingConfiguration rerankingConfiguration)	Contains configurations for reranking the results retrieved from the managed search.
ManagedSearchConfiguration.Builder	rerankingModelType(String rerankingModelType)	The type of reranking model to use when reranking results retrieved from the managed search.
ManagedSearchConfiguration.Builder	rerankingModelType(RerankingModelType rerankingModelType)	The type of reranking model to use when reranking results retrieved from the managed search.

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

filter

ManagedSearchConfiguration.Builder filter(RetrievalFilter filter)

Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.

Parameters:

filter - Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.

Returns:

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

filter

default ManagedSearchConfiguration.Builder filter(Consumer<RetrievalFilter.Builder> filter)

Filters the metadata of the retrieved results so that Amazon Bedrock returns only results that match the filter.

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

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

Parameters:

filter - a consumer that will call methods on RetrievalFilter.Builder

Returns:

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

See Also:

• filter(RetrievalFilter)

numberOfResults

ManagedSearchConfiguration.Builder numberOfResults(Integer numberOfResults)

The number of results to retrieve.

Parameters:

numberOfResults - The number of results to retrieve.

Returns:

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

rerankingConfiguration

ManagedSearchConfiguration.Builder rerankingConfiguration(ManagedSearchRerankingConfiguration rerankingConfiguration)

Contains configurations for reranking the results retrieved from the managed search.

Parameters:

rerankingConfiguration - Contains configurations for reranking the results retrieved from the managed search.

Returns:

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

rerankingConfiguration

default ManagedSearchConfiguration.Builder rerankingConfiguration(Consumer<ManagedSearchRerankingConfiguration.Builder> rerankingConfiguration)

Contains configurations for reranking the results retrieved from the managed search.

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

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

Parameters:

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

Returns:

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

See Also:

• rerankingConfiguration(ManagedSearchRerankingConfiguration)

rerankingModelType

ManagedSearchConfiguration.Builder rerankingModelType(String rerankingModelType)

The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.

Parameters:

rerankingModelType - The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.

Returns:

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

See Also:

• RerankingModelType
• RerankingModelType

rerankingModelType

ManagedSearchConfiguration.Builder rerankingModelType(RerankingModelType rerankingModelType)

The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.

Parameters:

rerankingModelType - The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.

Returns:

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

See Also:

• RerankingModelType
• RerankingModelType