interface PromptVariantProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnPromptPropsMixin.PromptVariantProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnPromptPropsMixin_PromptVariantProperty
Java	software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnPromptPropsMixin.PromptVariantProperty
Python	aws_cdk.mixins_preview.aws_bedrock.mixins.CfnPromptPropsMixin.PromptVariantProperty
TypeScript	@aws-cdk/mixins-preview » aws_bedrock » mixins » CfnPromptPropsMixin » PromptVariantProperty

Contains details about a variant of the prompt.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';

declare const additionalModelRequestFields: any;
declare const any: any;
declare const auto: any;
declare const json: any;
const promptVariantProperty: bedrock_mixins.CfnPromptPropsMixin.PromptVariantProperty = {
  additionalModelRequestFields: additionalModelRequestFields,
  genAiResource: {
    agent: {
      agentIdentifier: 'agentIdentifier',
    },
  },
  inferenceConfiguration: {
    text: {
      maxTokens: 123,
      stopSequences: ['stopSequences'],
      temperature: 123,
      topP: 123,
    },
  },
  metadata: [{
    key: 'key',
    value: 'value',
  }],
  modelId: 'modelId',
  name: 'name',
  templateConfiguration: {
    chat: {
      inputVariables: [{
        name: 'name',
      }],
      messages: [{
        content: [{
          cachePoint: {
            type: 'type',
          },
          text: 'text',
        }],
        role: 'role',
      }],
      system: [{
        cachePoint: {
          type: 'type',
        },
        text: 'text',
      }],
      toolConfiguration: {
        toolChoice: {
          any: any,
          auto: auto,
          tool: {
            name: 'name',
          },
        },
        tools: [{
          cachePoint: {
            type: 'type',
          },
          toolSpec: {
            description: 'description',
            inputSchema: {
              json: json,
            },
            name: 'name',
          },
        }],
      },
    },
    text: {
      cachePoint: {
        type: 'type',
      },
      inputVariables: [{
        name: 'name',
      }],
      text: 'text',
      textS3Location: {
        bucket: 'bucket',
        key: 'key',
        version: 'version',
      },
    },
  },
  templateType: 'templateType',
};

Properties

Name	Type	Description
additionalModelRequestFields?	any	Contains model-specific inference configurations that aren't in the inferenceConfiguration field.
genAiResource?	IResolvable | PromptGenAiResourceProperty	Specifies a generative AI resource with which to use the prompt.
inferenceConfiguration?	IResolvable | PromptInferenceConfigurationProperty	Contains inference configurations for the prompt variant.
metadata?	IResolvable | (IResolvable | PromptMetadataEntryProperty)[]	An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.
modelId?	string	The unique identifier of the model or inference profile with which to run inference on the prompt.
name?	string	The name of the prompt variant.
templateConfiguration?	IResolvable | PromptTemplateConfigurationProperty	Contains configurations for the prompt template.
templateType?	string	The type of prompt template to use.

---

additionalModelRequestFields?

Type: any (optional)

Contains model-specific inference configurations that aren't in the inferenceConfiguration field.

To see model-specific inference parameters, see Inference request parameters and response fields for foundation models .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-additionalmodelrequestfields

---

genAiResource?

Type: IResolvable | PromptGenAiResourceProperty (optional)

Specifies a generative AI resource with which to use the prompt.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-genairesource

---

inferenceConfiguration?

Type: IResolvable | PromptInferenceConfigurationProperty (optional)

Contains inference configurations for the prompt variant.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-inferenceconfiguration

---

metadata?

Type: IResolvable | (IResolvable | PromptMetadataEntryProperty)[] (optional)

An array of objects, each containing a key-value pair that defines a metadata tag and value to attach to a prompt variant.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-metadata

---

modelId?

Type: string (optional)

The unique identifier of the model or inference profile with which to run inference on the prompt.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-modelid

---

name?

Type: string (optional)

The name of the prompt variant.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-name

---

templateConfiguration?

Type: IResolvable | PromptTemplateConfigurationProperty (optional)

Contains configurations for the prompt template.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-templateconfiguration

---

templateType?

Type: string (optional)

The type of prompt template to use.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-prompt-promptvariant.html#cfn-bedrock-prompt-promptvariant-templatetype