Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Class CfnAgentPropsMixin.PromptConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.bedrock.CfnAgentPropsMixin.PromptConfigurationProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnAgentPropsMixin.PromptConfigurationProperty

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

A builder for CfnAgentPropsMixin.PromptConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	additionalModelRequestFields(Object additionalModelRequestFields)	Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getAdditionalModelRequestFields()
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	basePromptTemplate(String basePromptTemplate)	Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getBasePromptTemplate()
CfnAgentPropsMixin.PromptConfigurationProperty	build()	Builds the configured instance.
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	foundationModel(String foundationModel)	Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getFoundationModel()
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	inferenceConfiguration(CfnAgentPropsMixin.InferenceConfigurationProperty inferenceConfiguration)	Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getInferenceConfiguration()
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	inferenceConfiguration(IResolvable inferenceConfiguration)	Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getInferenceConfiguration()
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	parserMode(String parserMode)	Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getParserMode()
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	promptCreationMode(String promptCreationMode)	Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getPromptCreationMode()
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	promptState(String promptState)	Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getPromptState()
CfnAgentPropsMixin.PromptConfigurationProperty.Builder	promptType(String promptType)	Sets the value of CfnAgentPropsMixin.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

additionalModelRequestFields

@Stability(Stable)
public CfnAgentPropsMixin.PromptConfigurationProperty.Builder additionalModelRequestFields(Object additionalModelRequestFields)

Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getAdditionalModelRequestFields()

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 .

Returns:

this

basePromptTemplate

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

Sets the value of CfnAgentPropsMixin.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

foundationModel

@Stability(Stable)
public CfnAgentPropsMixin.PromptConfigurationProperty.Builder foundationModel(String foundationModel)

Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getFoundationModel()

Parameters:

foundationModel - The agent's foundation model.

Returns:

this

inferenceConfiguration

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

Sets the value of CfnAgentPropsMixin.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 CfnAgentPropsMixin.PromptConfigurationProperty.Builder inferenceConfiguration(CfnAgentPropsMixin.InferenceConfigurationProperty inferenceConfiguration)

Sets the value of CfnAgentPropsMixin.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 CfnAgentPropsMixin.PromptConfigurationProperty.Builder parserMode(String parserMode)

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

Returns:

this

promptCreationMode

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

Sets the value of CfnAgentPropsMixin.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 CfnAgentPropsMixin.PromptConfigurationProperty.Builder promptState(String promptState)

Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getPromptState()

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:

this

promptType

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

Sets the value of CfnAgentPropsMixin.PromptConfigurationProperty.getPromptType()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAgentPropsMixin.PromptConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided