Interface KnowledgeBaseOrchestrationConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

KnowledgeBaseOrchestrationConfiguration

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

Method Summary

Modifier and Type	Method	Description
KnowledgeBaseOrchestrationConfiguration.Builder	additionalModelRequestFields(Map<String,Document> additionalModelRequestFields)	The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.
default KnowledgeBaseOrchestrationConfiguration.Builder	inferenceConfig(Consumer<PromptInferenceConfiguration.Builder> inferenceConfig)	Contains inference configurations for the prompt.
KnowledgeBaseOrchestrationConfiguration.Builder	inferenceConfig(PromptInferenceConfiguration inferenceConfig)	Contains inference configurations for the prompt.
default KnowledgeBaseOrchestrationConfiguration.Builder	performanceConfig(Consumer<PerformanceConfiguration.Builder> performanceConfig)	The performance configuration options for the knowledge base retrieval and generation process.
KnowledgeBaseOrchestrationConfiguration.Builder	performanceConfig(PerformanceConfiguration performanceConfig)	The performance configuration options for the knowledge base retrieval and generation process.
default KnowledgeBaseOrchestrationConfiguration.Builder	promptTemplate(Consumer<KnowledgeBasePromptTemplate.Builder> promptTemplate)	A custom prompt template for orchestrating the retrieval and generation process.
KnowledgeBaseOrchestrationConfiguration.Builder	promptTemplate(KnowledgeBasePromptTemplate promptTemplate)	A custom prompt template for orchestrating the retrieval and generation process.

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

additionalModelRequestFields

KnowledgeBaseOrchestrationConfiguration.Builder additionalModelRequestFields(Map<String,Document> additionalModelRequestFields)

The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.

Parameters:

additionalModelRequestFields - The additional model-specific request parameters as key-value pairs to be included in the request to the foundation model.

Returns:

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

inferenceConfig

KnowledgeBaseOrchestrationConfiguration.Builder inferenceConfig(PromptInferenceConfiguration inferenceConfig)

Contains inference configurations for the prompt.

Parameters:

inferenceConfig - Contains inference configurations for the prompt.

Returns:

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

inferenceConfig

default KnowledgeBaseOrchestrationConfiguration.Builder inferenceConfig(Consumer<PromptInferenceConfiguration.Builder> inferenceConfig)

Contains inference configurations for the prompt.

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

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

Parameters:

inferenceConfig - a consumer that will call methods on PromptInferenceConfiguration.Builder

Returns:

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

See Also:

• inferenceConfig(PromptInferenceConfiguration)

performanceConfig

KnowledgeBaseOrchestrationConfiguration.Builder performanceConfig(PerformanceConfiguration performanceConfig)

The performance configuration options for the knowledge base retrieval and generation process.

Parameters:

performanceConfig - The performance configuration options for the knowledge base retrieval and generation process.

Returns:

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

performanceConfig

default KnowledgeBaseOrchestrationConfiguration.Builder performanceConfig(Consumer<PerformanceConfiguration.Builder> performanceConfig)

The performance configuration options for the knowledge base retrieval and generation process.

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

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

Parameters:

performanceConfig - a consumer that will call methods on PerformanceConfiguration.Builder

Returns:

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

See Also:

• performanceConfig(PerformanceConfiguration)

promptTemplate

KnowledgeBaseOrchestrationConfiguration.Builder promptTemplate(KnowledgeBasePromptTemplate promptTemplate)

A custom prompt template for orchestrating the retrieval and generation process.

Parameters:

promptTemplate - A custom prompt template for orchestrating the retrieval and generation process.

Returns:

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

promptTemplate

default KnowledgeBaseOrchestrationConfiguration.Builder promptTemplate(Consumer<KnowledgeBasePromptTemplate.Builder> promptTemplate)

A custom prompt template for orchestrating the retrieval and generation process.

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

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

Parameters:

promptTemplate - a consumer that will call methods on KnowledgeBasePromptTemplate.Builder

Returns:

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

See Also:

• promptTemplate(KnowledgeBasePromptTemplate)