Package software.amazon.awscdk.services.bedrock.alpha

Class AgentPromptVariantProps.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.alpha.AgentPromptVariantProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AgentPromptVariantProps>

Enclosing interface:

AgentPromptVariantProps

@Stability(Experimental)
public static final class AgentPromptVariantProps.Builder
extends Object
implements software.amazon.jsii.Builder<AgentPromptVariantProps>

A builder for AgentPromptVariantProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AgentPromptVariantProps.Builder	agentAlias(IAgentAlias agentAlias)	Sets the value of AgentPromptVariantProps.getAgentAlias()
AgentPromptVariantProps	build()	Builds the configured instance.
AgentPromptVariantProps.Builder	model(IBedrockInvokable model)	Sets the value of CommonPromptVariantProps.getModel()
AgentPromptVariantProps.Builder	promptText(String promptText)	Sets the value of AgentPromptVariantProps.getPromptText()
AgentPromptVariantProps.Builder	promptVariables(List<String> promptVariables)	Sets the value of CommonPromptVariantProps.getPromptVariables()
AgentPromptVariantProps.Builder	variantName(String variantName)	Sets the value of CommonPromptVariantProps.getVariantName()

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

agentAlias

@Stability(Experimental)
public AgentPromptVariantProps.Builder agentAlias(IAgentAlias agentAlias)

Sets the value of AgentPromptVariantProps.getAgentAlias()

Parameters:

agentAlias - An alias pointing to the agent version to be used. This parameter is required.

Returns:

this

promptText

@Stability(Experimental)
public AgentPromptVariantProps.Builder promptText(String promptText)

Sets the value of AgentPromptVariantProps.getPromptText()

Parameters:

promptText - The text prompt. This parameter is required. Variables are used by enclosing its name with double curly braces as in {{variable_name}}.

Returns:

this

model

@Stability(Experimental)
public AgentPromptVariantProps.Builder model(IBedrockInvokable model)

Sets the value of CommonPromptVariantProps.getModel()

Parameters:

model - The model which is used to run the prompt. This parameter is required. The model could be a foundation model, a custom model, or a provisioned model.

Returns:

this

variantName

@Stability(Experimental)
public AgentPromptVariantProps.Builder variantName(String variantName)

Sets the value of CommonPromptVariantProps.getVariantName()

Parameters:

variantName - The name of the prompt variant. This parameter is required.

Returns:

this

promptVariables

@Stability(Experimental)
public AgentPromptVariantProps.Builder promptVariables(List<String> promptVariables)

Sets the value of CommonPromptVariantProps.getPromptVariables()

Parameters:

promptVariables - The variables in the prompt template that can be filled in at runtime.

Returns:

this

build

@Stability(Experimental)
public AgentPromptVariantProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<AgentPromptVariantProps>

Returns:

a new instance of AgentPromptVariantProps

Throws:

NullPointerException - if any required attribute was not provided