Class PromptVersionProps

(experimental) Properties for creating a CDK managed Bedrock Prompt Version.

Inheritance

object

PromptVersionProps

Implements

IPromptVersionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Bedrock.Alpha

Assembly: Amazon.CDK.AWS.Bedrock.Alpha.dll

Syntax (csharp)

public class PromptVersionProps : IPromptVersionProps

Syntax (vb)

Public Class PromptVersionProps Implements IPromptVersionProps

Remarks

Stability: Experimental

ExampleMetadata: fixture=default infused

Examples

var cmk = new Key(this, "cmk", new KeyProps { });
             var claudeModel = BedrockFoundationModel.ANTHROPIC_CLAUDE_SONNET_V1_0;

             var variant1 = PromptVariant.Text(new TextPromptVariantProps {
                 VariantName = "variant1",
                 Model = claudeModel,
                 PromptVariables = new [] { "topic" },
                 PromptText = "This is my first text prompt. Please summarize our conversation on: {{topic}}.",
                 InferenceConfiguration = PromptInferenceConfiguration.Text(new PromptInferenceConfigurationProps {
                     Temperature = 1,
                     TopP = 0.999,
                     MaxTokens = 2000
                 })
             });

             var prompt1 = new Prompt(this, "prompt1", new PromptProps {
                 PromptName = "prompt1",
                 Description = "my first prompt",
                 DefaultVariant = variant1,
                 Variants = new [] { variant1 },
                 KmsKey = cmk
             });

             var promptVersion = new PromptVersion(this, "MyPromptVersion", new PromptVersionProps {
                 Prompt = prompt1,
                 Description = "my first version"
             });
             //or alternatively:
             // const promptVersion = prompt1.createVersion('my first version');
             var versionString = promptVersion.Version;

Synopsis

Constructors

PromptVersionProps()

(experimental) Properties for creating a CDK managed Bedrock Prompt Version.

Properties

Description	(experimental) The description of the prompt version.
Prompt	(experimental) The prompt to use for this version.

Constructors

PromptVersionProps()

(experimental) Properties for creating a CDK managed Bedrock Prompt Version.

public PromptVersionProps()

Remarks

Stability: Experimental

ExampleMetadata: fixture=default infused

Examples

var cmk = new Key(this, "cmk", new KeyProps { });
             var claudeModel = BedrockFoundationModel.ANTHROPIC_CLAUDE_SONNET_V1_0;

             var variant1 = PromptVariant.Text(new TextPromptVariantProps {
                 VariantName = "variant1",
                 Model = claudeModel,
                 PromptVariables = new [] { "topic" },
                 PromptText = "This is my first text prompt. Please summarize our conversation on: {{topic}}.",
                 InferenceConfiguration = PromptInferenceConfiguration.Text(new PromptInferenceConfigurationProps {
                     Temperature = 1,
                     TopP = 0.999,
                     MaxTokens = 2000
                 })
             });

             var prompt1 = new Prompt(this, "prompt1", new PromptProps {
                 PromptName = "prompt1",
                 Description = "my first prompt",
                 DefaultVariant = variant1,
                 Variants = new [] { variant1 },
                 KmsKey = cmk
             });

             var promptVersion = new PromptVersion(this, "MyPromptVersion", new PromptVersionProps {
                 Prompt = prompt1,
                 Description = "my first version"
             });
             //or alternatively:
             // const promptVersion = prompt1.createVersion('my first version');
             var versionString = promptVersion.Version;

Properties

Description

(experimental) The description of the prompt version.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - No description provided. Maximum length: 200

Stability: Experimental

Prompt

(experimental) The prompt to use for this version.

public IPrompt Prompt { get; set; }

Property Value

IPrompt

Remarks

Stability: Experimental

Implements

IPromptVersionProps