Interface AgenticRetrieveConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

AgenticRetrieveConfiguration

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

Method Summary

Modifier and Type	Method	Description
default AgenticRetrieveConfiguration.Builder	foundationModelConfiguration(Consumer<FoundationModelConfiguration.Builder> foundationModelConfiguration)	The foundation model configuration.
AgenticRetrieveConfiguration.Builder	foundationModelConfiguration(FoundationModelConfiguration foundationModelConfiguration)	The foundation model configuration.
AgenticRetrieveConfiguration.Builder	foundationModelType(String foundationModelType)	The type of foundation model to use.
AgenticRetrieveConfiguration.Builder	foundationModelType(FoundationModelType foundationModelType)	The type of foundation model to use.
AgenticRetrieveConfiguration.Builder	maxAgentIteration(Integer maxAgentIteration)	The maximum number of agent iterations for retrieval.
default AgenticRetrieveConfiguration.Builder	rerankingConfiguration(Consumer<AgenticRetrieveRerankingConfiguration.Builder> rerankingConfiguration)	The reranking model configuration.
AgenticRetrieveConfiguration.Builder	rerankingConfiguration(AgenticRetrieveRerankingConfiguration rerankingConfiguration)	The reranking model configuration.
AgenticRetrieveConfiguration.Builder	rerankingModelType(String rerankingModelType)	The type of reranking model to use.
AgenticRetrieveConfiguration.Builder	rerankingModelType(AgenticRetrieveRerankingModelType rerankingModelType)	The type of reranking model to use.

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

foundationModelConfiguration

AgenticRetrieveConfiguration.Builder foundationModelConfiguration(FoundationModelConfiguration foundationModelConfiguration)

The foundation model configuration. Required when foundationModelType is CUSTOM.

Parameters:

foundationModelConfiguration - The foundation model configuration. Required when foundationModelType is CUSTOM.

Returns:

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

foundationModelConfiguration

default AgenticRetrieveConfiguration.Builder foundationModelConfiguration(Consumer<FoundationModelConfiguration.Builder> foundationModelConfiguration)

The foundation model configuration. Required when foundationModelType is CUSTOM.

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

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

Parameters:

foundationModelConfiguration - a consumer that will call methods on FoundationModelConfiguration.Builder

Returns:

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

See Also:

• foundationModelConfiguration(FoundationModelConfiguration)

foundationModelType

AgenticRetrieveConfiguration.Builder foundationModelType(String foundationModelType)

The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.

Parameters:

foundationModelType - The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.

Returns:

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

See Also:

• FoundationModelType
• FoundationModelType

foundationModelType

AgenticRetrieveConfiguration.Builder foundationModelType(FoundationModelType foundationModelType)

The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.

Parameters:

foundationModelType - The type of foundation model to use. CUSTOM uses a specified model, MANAGED uses the service default.

Returns:

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

See Also:

• FoundationModelType
• FoundationModelType

maxAgentIteration

AgenticRetrieveConfiguration.Builder maxAgentIteration(Integer maxAgentIteration)

The maximum number of agent iterations for retrieval.

Parameters:

maxAgentIteration - The maximum number of agent iterations for retrieval.

Returns:

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

rerankingConfiguration

AgenticRetrieveConfiguration.Builder rerankingConfiguration(AgenticRetrieveRerankingConfiguration rerankingConfiguration)

The reranking model configuration. Required when rerankingModelType is CUSTOM.

Parameters:

rerankingConfiguration - The reranking model configuration. Required when rerankingModelType is CUSTOM.

Returns:

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

rerankingConfiguration

default AgenticRetrieveConfiguration.Builder rerankingConfiguration(Consumer<AgenticRetrieveRerankingConfiguration.Builder> rerankingConfiguration)

The reranking model configuration. Required when rerankingModelType is CUSTOM.

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

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

Parameters:

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

Returns:

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

See Also:

• rerankingConfiguration(AgenticRetrieveRerankingConfiguration)

rerankingModelType

AgenticRetrieveConfiguration.Builder rerankingModelType(String rerankingModelType)

The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.

Parameters:

rerankingModelType - The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.

Returns:

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

See Also:

• AgenticRetrieveRerankingModelType
• AgenticRetrieveRerankingModelType

rerankingModelType

AgenticRetrieveConfiguration.Builder rerankingModelType(AgenticRetrieveRerankingModelType rerankingModelType)

The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.

Parameters:

rerankingModelType - The type of reranking model to use. CUSTOM uses a specified model, MANAGED uses the service default. If not specified, defaults to MANAGED for managed embedding knowledge bases and NONE for custom embedding knowledge bases.

Returns:

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

See Also:

• AgenticRetrieveRerankingModelType
• AgenticRetrieveRerankingModelType