Interface GenerationConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

GenerationConfiguration

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

Method Summary

Modifier and Type	Method	Description
GenerationConfiguration.Builder	additionalModelRequestFields(Map<String,Document> additionalModelRequestFields)	Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base.
default GenerationConfiguration.Builder	guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)	The configuration details for the guardrail.
GenerationConfiguration.Builder	guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)	The configuration details for the guardrail.
default GenerationConfiguration.Builder	inferenceConfig(Consumer<InferenceConfig.Builder> inferenceConfig)	Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
GenerationConfiguration.Builder	inferenceConfig(InferenceConfig inferenceConfig)	Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.
default GenerationConfiguration.Builder	performanceConfig(Consumer<PerformanceConfiguration.Builder> performanceConfig)	The latency configuration for the model.
GenerationConfiguration.Builder	performanceConfig(PerformanceConfiguration performanceConfig)	The latency configuration for the model.
default GenerationConfiguration.Builder	promptTemplate(Consumer<PromptTemplate.Builder> promptTemplate)	Contains the template for the prompt that's sent to the model for response generation.
GenerationConfiguration.Builder	promptTemplate(PromptTemplate promptTemplate)	Contains the template for the prompt that's sent to the model for response generation.

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

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

Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

Parameters:

additionalModelRequestFields - Additional model parameters and corresponding values not included in the textInferenceConfig structure for a knowledge base. This allows users to provide custom model parameters specific to the language model being used.

Returns:

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

guardrailConfiguration

GenerationConfiguration.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

The configuration details for the guardrail.

Parameters:

guardrailConfiguration - The configuration details for the guardrail.

Returns:

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

guardrailConfiguration

default GenerationConfiguration.Builder guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)

The configuration details for the guardrail.

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

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

Parameters:

guardrailConfiguration - a consumer that will call methods on GuardrailConfiguration.Builder

Returns:

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

See Also:

• guardrailConfiguration(GuardrailConfiguration)

inferenceConfig

GenerationConfiguration.Builder inferenceConfig(InferenceConfig inferenceConfig)

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

Parameters:

inferenceConfig - Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

Returns:

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

inferenceConfig

default GenerationConfiguration.Builder inferenceConfig(Consumer<InferenceConfig.Builder> inferenceConfig)

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using a knowledge base as a source.

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

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

Parameters:

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

Returns:

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

See Also:

• inferenceConfig(InferenceConfig)

performanceConfig

GenerationConfiguration.Builder performanceConfig(PerformanceConfiguration performanceConfig)

The latency configuration for the model.

Parameters:

performanceConfig - The latency configuration for the model.

Returns:

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

performanceConfig

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

The latency configuration for the model.

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

GenerationConfiguration.Builder promptTemplate(PromptTemplate promptTemplate)

Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.

Parameters:

promptTemplate - Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.

Returns:

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

promptTemplate

default GenerationConfiguration.Builder promptTemplate(Consumer<PromptTemplate.Builder> promptTemplate)

Contains the template for the prompt that's sent to the model for response generation. Generation prompts must include the $search_results$ variable. For more information, see Use placeholder variables in the user guide.

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

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

Parameters:

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

Returns:

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

See Also:

• promptTemplate(PromptTemplate)