Experimental
@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ChatPromptVariantProps Struct
Properties for creating a chat prompt variant.
Example
ts
const cmk = new kms.Key(this, 'cmk', {});
const variantChat = bedrock.PromptVariant.chat({
variantName: 'variant1',
model: bedrock.BedrockFoundationModel.ANTHROPIC_CLAUDE_3_5_SONNET_V1_0,
messages: [
bedrock.ChatMessage.user('From now on, you speak Japanese!'),
bedrock.ChatMessage.assistant('Konnichiwa!'),
bedrock.ChatMessage.user('From now on, you speak {{language}}!'),
],
system: 'You are a helpful assistant that only speaks the language you`re told.',
promptVariables: ['language'],
toolConfiguration: {
toolChoice: bedrock.ToolChoice.AUTO,
tools: [
bedrock.Tool.function({
name: 'top_song',
description: 'Get the most popular song played on a radio station.',
inputSchema: {
type: 'object',
properties: {
sign: {
type: 'string',
description: 'The call sign for the radio station for which you want the most popular song. Example calls signs are WZPZ and WKR.',
},
},
required: ['sign'],
},
}),
],
},
});
new bedrock.Prompt(this, 'prompt1', {
promptName: 'prompt-chat',
description: 'my first chat prompt',
defaultVariant: variantChat,
variants: [variantChat],
kmsKey: cmk,
});
Properties
inferenceConfigurationoptionalPromptInferenceConfigurationinference_configurationoptionalPromptInferenceConfigurationinferenceConfigurationoptionalPromptInferenceConfigurationInferenceConfigurationoptionalPromptInferenceConfigurationInferenceConfigurationoptionalPromptInferenceConfiguration#Inference configuration for the Chat Prompt.
Default: No inference configuration provided.
messagesChatMessage[]messagestyping.List[ChatMessage]messagesList<ChatMessage>MessagesChatMessage[]Messages*[]ChatMessagerequired#The messages in the chat prompt.
Must include at least one User Message. The messages should alternate between User and Assistant.
modelIBedrockInvokablemodelIBedrockInvokablemodelIBedrockInvokableModelIBedrockInvokableModelIBedrockInvokablerequired#The model which is used to run the prompt.
The model could be a foundation model, a custom model, or a provisioned model.
promptVariablesoptionalstring[]prompt_variablesoptionaltyping.List[str]promptVariablesoptionalList<String>PromptVariablesoptionalstring[]PromptVariablesoptional*[]*string#The variables in the prompt template that can be filled in at runtime.
Default: No variables defined.
Context or instructions for the model to consider before generating a response.
Default: No system message provided.
toolConfigurationoptionalToolConfigurationtool_configurationoptionalToolConfigurationtoolConfigurationoptionalToolConfigurationToolConfigurationoptionalToolConfigurationToolConfigurationoptionalToolConfiguration#The configuration with available tools to the model and how it must use them.
Default: No tool configuration provided.
The name of the prompt variant.