@aws-cdk/aws-bedrock-alpha.CommonPromptVariantProps

Experimental

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

CommonPromptVariantProps Struct

Common properties for all prompt variants.

Stability

Experimental

Source

bedrock/prompts/prompt-variant.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_alpha from '@aws-cdk/aws-bedrock-alpha';

declare const bedrockInvokable: bedrock_alpha.IBedrockInvokable;
const commonPromptVariantProps: bedrock_alpha.CommonPromptVariantProps = {
  model: bedrockInvokable,
  variantName: 'variantName',

  // the properties below are optional
  promptVariables: ['promptVariables'],
};

Properties

modelIBedrockInvokablemodelIBedrockInvokablemodelIBedrockInvokableModelIBedrockInvokableModelIBedrockInvokablerequired#

The model which is used to run the prompt.

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

promptVariables?optionalstring[]prompt_variables?optionaltyping.List[str]promptVariables?optionalList<String>PromptVariables?optionalstring[]PromptVariables?optional*[]*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.