Skip to content
v2.274.0

Experimental

@aws-cdk/aws-bedrock-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

TextPromptVariantProps Struct ​

Properties for creating a text prompt variant.

Example ​

ts
const cmk = new kms.Key(this, 'cmk', {});
const claudeModel = bedrock.BedrockFoundationModel.ANTHROPIC_CLAUDE_SONNET_V1_0;

const variant1 = bedrock.PromptVariant.text({
  variantName: 'variant1',
  model: claudeModel,
  promptVariables: ['topic'],
  promptText: 'This is my first text prompt. Please summarize our conversation on: {{topic}}.',
  inferenceConfiguration: bedrock.PromptInferenceConfiguration.text({
    temperature: 1.0,
    topP: 0.999,
    maxTokens: 2000,
  }),
});

const prompt1 = new bedrock.Prompt(this, 'prompt1', {
  promptName: 'prompt1',
  description: 'my first prompt',
  defaultVariant: variant1,
  variants: [variant1],
  kmsKey: cmk,
});

Properties ​

inferenceConfigurationoptionalPromptInferenceConfigurationinference_configurationoptionalPromptInferenceConfigurationinferenceConfigurationoptionalPromptInferenceConfigurationInferenceConfigurationoptionalPromptInferenceConfigurationInferenceConfigurationoptionalPromptInferenceConfiguration#
Inference configuration for the Text Prompt.

Default: No inference configuration provided.

The model which is used to run the prompt.

The model could be a foundation model, a custom model, or a provisioned model.

promptTextstringprompt_textstrpromptTextStringPromptTextstringPromptText*stringrequired#
The text prompt.

Variables are used by enclosing its name with double curly braces as in {{variable_name}}.

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.

variantNamestringvariant_namestrvariantNameStringVariantNamestringVariantName*stringrequired#
The name of the prompt variant.