Package software.amazon.awssdk.services.bedrockagentruntime.model

Interface PromptConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

PromptConfiguration

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

Method Summary

Modifier and Type	Method	Description
PromptConfiguration.Builder	additionalModelRequestFields(Document additionalModelRequestFields)	If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.
PromptConfiguration.Builder	basePromptTemplate(String basePromptTemplate)	Defines the prompt template with which to replace the default prompt template.
PromptConfiguration.Builder	foundationModel(String foundationModel)	The foundation model to use.
default PromptConfiguration.Builder	inferenceConfiguration(Consumer<InferenceConfiguration.Builder> inferenceConfiguration)	Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType.
PromptConfiguration.Builder	inferenceConfiguration(InferenceConfiguration inferenceConfiguration)	Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType.
PromptConfiguration.Builder	parserMode(String parserMode)	Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.
PromptConfiguration.Builder	parserMode(CreationMode parserMode)	Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType.
PromptConfiguration.Builder	promptCreationMode(String promptCreationMode)	Specifies whether to override the default prompt template for this promptType.
PromptConfiguration.Builder	promptCreationMode(CreationMode promptCreationMode)	Specifies whether to override the default prompt template for this promptType.
PromptConfiguration.Builder	promptState(String promptState)	Specifies whether to allow the inline agent to carry out the step specified in the promptType.
PromptConfiguration.Builder	promptState(PromptState promptState)	Specifies whether to allow the inline agent to carry out the step specified in the promptType.
PromptConfiguration.Builder	promptType(String promptType)	The step in the agent sequence that this prompt configuration applies to.
PromptConfiguration.Builder	promptType(PromptType promptType)	The step in the agent sequence that this prompt configuration applies to.

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 Detail

additionalModelRequestFields

PromptConfiguration.Builder additionalModelRequestFields(Document additionalModelRequestFields)

If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.

For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.

Parameters:

additionalModelRequestFields - If the Converse or ConverseStream operations support the model, additionalModelRequestFields contains additional inference parameters, beyond the base set of inference parameters in the inferenceConfiguration field.

For more information, see Inference request parameters and response fields for foundation models in the Amazon Bedrock user guide.

Returns:

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

basePromptTemplate

PromptConfiguration.Builder basePromptTemplate(String basePromptTemplate)

Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.

Parameters:

basePromptTemplate - Defines the prompt template with which to replace the default prompt template. You can use placeholder variables in the base prompt template to customize the prompt. For more information, see Prompt template placeholder variables. For more information, see Configure the prompt templates.

Returns:

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

foundationModel

PromptConfiguration.Builder foundationModel(String foundationModel)

The foundation model to use.

Parameters:

foundationModel - The foundation model to use.

Returns:

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

inferenceConfiguration

PromptConfiguration.Builder inferenceConfiguration(InferenceConfiguration inferenceConfiguration)

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

Parameters:

inferenceConfiguration - Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

Returns:

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

inferenceConfiguration

default PromptConfiguration.Builder inferenceConfiguration(Consumer<InferenceConfiguration.Builder> inferenceConfiguration)

Contains inference parameters to use when the agent invokes a foundation model in the part of the agent sequence defined by the promptType. For more information, see Inference parameters for foundation models.

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

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

Parameters:

inferenceConfiguration - a consumer that will call methods on InferenceConfiguration.Builder

Returns:

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

See Also:

inferenceConfiguration(InferenceConfiguration)

parserMode

PromptConfiguration.Builder parserMode(String parserMode)

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

Parameters:

parserMode - Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

Returns:

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

See Also:

CreationMode, CreationMode

parserMode

PromptConfiguration.Builder parserMode(CreationMode parserMode)

Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

Parameters:

parserMode - Specifies whether to override the default parser Lambda function when parsing the raw foundation model output in the part of the agent sequence defined by the promptType. If you set the field as OVERRIDDEN, the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

Returns:

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

See Also:

CreationMode, CreationMode

promptCreationMode

PromptConfiguration.Builder promptCreationMode(String promptCreationMode)

Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

Parameters:

promptCreationMode - Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

Returns:

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

See Also:

CreationMode, CreationMode

promptCreationMode

PromptConfiguration.Builder promptCreationMode(CreationMode promptCreationMode)

Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

Parameters:

promptCreationMode - Specifies whether to override the default prompt template for this promptType. Set this value to OVERRIDDEN to use the prompt that you provide in the basePromptTemplate. If you leave it as DEFAULT, the agent uses a default prompt template.

Returns:

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

See Also:

CreationMode, CreationMode

promptState

PromptConfiguration.Builder promptState(String promptState)

Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

• PRE_PROCESSING – ENABLED

• ORCHESTRATION – ENABLED

• KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

• POST_PROCESSING – DISABLED

Parameters:

promptState - Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

• PRE_PROCESSING – ENABLED

• ORCHESTRATION – ENABLED

• KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

• POST_PROCESSING – DISABLED

Returns:

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

See Also:

PromptState, PromptState

promptState

PromptConfiguration.Builder promptState(PromptState promptState)

Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

• PRE_PROCESSING – ENABLED

• ORCHESTRATION – ENABLED

• KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

• POST_PROCESSING – DISABLED

Parameters:

promptState - Specifies whether to allow the inline agent to carry out the step specified in the promptType. If you set this value to DISABLED, the agent skips that step. The default state for each promptType is as follows.

• PRE_PROCESSING – ENABLED

• ORCHESTRATION – ENABLED

• KNOWLEDGE_BASE_RESPONSE_GENERATION – ENABLED

• POST_PROCESSING – DISABLED

Returns:

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

See Also:

PromptState, PromptState

promptType

PromptConfiguration.Builder promptType(String promptType)

The step in the agent sequence that this prompt configuration applies to.

Parameters:

promptType - The step in the agent sequence that this prompt configuration applies to.

Returns:

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

See Also:

PromptType, PromptType

promptType

PromptConfiguration.Builder promptType(PromptType promptType)

The step in the agent sequence that this prompt configuration applies to.

Parameters:

promptType - The step in the agent sequence that this prompt configuration applies to.

Returns:

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

See Also:

PromptType, PromptType