Class CfnPromptVersionPropsMixin.ChatPromptTemplateConfigurationProperty

Contains configurations to use a prompt in a conversational format.

Inheritance

object

CfnPromptVersionPropsMixin.ChatPromptTemplateConfigurationProperty

Implements

CfnPromptVersionPropsMixin.IChatPromptTemplateConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnPromptVersionPropsMixin.ChatPromptTemplateConfigurationProperty : CfnPromptVersionPropsMixin.IChatPromptTemplateConfigurationProperty

Syntax (vb)

Public Class CfnPromptVersionPropsMixin.ChatPromptTemplateConfigurationProperty Implements CfnPromptVersionPropsMixin.IChatPromptTemplateConfigurationProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins;

             var any;
             var auto;
             var json;

             var chatPromptTemplateConfigurationProperty = new ChatPromptTemplateConfigurationProperty {
                 InputVariables = new [] { new PromptInputVariableProperty {
                     Name = "name"
                 } },
                 Messages = new [] { new MessageProperty {
                     Content = new [] { new ContentBlockProperty {
                         CachePoint = new CachePointBlockProperty {
                             Type = "type"
                         },
                         Text = "text"
                     } },
                     Role = "role"
                 } },
                 System = new [] { new SystemContentBlockProperty {
                     CachePoint = new CachePointBlockProperty {
                         Type = "type"
                     },
                     Text = "text"
                 } },
                 ToolConfiguration = new ToolConfigurationProperty {
                     ToolChoice = new ToolChoiceProperty {
                         Any = any,
                         Auto = auto,
                         Tool = new SpecificToolChoiceProperty {
                             Name = "name"
                         }
                     },
                     Tools = new [] { new ToolProperty {
                         CachePoint = new CachePointBlockProperty {
                             Type = "type"
                         },
                         ToolSpec = new ToolSpecificationProperty {
                             Description = "description",
                             InputSchema = new ToolInputSchemaProperty {
                                 Json = json
                             },
                             Name = "name"
                         }
                     } }
                 }
             };

Synopsis

Constructors

ChatPromptTemplateConfigurationProperty()

Contains configurations to use a prompt in a conversational format.

Properties

InputVariables	An array of the variables in the prompt template.
Messages	Contains messages in the chat for the prompt.
System	Contains system prompts to provide context to the model or to describe how it should behave.
ToolConfiguration	Configuration information for the tools that the model can use when generating a response.

Constructors

ChatPromptTemplateConfigurationProperty()

Contains configurations to use a prompt in a conversational format.

public ChatPromptTemplateConfigurationProperty()

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins;

             var any;
             var auto;
             var json;

             var chatPromptTemplateConfigurationProperty = new ChatPromptTemplateConfigurationProperty {
                 InputVariables = new [] { new PromptInputVariableProperty {
                     Name = "name"
                 } },
                 Messages = new [] { new MessageProperty {
                     Content = new [] { new ContentBlockProperty {
                         CachePoint = new CachePointBlockProperty {
                             Type = "type"
                         },
                         Text = "text"
                     } },
                     Role = "role"
                 } },
                 System = new [] { new SystemContentBlockProperty {
                     CachePoint = new CachePointBlockProperty {
                         Type = "type"
                     },
                     Text = "text"
                 } },
                 ToolConfiguration = new ToolConfigurationProperty {
                     ToolChoice = new ToolChoiceProperty {
                         Any = any,
                         Auto = auto,
                         Tool = new SpecificToolChoiceProperty {
                             Name = "name"
                         }
                     },
                     Tools = new [] { new ToolProperty {
                         CachePoint = new CachePointBlockProperty {
                             Type = "type"
                         },
                         ToolSpec = new ToolSpecificationProperty {
                             Description = "description",
                             InputSchema = new ToolInputSchemaProperty {
                                 Json = json
                             },
                             Name = "name"
                         }
                     } }
                 }
             };

Properties

InputVariables

An array of the variables in the prompt template.

public object? InputVariables { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-promptversion-chatprompttemplateconfiguration.html#cfn-bedrock-promptversion-chatprompttemplateconfiguration-inputvariables

Type union: either IResolvable or (either IResolvable or CfnPromptVersionPropsMixin.IPromptInputVariableProperty)[]

Messages

Contains messages in the chat for the prompt.

public object? Messages { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnPromptVersionPropsMixin.IMessageProperty)[]

System

Contains system prompts to provide context to the model or to describe how it should behave.

public object? System { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnPromptVersionPropsMixin.ISystemContentBlockProperty)[]

ToolConfiguration

Configuration information for the tools that the model can use when generating a response.

public object? ToolConfiguration { get; set; }