Interface ExternalSourcesGenerationConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ExternalSourcesGenerationConfiguration

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

Method Summary

Modifier and Type	Method	Description
ExternalSourcesGenerationConfiguration.Builder	additionalModelRequestFields(Map<String,Document> additionalModelRequestFields)	Additional model parameters and their corresponding values not included in the text inference configuration for an external source.
default ExternalSourcesGenerationConfiguration.Builder	guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)	Configuration details for the guardrail.
ExternalSourcesGenerationConfiguration.Builder	guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)	Configuration details for the guardrail.
default ExternalSourcesGenerationConfiguration.Builder	kbInferenceConfig(Consumer<KbInferenceConfig.Builder> kbInferenceConfig)	Configuration details for inference when using RetrieveAndGenerate to generate responses while using an external source.
ExternalSourcesGenerationConfiguration.Builder	kbInferenceConfig(KbInferenceConfig kbInferenceConfig)	Configuration details for inference when using RetrieveAndGenerate to generate responses while using an external source.
default ExternalSourcesGenerationConfiguration.Builder	promptTemplate(Consumer<PromptTemplate.Builder> promptTemplate)	Contains the template for the prompt for the external source wrapper object.
ExternalSourcesGenerationConfiguration.Builder	promptTemplate(PromptTemplate promptTemplate)	Contains the template for the prompt for the external source wrapper object.

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

ExternalSourcesGenerationConfiguration.Builder promptTemplate(PromptTemplate promptTemplate)

Contains the template for the prompt for the external source wrapper object.

Parameters:

promptTemplate - Contains the template for the prompt for the external source wrapper object.

Returns:

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

promptTemplate

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

Contains the template for the prompt for the external source wrapper object.

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

ExternalSourcesGenerationConfiguration.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

Configuration details for the guardrail.

Parameters:

guardrailConfiguration - Configuration details for the guardrail.

Returns:

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

guardrailConfiguration

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

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

ExternalSourcesGenerationConfiguration.Builder kbInferenceConfig(KbInferenceConfig kbInferenceConfig)

Configuration details for inference when using RetrieveAndGenerate to generate responses while using an external source.

Parameters:

kbInferenceConfig - Configuration details for inference when using RetrieveAndGenerate to generate responses while using an external source.

Returns:

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

kbInferenceConfig

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

Configuration details for inference when using RetrieveAndGenerate to generate responses while using an external source.

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

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

Additional model parameters and their corresponding values not included in the text inference configuration for an external source. Takes in custom model parameters specific to the language model being used.

Parameters:

additionalModelRequestFields - Additional model parameters and their corresponding values not included in the text inference configuration for an external source. Takes in 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.