Interface ChatPromptTemplateConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ChatPromptTemplateConfiguration

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

Method Summary

Modifier and Type	Method	Description
ChatPromptTemplateConfiguration.Builder	inputVariables(Collection<PromptInputVariable> inputVariables)	An array of the variables in the prompt template.
ChatPromptTemplateConfiguration.Builder	inputVariables(Consumer<PromptInputVariable.Builder>... inputVariables)	An array of the variables in the prompt template.
ChatPromptTemplateConfiguration.Builder	inputVariables(PromptInputVariable... inputVariables)	An array of the variables in the prompt template.
ChatPromptTemplateConfiguration.Builder	messages(Collection<Message> messages)	Contains messages in the chat for the prompt.
ChatPromptTemplateConfiguration.Builder	messages(Consumer<Message.Builder>... messages)	Contains messages in the chat for the prompt.
ChatPromptTemplateConfiguration.Builder	messages(Message... messages)	Contains messages in the chat for the prompt.
ChatPromptTemplateConfiguration.Builder	system(Collection<SystemContentBlock> system)	Contains system prompts to provide context to the model or to describe how it should behave.
ChatPromptTemplateConfiguration.Builder	system(Consumer<SystemContentBlock.Builder>... system)	Contains system prompts to provide context to the model or to describe how it should behave.
ChatPromptTemplateConfiguration.Builder	system(SystemContentBlock... system)	Contains system prompts to provide context to the model or to describe how it should behave.
default ChatPromptTemplateConfiguration.Builder	toolConfiguration(Consumer<ToolConfiguration.Builder> toolConfiguration)	Configuration information for the tools that the model can use when generating a response.
ChatPromptTemplateConfiguration.Builder	toolConfiguration(ToolConfiguration toolConfiguration)	Configuration information for the tools that the model can use when generating a response.

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 Details

inputVariables

ChatPromptTemplateConfiguration.Builder inputVariables(Collection<PromptInputVariable> inputVariables)

An array of the variables in the prompt template.

Parameters:

inputVariables - An array of the variables in the prompt template.

Returns:

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

inputVariables

ChatPromptTemplateConfiguration.Builder inputVariables(PromptInputVariable... inputVariables)

An array of the variables in the prompt template.

Parameters:

inputVariables - An array of the variables in the prompt template.

Returns:

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

inputVariables

ChatPromptTemplateConfiguration.Builder inputVariables(Consumer<PromptInputVariable.Builder>... inputVariables)

An array of the variables in the prompt template.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputVariables(List<PromptInputVariable>).

Parameters:

inputVariables - a consumer that will call methods on PromptInputVariable.Builder

Returns:

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

See Also:

• inputVariables(java.util.Collection<PromptInputVariable>)

messages

ChatPromptTemplateConfiguration.Builder messages(Collection<Message> messages)

Contains messages in the chat for the prompt.

Parameters:

messages - Contains messages in the chat for the prompt.

Returns:

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

messages

ChatPromptTemplateConfiguration.Builder messages(Message... messages)

Contains messages in the chat for the prompt.

Parameters:

messages - Contains messages in the chat for the prompt.

Returns:

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

messages

ChatPromptTemplateConfiguration.Builder messages(Consumer<Message.Builder>... messages)

Contains messages in the chat for the prompt.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to messages(List<Message>).

Parameters:

messages - a consumer that will call methods on Message.Builder

Returns:

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

See Also:

• messages(java.util.Collection<Message>)

system

ChatPromptTemplateConfiguration.Builder system(Collection<SystemContentBlock> system)

Contains system prompts to provide context to the model or to describe how it should behave.

Parameters:

system - Contains system prompts to provide context to the model or to describe how it should behave.

Returns:

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

system

ChatPromptTemplateConfiguration.Builder system(SystemContentBlock... system)

Contains system prompts to provide context to the model or to describe how it should behave.

Parameters:

system - Contains system prompts to provide context to the model or to describe how it should behave.

Returns:

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

system

ChatPromptTemplateConfiguration.Builder system(Consumer<SystemContentBlock.Builder>... system)

Contains system prompts to provide context to the model or to describe how it should behave.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to system(List<SystemContentBlock>).

Parameters:

system - a consumer that will call methods on SystemContentBlock.Builder

Returns:

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

See Also:

• system(java.util.Collection<SystemContentBlock>)

toolConfiguration

ChatPromptTemplateConfiguration.Builder toolConfiguration(ToolConfiguration toolConfiguration)

Configuration information for the tools that the model can use when generating a response.

Parameters:

toolConfiguration - Configuration information for the tools that the model can use when generating a response.

Returns:

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

toolConfiguration

default ChatPromptTemplateConfiguration.Builder toolConfiguration(Consumer<ToolConfiguration.Builder> toolConfiguration)

Configuration information for the tools that the model can use when generating a response.

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

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

Parameters:

toolConfiguration - a consumer that will call methods on ToolConfiguration.Builder

Returns:

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

See Also:

• toolConfiguration(ToolConfiguration)