Interface AgenticRetrieveConfiguration.Builder
- All Superinterfaces:
Buildable,CopyableBuilder<AgenticRetrieveConfiguration.Builder,,AgenticRetrieveConfiguration> SdkBuilder<AgenticRetrieveConfiguration.Builder,,AgenticRetrieveConfiguration> SdkPojo
- Enclosing class:
AgenticRetrieveConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionfoundationModelConfiguration(Consumer<FoundationModelConfiguration.Builder> foundationModelConfiguration) The foundation model configuration.foundationModelConfiguration(FoundationModelConfiguration foundationModelConfiguration) The foundation model configuration.foundationModelType(String foundationModelType) The type of foundation model to use.foundationModelType(FoundationModelType foundationModelType) The type of foundation model to use.maxAgentIteration(Integer maxAgentIteration) The maximum number of agent iterations for retrieval.rerankingConfiguration(Consumer<AgenticRetrieveRerankingConfiguration.Builder> rerankingConfiguration) The reranking model configuration.rerankingConfiguration(AgenticRetrieveRerankingConfiguration rerankingConfiguration) The reranking model configuration.rerankingModelType(String rerankingModelType) The type of reranking model to use.rerankingModelType(AgenticRetrieveRerankingModelType rerankingModelType) The type of reranking model to use.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods 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 theFoundationModelConfiguration.Builderavoiding the need to create one manually viaFoundationModelConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tofoundationModelConfiguration(FoundationModelConfiguration).- Parameters:
foundationModelConfiguration- a consumer that will call methods onFoundationModelConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-
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 theAgenticRetrieveRerankingConfiguration.Builderavoiding the need to create one manually viaAgenticRetrieveRerankingConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed torerankingConfiguration(AgenticRetrieveRerankingConfiguration).- Parameters:
rerankingConfiguration- a consumer that will call methods onAgenticRetrieveRerankingConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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:
-
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:
-