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

Class ChatPromptVariantProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<ChatPromptVariantProps>

Enclosing interface:

ChatPromptVariantProps

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

A builder for ChatPromptVariantProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ChatPromptVariantProps	build()	Builds the configured instance.
ChatPromptVariantProps.Builder	inferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)	Sets the value of ChatPromptVariantProps.getInferenceConfiguration()
ChatPromptVariantProps.Builder	messages(List<? extends ChatMessage> messages)	Sets the value of ChatPromptVariantProps.getMessages()
ChatPromptVariantProps.Builder	model(IBedrockInvokable model)	Sets the value of CommonPromptVariantProps.getModel()
ChatPromptVariantProps.Builder	promptVariables(List<String> promptVariables)	Sets the value of CommonPromptVariantProps.getPromptVariables()
ChatPromptVariantProps.Builder	system(String system)	Sets the value of ChatPromptVariantProps.getSystem()
ChatPromptVariantProps.Builder	toolConfiguration(ToolConfiguration toolConfiguration)	Sets the value of ChatPromptVariantProps.getToolConfiguration()
ChatPromptVariantProps.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

messages

@Stability(Experimental)
public ChatPromptVariantProps.Builder messages(List<? extends ChatMessage> messages)

Sets the value of ChatPromptVariantProps.getMessages()

Parameters:

messages - The messages in the chat prompt. This parameter is required. Must include at least one User Message. The messages should alternate between User and Assistant.

Returns:

this

inferenceConfiguration

@Stability(Experimental)
public ChatPromptVariantProps.Builder inferenceConfiguration(PromptInferenceConfiguration inferenceConfiguration)

Sets the value of ChatPromptVariantProps.getInferenceConfiguration()

Parameters:

inferenceConfiguration - Inference configuration for the Chat Prompt.

Returns:

this

system

@Stability(Experimental)
public ChatPromptVariantProps.Builder system(String system)

Sets the value of ChatPromptVariantProps.getSystem()

Parameters:

system - Context or instructions for the model to consider before generating a response.

Returns:

this

toolConfiguration

@Stability(Experimental)
public ChatPromptVariantProps.Builder toolConfiguration(ToolConfiguration toolConfiguration)

Sets the value of ChatPromptVariantProps.getToolConfiguration()

Parameters:

toolConfiguration - The configuration with available tools to the model and how it must use them.

Returns:

this

model

@Stability(Experimental)
public ChatPromptVariantProps.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 ChatPromptVariantProps.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 ChatPromptVariantProps.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 ChatPromptVariantProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ChatPromptVariantProps

Throws:

NullPointerException - if any required attribute was not provided