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

Interface TextPromptVariantProps

All Superinterfaces:

CommonPromptVariantProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TextPromptVariantProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-07-24T11:33:25.577Z")
@Stability(Experimental)
public interface TextPromptVariantProps
extends software.amazon.jsii.JsiiSerializable, CommonPromptVariantProps

(experimental) Properties for creating a text prompt variant.

Example:

 Key cmk = Key.Builder.create(this, "cmk").build();
 BedrockFoundationModel claudeModel = BedrockFoundationModel.ANTHROPIC_CLAUDE_SONNET_V1_0;
 IPromptVariant variant1 = PromptVariant.text(TextPromptVariantProps.builder()
         .variantName("variant1")
         .model(claudeModel)
         .promptVariables(List.of("topic"))
         .promptText("This is my first text prompt. Please summarize our conversation on: {{topic}}.")
         .inferenceConfiguration(PromptInferenceConfiguration.text(PromptInferenceConfigurationProps.builder()
                 .temperature(1)
                 .topP(0.999)
                 .maxTokens(2000)
                 .build()))
         .build());
 Prompt prompt1 = Prompt.Builder.create(this, "prompt1")
         .promptName("prompt1")
         .description("my first prompt")
         .defaultVariant(variant1)
         .variants(List.of(variant1))
         .kmsKey(cmk)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	TextPromptVariantProps.Builder	A builder for TextPromptVariantProps
static final class	TextPromptVariantProps.Jsii$Proxy	An implementation for TextPromptVariantProps

Method Summary

Modifier and Type	Method	Description
static TextPromptVariantProps.Builder	builder()
default PromptInferenceConfiguration	getInferenceConfiguration()	(experimental) Inference configuration for the Text Prompt.
String	getPromptText()	(experimental) The text prompt.

Methods inherited from interface software.amazon.awscdk.services.bedrock.alpha.CommonPromptVariantProps

getModel, getPromptVariables, getVariantName

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPromptText

@Stability(Experimental)
@NotNull
String getPromptText()

(experimental) The text prompt.

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

getInferenceConfiguration

@Stability(Experimental)
@Nullable
default PromptInferenceConfiguration getInferenceConfiguration()

(experimental) Inference configuration for the Text Prompt.

Default: - No inference configuration provided.

builder

@Stability(Experimental)
static TextPromptVariantProps.Builder builder()

Returns:

a TextPromptVariantProps.Builder of TextPromptVariantProps