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)	Contains configuration details for the guardrail.
GenerationConfiguration.Builder	guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)	Contains configuration details for the guardrail.
default GenerationConfiguration.Builder	kbInferenceConfig(Consumer<KbInferenceConfig.Builder> kbInferenceConfig)	Contains configuration details for inference for knowledge base retrieval and response generation.
GenerationConfiguration.Builder	kbInferenceConfig(KbInferenceConfig kbInferenceConfig)	Contains configuration details for inference for knowledge base retrieval and response generation.
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

promptTemplate

GenerationConfiguration.Builder promptTemplate(PromptTemplate promptTemplate)

Contains the template for the prompt that's sent to the model for response generation.

Parameters:

promptTemplate - Contains the template for the prompt that's sent to the model for response generation.

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.

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)

guardrailConfiguration

GenerationConfiguration.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

Contains configuration details for the guardrail.

Parameters:

guardrailConfiguration - Contains 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)

Contains 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)

kbInferenceConfig

GenerationConfiguration.Builder kbInferenceConfig(KbInferenceConfig kbInferenceConfig)

Contains configuration details for inference for knowledge base retrieval and response generation.

Parameters:

kbInferenceConfig - Contains configuration details for inference for knowledge base retrieval and response generation.

Returns:

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

kbInferenceConfig

default GenerationConfiguration.Builder kbInferenceConfig(Consumer<KbInferenceConfig.Builder> kbInferenceConfig)

Contains configuration details for inference for knowledge base retrieval and response generation.

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

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

Parameters:

kbInferenceConfig - a consumer that will call methods on KbInferenceConfig.Builder

Returns:

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

See Also:

• kbInferenceConfig(KbInferenceConfig)

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 you 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 you 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.