AWS CDK Reference

Appearance

v2.275.0

ChatPromptTemplateConfigurationProperty Struct ​

Contains configurations to use a prompt in a conversational format.

For more information, see Create a prompt using Prompt management .

Source
Generated code
Type last changed
v2.174.0 · 4 Jan 2025

Example ​

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

declare const any: any;
declare const auto: any;
declare const json: any;
const chatPromptTemplateConfigurationProperty: bedrock.CfnPrompt.ChatPromptTemplateConfigurationProperty = {
  messages: [{
    content: [{
      cachePoint: {
        type: 'type',
      },
      text: 'text',
    }],
    role: 'role',
  }],

  // the properties below are optional
  inputVariables: [{
    name: 'name',
  }],
  system: [{
    cachePoint: {
      type: 'type',
    },
    text: 'text',
  }],
  toolConfiguration: {
    tools: [{
      cachePoint: {
        type: 'type',
      },
      toolSpec: {
        inputSchema: {
          json: json,
        },
        name: 'name',

        // the properties below are optional
        description: 'description',
      },
    }],

    // the properties below are optional
    toolChoice: {
      any: any,
      auto: auto,
      tool: {
        name: 'name',
      },
    },
  },
};

Properties ​

inputVariablesoptionalIResolvable | IResolvable | CfnPrompt.PromptInputVariableProperty[]input_variablesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PromptInputVariableProperty]]]inputVariablesoptionalIResolvableInputVariablesoptionalIResolvableInputVariablesoptionalinterface{}#
An array of the variables in the prompt template.
messagesIResolvable | IResolvable | CfnPrompt.MessageProperty[]messagestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MessageProperty]]]messagesIResolvableMessagesIResolvableMessagesinterface{}required#
Contains messages in the chat for the prompt.
systemoptionalIResolvable | IResolvable | CfnPrompt.SystemContentBlockProperty[]systemoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SystemContentBlockProperty]]]systemoptionalIResolvableSystemoptionalIResolvableSystemoptionalinterface{}#
Contains system prompts to provide context to the model or to describe how it should behave.
toolConfigurationoptionalIResolvable | CfnPrompt.ToolConfigurationPropertytool_configurationoptionaltyping.Union[IResolvable, ToolConfigurationProperty]toolConfigurationoptionalIResolvableToolConfigurationoptionalIResolvableToolConfigurationoptionalinterface{}#
Configuration information for the tools that the model can use when generating a response.