Package software.amazon.awscdk.services.bedrock

Class CfnAgent.PromptConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.CfnAgent.PromptConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAgent.PromptConfigurationProperty>

Enclosing interface:

CfnAgent.PromptConfigurationProperty

@Stability(Stable)
public static final class CfnAgent.PromptConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnAgent.PromptConfigurationProperty>

A builder for CfnAgent.PromptConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAgent.PromptConfigurationProperty.Builder	basePromptTemplate(String basePromptTemplate)	Sets the value of CfnAgent.PromptConfigurationProperty.getBasePromptTemplate()
CfnAgent.PromptConfigurationProperty	build()	Builds the configured instance.
CfnAgent.PromptConfigurationProperty.Builder	inferenceConfiguration(IResolvable inferenceConfiguration)	Sets the value of CfnAgent.PromptConfigurationProperty.getInferenceConfiguration()
CfnAgent.PromptConfigurationProperty.Builder	inferenceConfiguration(CfnAgent.InferenceConfigurationProperty inferenceConfiguration)	Sets the value of CfnAgent.PromptConfigurationProperty.getInferenceConfiguration()
CfnAgent.PromptConfigurationProperty.Builder	parserMode(String parserMode)	Sets the value of CfnAgent.PromptConfigurationProperty.getParserMode()
CfnAgent.PromptConfigurationProperty.Builder	promptCreationMode(String promptCreationMode)	Sets the value of CfnAgent.PromptConfigurationProperty.getPromptCreationMode()
CfnAgent.PromptConfigurationProperty.Builder	promptState(String promptState)	Sets the value of CfnAgent.PromptConfigurationProperty.getPromptState()
CfnAgent.PromptConfigurationProperty.Builder	promptType(String promptType)	Sets the value of CfnAgent.PromptConfigurationProperty.getPromptType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

basePromptTemplate

@Stability(Stable)
public CfnAgent.PromptConfigurationProperty.Builder basePromptTemplate(String basePromptTemplate)

Sets the value of CfnAgent.PromptConfigurationProperty.getBasePromptTemplate()

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:

this

inferenceConfiguration

@Stability(Stable)
public CfnAgent.PromptConfigurationProperty.Builder inferenceConfiguration(IResolvable inferenceConfiguration)

Sets the value of CfnAgent.PromptConfigurationProperty.getInferenceConfiguration()

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:

this

inferenceConfiguration

@Stability(Stable)
public CfnAgent.PromptConfigurationProperty.Builder inferenceConfiguration(CfnAgent.InferenceConfigurationProperty inferenceConfiguration)

Sets the value of CfnAgent.PromptConfigurationProperty.getInferenceConfiguration()

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:

this

parserMode

@Stability(Stable)
public CfnAgent.PromptConfigurationProperty.Builder parserMode(String parserMode)

Sets the value of CfnAgent.PromptConfigurationProperty.getParserMode()

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 OVERRIDEN , the overrideLambda field in the PromptOverrideConfiguration must be specified with the ARN of a Lambda function.

Returns:

this

promptCreationMode

@Stability(Stable)
public CfnAgent.PromptConfigurationProperty.Builder promptCreationMode(String promptCreationMode)

Sets the value of CfnAgent.PromptConfigurationProperty.getPromptCreationMode()

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:

this

promptState

@Stability(Stable)
public CfnAgent.PromptConfigurationProperty.Builder promptState(String promptState)

Sets the value of CfnAgent.PromptConfigurationProperty.getPromptState()

Parameters:

promptState - Specifies whether to allow the 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:

this

promptType

@Stability(Stable)
public CfnAgent.PromptConfigurationProperty.Builder promptType(String promptType)

Sets the value of CfnAgent.PromptConfigurationProperty.getPromptType()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnAgent.PromptConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnAgent.PromptConfigurationProperty>

Returns:

a new instance of CfnAgent.PromptConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided