Interface ExternalSourcesGenerationConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ExternalSourcesGenerationConfiguration

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 textInferenceConfig structure for an external source.
default ExternalSourcesGenerationConfiguration.Builder	guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)	The configuration details for the guardrail.
ExternalSourcesGenerationConfiguration.Builder	guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)	The configuration details for the guardrail.
default ExternalSourcesGenerationConfiguration.Builder	inferenceConfig(Consumer<InferenceConfig.Builder> inferenceConfig)	Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
ExternalSourcesGenerationConfiguration.Builder	inferenceConfig(InferenceConfig inferenceConfig)	Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external source.
default ExternalSourcesGenerationConfiguration.Builder	promptTemplate(Consumer<PromptTemplate.Builder> promptTemplate)	Contain the textPromptTemplate string for the external source wrapper object.
ExternalSourcesGenerationConfiguration.Builder	promptTemplate(PromptTemplate promptTemplate)	Contain the textPromptTemplate string 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, sdkFields

Method Details

additionalModelRequestFields

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

Additional model parameters and their corresponding values not included in the textInferenceConfig structure 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 textInferenceConfig structure 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.

guardrailConfiguration

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

ExternalSourcesGenerationConfiguration.Builder inferenceConfig(InferenceConfig inferenceConfig)

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

Parameters:

inferenceConfig - Configuration settings 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.

inferenceConfig

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

Configuration settings for inference when using RetrieveAndGenerate to generate responses while using an external 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)

promptTemplate

ExternalSourcesGenerationConfiguration.Builder promptTemplate(PromptTemplate promptTemplate)

Contain the textPromptTemplate string for the external source wrapper object.

Parameters:

promptTemplate - Contain the textPromptTemplate string 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)

Contain the textPromptTemplate string 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)